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

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Response

200

{
    "current_status": "COMPLETED"
}

404

{
    "message": "NOT FOUND",
    "detail": "Session result not found, user did not start the process or your request_id is invalid."
}

500

{
    "message": "INTERNAL SERVER ERROR",
    "detail": "An unexpected error occurred while processing your request."
}

current_status values	Definition
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:

1. Webhook: The results will be automatically sent to the endpoint configured with the client_id.

2. 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:

{
  "fn": "John",
  "ln": "Doe",
  "addr": "123 Main St",
  "city": "New York",
  "state": "NY",
  "zip": "10001",
  "dob": "20000101",
  "email": "[email protected]",
  "phone": "555-1234",
  "reference": "Ref123",
  "status": "PASS",
  "request_id": "4ed2ec66-9471-415d-99ce-7bd1742fc2b8",
  "additionalData": {
    "verificationId": "170a03b7-001c-4f81-a7a8-af580468ddb8"
  },
  "dcams_plus": {
    "document_data": {
      "FirstName": "John",
      "LastName": "Doe",
      "MiddleName": "",
      "Address": "123 Main St",
      "City": "New York",
      "State": "NY",
      "Zip": "10001",
      "CountryCode": "US",
      "FullAddress": "123 Main St, New York, NY 10001",
      "DateOfBirth": "20000101",
      "Height": "6'0\"",
      "Sex": "M",
      "EyeColor": "Brown",
      "DocumentNumber": "<REDACTED>",
      "DocumentType": "DRIVERS LICENSE",
      "SourceDocumentType": "Driver Licence",
      "NationalID": "<REDACTED>",
      "IssueDate": "20200101",
      "ExpirationDate": "20300101"
    },
    "output": {
      "vpin": {}
    },
    "api_processing_error": false,
    "service": "DCAMSPLUS5.0.Enhanced.OCR",
    "confirmation": 180199072,
    "action": "PASS",
    "detail": "ALL CHECKS PASSED",
    "issues": []
  },
  "storage": {
    "success": true
  },
  "journey": {
    "stops": [
      {
        "timestamp": "2024-08-12 13:06:50.335771",
        "type": "NEW REGISTRATION",
        "source": "",
        "status": null,
        "action": "",
        "detail": ""
      },
      {
        "timestamp": "2024-08-12 13:08:15.694983",
        "type": "SDK_Scan",
        "source": "DCAMSPLUS5.0.Enhanced.OCR",
        "status": "PASS",
        "action": "PASS",
        "detail": "ALL CHECKS PASSED"
      }
    ],
    "duration": "00h 01m 25s"
  },
  "documents": null
}

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.