Identity verification integration flow
We show you how to integrate the identity verification flow into your application.
- You need a custom integration and its Access Key at hand, see Creating an Access Key.
- Provide the URL of your portal, where the users are redirected when they finish the identity verification, that is, a redirect URL. If you did not specify the redirect URL when ordering Authentication Cloud identity verification, create a ticket on the Nevis Portal.
Start the identity verification session
Start the identity verification session in Authentication Cloud by sending a POST request to the
idverification/sessions endpoint as described in Start identity verification session.
You get a
sessionId, which is a unique nine-digit identifier of the identity verification session. We recommend you store the returned
sessionId and link it to the user, so that you can retrieve the verification data for that user later.
Verify the identity of the user
Navigate the user to
startUrl you get back in the previous step, which looks like this:
The user is then asked for consent and guided through the verification process. The verification process takes up to a few minutes.
From a technical perspective, the identity verification is done in a separate web application. Your portal redirects the users, and the users finish the process there.
Users who start the verification in a desktop application are first directed to their mobile device by scanning a QR code with their camera application.
Once the user finished the identity verification process, they are redirected to the redirect URL of your portal.
Get verification information
During or after the process, you can request the current status of the process by sending a GET request to the
- If the verification process is either in
in_progressstate, the endpoint returns only the current status of the verification.
verifiedstatus means that the process is finished, and in this case the response contains the detailed result and data of the verification, see Get identity verification information and Identity verification error codes.
idverification/sessions endpoint may still return the status
pending at this point, if the user exited without starting the actual identity verification process.
Another case when the redirect does not happen, is if the user does not continue with the process, or lets the session time out.
The following illustration shows the lifecycle of the identity verification session:
Was this page helpful?