API and integration

Two REST API methods run checks on an individual using the data provided and return the result. A KYC session and document upload are not required.

The base address is https://api.neuro-vision.ru/v1. All requests are POST with an application/json body, and all responses are JSON.

MethodPurpose
POST kyc/checks/runRuns checks and immediately returns a runId
POST kyc/checks/resultReturns the results of a run by runId

The methods are asynchronous: the run response contains no result. Querying external registries takes time, so a run takes minutes. The client retrieves the result by polling kyc/checks/result every 5–10 seconds until checksStatus becomes complete.


Authorization

A permanent access token is passed in the token field of the request body. If a temporary token is used, it is passed in the token header, and then the body field is not needed. A request without a token receives 401 and {"status": "error", "message": "access denied"}.


Checks against an existing KYC session

If checks are run against a KYC session, they are started with the POST kyc/session/databases method, and the result arrives via the DATABASE_CHECKS_COMPLETE webhook. The format of the results[] element is the same, so result parsing is shared across both surfaces.


Billing

Each check run is billed. A check that returns skipped did not reach the source and is not billed.