API Methods

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 VX Session Result

GET /api/session/result/:request_id

This endpoint retrieves the session result associated with a specific request_id. The session result contains detailed information about the verification process for a user, including personal details, status, and additional metadata.

Headers

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

Response

200

{
    "fn": "John",
    "ln": "Doe",
    "addr": "",
    "city": "",
    "state": "",
    "zip": "",
    "dob": "19900101",
    "email": "[e-mail]",
    "phone": "123-456-7890",
    "reference": "",
    "status": "PASS",
    "request_id": "19fe3b9e-384e-41d1-bded-8de9ef3abacb",
    "additionalData": [],
    "dcams_plus": {
        "document_data": {},
        "output": {
            "vpin": {}
        },
        "api_processing_error": false,
        "service": "PhoneMatch5.0.Smart2FA.SMS",
        "confirmation": 180603431,
        "action": "PASS",
        "detail": "ALL CHECKS PASSED",
        "issues": [
            "OUT-OF-BAND SUCCESSFUL"
        ]
    },
    "storage": {
        "success": null
    },
    "journey": {
        "stops": [
            {
                "timestamp": "2024-08-19 20:56:25.223174",
                "type": "NEW REGISTRATION",
                "source": "",
                "status": "",
                "action": "",
                "detail": ""
            },
            {
                "timestamp": "2024-08-19 20:56:41.280685",
                "type": "Data Service",
                "source": "PhoneMatch5.0.Smart2FA.SMS",
                "status": "PENDING",
                "action": "PENDING",
                "detail": "MORE INFORMATION IS REQUIRED"
            },
            {
                "timestamp": "2024-08-19 20:56:57.448256",
                "type": "Data Service",
                "source": "PhoneMatch5.0.Smart2FA.SMS",
                "status": "PASS",
                "action": "PASS",
                "detail": "ALL CHECKS PASSED"
            }
        ],
        "duration": "00h 00m 32s"
    },
    "documents": null
}

202

{
    "message": "IN PROGRESS",
    "detail": "Session result not found, but user started the process."
}

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."
}