Get Session Status
Get VX Session Status
GET /api/session/result/:request_id
This endpoint retrieves the current status of a journey associated with a specific request_id
. The status provides insight into where the session is in the verification process, such as whether it has been started, is in progress, or has been completed.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Response
INIT
The user has landed in the session, but has not particpated in at least one verification app.
COMPLETED
The journey is complete.
IN PROGRESS
The user has completed aat least one verification app, but is not done with the journey.
PENDING
The user's ID document is under manual review
Get Session Status
After a verification session is completed, you can retrieve the results in one of two ways:
Webhook: The results will be automatically sent to the endpoint configured with the
client_id
.Polling: You can make a polling request using either the
request_id
from the session creation or the user's email address.
Request Body Example (Webhook or Polling)
The request body structure for both the webhook and polling methods is the same:
Explanation of the Response
status: Indicates whether the verification passed, failed, or is pending.
request_id: The ID of the verification session.
email: The user's email associated with the verification session.
additionalData: Contains the
verificationId
used internally.dcams_plus: Contains detailed document verification data. This section is only available when using a DCAMS document verification service or an IDMax reusable ID service. The data within this object is anonymized and redacted as necessary.
journey: Provides a log of all the steps and their statuses during the verification process.
storage: Indicates whether the data was successfully stored.
This section should help you retrieve and interpret the results of a verification session, whether through a webhook or by polling the server with a request ID or email address.
Last updated