Quick start

The shortest path from registration to your first verification result. Details for each step are behind the links.

1. Register

Create an account in the personal account. Registration requires an invitation code. Details: Registration and login.

2. Get an API key and allow your domains

In the «Access» section:

  • «API keys» tab: add a new access token. You need the token to call the REST API;
  • «Allowed domains» tab: add the domains of the site where the widget will run. The widget works only on domains from this list and only over HTTPS; you can use a mask such as *.example.com. Changes take effect within 2 minutes.

Details: Access Tokens.

3. Create a verification scenario

«KYC/AML» section → «KYC Editor» → create a scenario (from scratch or from a template). Add the verification steps and save the scenario. The «Main settings» tab shows the scenario ID and the secret key: you will need them in the next step.

Details: KYC/AML in the personal account.

4. Start a verification

Option A: widget (Web SDK)

Load the widget script and call setupKYC, for example on a button click:

<script src="https://kyc.neuro-vision.ru/lib/widget-lib.js"></script>
<script>
  function startKyc() {
    window.KYCWidget.setupKYC({
      scenarioId: "<scenarioId>",
      clientKey: "<clientKey>",
      successCb: (sessionJson) => console.log("success", sessionJson),
      closeCb: () => console.log("closed"),
    });
  }
</script>
  • <scenarioId> is the scenario ID from step 3.
  • <clientKey> is your user identifier, encrypted on your server with the scenario secret key. How to build it: Working with clientKey.

successCb is called only when the verification succeeds. There is no client callback for a rejection, so get the outcome from the server (step 5).

All parameters and integration options (React, the kyc-widget-nv npm package): Connection.

Option B: REST API

If you capture the images yourself, without the widget:

  1. Create a session: kyc/session/create.
  2. Send the document and selfie images: kyc/process.

All methods use POST. How to get a token and pass it in a request: Authentication.

5. Get the result

Two ways, which you can combine:

  • Webhook. Set your handler address in the scenario: «Callback settings» tab → «Backend callback URL». The platform sends a POST request when the session changes. Notification format and settings: Webhooks.
  • Status request. Call kyc/session/status with the session ID or the clientKey.

Status values are described on the Session statuses page. Decide on the customer by the server status, not by widget callbacks.

Next

Before going live, test your integration on a test scenario: Integration testing.

If the verification is embedded in a mobile app: Mobile apps and WebView.