Direct Link
Veratad's VX platform allows you to retrieve a direct link to a verification journey via the
generateLink method (API guide below). You can then send this link to a customer for verification and catch the webhook for results, but if you want to embed the link within your own application you will want to listen for messages related to the journey for frontend user handling. For example when you embed, you may want to be notified when the verification status updates or when the user clicks the close button to close the journey. The following outlines the post message body and values that you can access.
IMPORTANT: You should never rely on frontend post messages for results. Always use a server to server API method to get the result. You can do this either through the webhook or user status polling API methods.
Click here to integrate the
generateLink API method. 1
{
2
"status": "PASS | PENDING | FAIL",
3
"component": "KBA | DCAMS | PHONEMATCH | AGEMATCH | IDMATCH | INIT",
4
"error": "ERROR | VELOCITY | BAD TOKEN | ALREADY VERIFIED | PENDING",
5
"event": "REATTEMPT | NEXT | CLOSE | EMAIL | QR"
6
}
The status field will include the user's current verification status. This field will default to empty if the user has yet to complete at least one verification component.
Value | Definition |
|---|---|
PASS | The user's journey is complete and their verification status is success. |
PENDING | The user's journey is ongoing. They have completed at least one verification component, but there are more available or required in their current journey. |
FAIL | The user's journey is complete and their verification status is failure. |
The current component loaded in the user's journey.
Value | Definition |
|---|---|
KBA | Knowledge Based Authentication component |
DCAMS | Document verification component |
PHONEMATCH | Phone verification component |
AGEMATCH | Age verification component |
IDMATCH | Identity verification data match component |
INIT | No component loaded |
| |
The error value indicates a journey error described in the documentation. You will catch most of these errors during the generateLink API call, but should handle each in case of another during a journey.
Value | Definition |
|---|---|
ERROR | A general error occurred |
VELOCITY | The user has reached their verification limit for the defined period |
BAD TOKEN | An invalid token was supplied |
ALREADY VERIFIED | The user has a PASS status already |
PENDING | The user's document is currently pending a manual agent review and they cannot submit a new document |
A triggered event.
Value | Definition |
|---|---|
REATTEMPT | The user has selected to reattempt the current component |
NEXT | The user has selected to go to the next component |
CLOSE | The user has closed the application |
EMAIL | The user has requested an email link |
QR | The user has scanned the QR code and opened the session on a different device |
Last modified 1yr ago