LogoLogo
  • API Documentation
  • Authentication
  • Testing
  • Contact Support
  • System Status
  • VX
    • API Methods
      • Create Session
      • Get Session Status
      • Get Session Result
      • Webhook
    • iFrame Integration
  • Agematch
    • United States
    • United States (DMV)
    • International
    • With KBA Quiz
    • Selfie Age Estimation
  • IDMATCH
    • United States
      • With KBA Escalation
      • KYC/CIP Compliance
      • COPPA Compliance
    • International
  • idmatch+
    • United States
  • IDMATCH+PREDICT
    • Fraud Score
  • phonematch
    • Verification and Validation
      • Smart 2FA
      • Phone Verification
      • Phone Validation
    • One Time Passwords
      • SMS
      • Call
    • Message Delivery
      • Dialer
  • emailmatch
    • Email Validation
  • dcams
    • Document Capture and Management Services
      • Scanning Basic
      • Scanning Enhanced
      • Manual Review
      • Storage
        • Create or Update a Customer
        • Get Customer Status
        • Get Customer Document Images
        • Update Customer Status
      • iFrame
        • Canned Responses
        • Create Token
        • View Callback
        • User Status
        • Generate Link
      • Swift SDK
      • Android SDK
  • Bouncer
    • Overview
    • Bouncer as an add-on
  • V-PIN
    • Overview
    • V-PIN as an add-on
    • V-PIN Stand Alone
  • Service Coverage
    • Data Coverage
  • Testing
    • Test Cases
    • Answers to KBA Questions
  • Reporting
    • Audit
  • API Processing Errors
    • Error Returns
  • Knowledge Base
    • Best Practices
    • Understanding Veratad Services
  • IDMax
    • IDMax Button Creator SDK
Powered by GitBook
On this page
  1. VX
  2. API Methods

Get 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

{
    "fn": "John",
    "ln": "Doe",
    "addr": "",
    "city": "",
    "state": "",
    "zip": "",
    "dob": "19900101",
    "email": "johndoe@example.com",
    "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
}
{
    "message": "IN PROGRESS",
    "detail": "Session result not found, but user started the process."
}
{
    "message": "NOT FOUND",
    "detail": "Session result not found, user did not start the process or your request_id is invalid."
}
{
    "message": "INTERNAL SERVER ERROR",
    "detail": "An unexpected error occurred while processing your request."
}
PreviousGet Session StatusNextWebhook

Last updated 12 days ago