LogoLogo
  • API Documentation
  • Authentication
  • Testing
  • Contact Support
  • System Status
  • VX
    • Create Session
    • API Methods
  • 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

User Status

This method allows you to fetch the user's status.

Retrieve User Status

POST https://vx-be.idresponse.com/user/status

This endpoint allows you to get the status of the user.

Request Body

Name
Type
Description

user

string

Veratad API Username

pass

string

Veratad API Password

email

string

The user's email address

{
    "fn": "TIM",
    "ln": "SMITH",
    "addr": "123 MAIN ST",
    "city": "STRATFORD",
    "state": "CT",
    "zip": "06614",
    "dob": "19870203",
    "email": "test15847@veratad.com",
    "reference": "12344",
    "status": "PENDING",
    "additionalData": {
        "value_1": "rangers",
        "value_2": "test2"
    },
    "dcams_plus": {
        "document_data": {
            "FirstName": "STEVE",
            "LastName": "JONES",
            "MiddleName": "JIM",
            "Address": "123 MAIN ST",
            "City": "STRATFORD",
            "State": "CT",
            "Zip": "06614",
            "DateOfBirth": "19630203",
            "Height": "5-03",
            "Sex": "M",
            "EyeColor": "BRO",
            "DocumentNumber": "D485995948833",
            "IssueDate": "20190812",
            "ExpirationDate": "20230203"
        },
        "confirmation": 93239228,
        "action": "PENDING",
        "detail": "MORE INFORMATION IS REQUIRED",
        "issues": [
            "LAST NAME DOES NOT MATCH DOCUMENT",
            "DOB DOES NOT MATCH DOCUMENT",
            "FIRST NAME DOES NOT MATCH DOCUMENT"
        ]
    },
    "documents": null,
    "found": true
}
{
    "result": "Error",
    "message": "Missing a required input"
}
{
    "result": "Error",
    "message": "Either your username or password is incorrect",
}
{
    "fn": null,
    "ln": null,
    "addr": null,
    "city": null,
    "state": null,
    "zip": null,
    "dob": null,
    "email": null,
    "reference": null,
    "status": null,
    "additionalData": false,
    "dcams_plus": {
        "document_data": false,
        "confirmation": 0,
        "action": null,
        "detail": null,
        "issues": false
    },
    "documents": null,
    "found": false
}

Request Body

{
	"user": "USERNAME",
	"pass": "PASSWORD", 
	"email": "test15847@veratad.com"
}

NOTE: After 2 hours certain elements will be purged. This includes:

  • fn

  • ln

  • addr

  • city

  • state

  • zio

  • dob

  • dcams_plus.document_data

This does not apply if you have storage active.

Last updated 2 years ago