Docs
Everything a product needs to verify its customers: an API for your server, a widget for your signup page, and signed webhooks for the decision.
- API referenceCreate verification sessions from your server, read what the checks found, and receive the decision by signed webhook.
- The widgetShow the code your customer scans on your signup page, and follow their verification as it happens.
From start to end
- Your server creates a session and says what it needs from the customer. It gets back a link, a QR code of the link, and a client secret for the widget.
- Your signup page shows the code, with the widget or on its own. You can also send the link by message.
- The customer opens the link on their phone, gives consent, and does each step with the camera.
- When everything is sent, the checks run. Your server is told by webhook:
session.approved,session.rejectedorsession.needs_review. - Your server reads the session for the details: what was read from the documents, what each check found, and how long each part took.
The three addresses
| Address | What it is for |
|---|---|
https://api.verificate.io | The API, the widget's script and the widget's progress. Your server and your signup page talk to it. |
https://verificate.me | The capture page, which your customers' phones open. Links look likehttps://verificate.me/v#…, and the part after # is never sent to a server. |
https://desk.verificate.io | The review desk, where your reviewers sign in with Google or Microsoft. |
Test mode
Keys that start with vk_test_ create test sessions. They take the same steps and send the same events, and a mock decides them without looking at anything. Choose the outcome in the session's metadata: approved, rejected,needs_review, or retry for a first step that fails once and then passes. See Test mode in the API reference.
Getting keys
Keys are made at the review desk, by an administrator of your company's account, and each is shown once. Keep them on your server. To get an account and test keys,write to us.