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
  • getDocumentImages
  • Sample Request Body
  • Response Fields
  1. dcams
  2. Document Capture and Management Services
  3. Storage

Get Customer Document Images

Once a customer is registered with the document storage system you can get their status and other details stored in the system including their document images by making this API call.

getDocumentImages

POST https://dcams.app/v3/stable/api/storage

This endpoint allows you to get the status of a customer account already registered in the system including their document images.

Request Body

Name
Type
Description

user

string

Your Veratad API Username

pass

string

Your Veratad API Password

service

string

The service name "getDocumentImages"

target

object

The target of the query

email

string

The user's email address for status lookup

{
    "result": "Success",
    "reference": "888888812",
    "status": "PASS",
    "target": {
        "fn": "John",
        "ln": "Smith",
        "addr": "123 Main St",
        "city": "Stratford",
        "state": "CT",
        "zip": "06614",
        "dob": "19700101",
        "email": "test@veratad.com",
        "phone": "2015106000"
        "documents": {
            "front": "base64 encoded string of image", 
            "back": "base64 encoded string of image"
        }
    }
}
{
    "result": "Error",
    "message": "The email address is invalid"
}

//or

{
    "result": "Error",
    "message": "Missing a required input"
}
{
    "result": "Error",
    "message": "Either your username or password is incorrect"
}
{
    "result": "Error",
    "message": "The email address was not found"
}

Sample Request Body

{
"user": "USERNAME",
"pass": "PASSWORD",
"service": "getDocumentImages",
"target": {
    "email": "test@veratad.com"
    }
}

Response Fields

The response will include all of the target attributes stored within the system for this user, including their document images, and the following varying fields.

attribute

values

result

Success

Error

status

PASS

PENDING

FAIL

PreviousGet Customer StatusNextUpdate Customer Status

Last updated 4 years ago