Veratad's VX platform allows you to retrieve a direct link to a verification journey via the
generateLinkmethod (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
"status": "PASS | PENDING | FAIL",
"component": "KBA | DCAMS | PHONEMATCH | AGEMATCH | IDMATCH | INIT",
"error": "ERROR | VELOCITY | BAD TOKEN | ALREADY VERIFIED | PENDING",
"event": "REATTEMPT | NEXT | CLOSE | EMAIL | QR"
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.
The current component loaded in the user's journey.
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.
A triggered event.