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

200 The customer was found

{
    "result": "Success",
    "reference": "888888812",
    "status": "PASS",
    "target": {
        "fn": "John",
        "ln": "Smith",
        "addr": "123 Main St",
        "city": "Stratford",
        "state": "CT",
        "zip": "06614",
        "dob": "19700101",
        "email": "[email protected]",
        "phone": "2015106000"
        "documents": {
            "front": "base64 encoded string of image", 
            "back": "base64 encoded string of image"
        }
    }
}

400 The email was not a valid email address

{
    "result": "Error",
    "message": "The email address is invalid"
}

//or

{
    "result": "Error",
    "message": "Missing a required input"
}

401 Either a bad username or password

{
    "result": "Error",
    "message": "Either your username or password is incorrect"
}

404 The customer was not found

{
    "result": "Error",
    "message": "The email address was not found"
}

Sample Request Body

{
"user": "USERNAME",
"pass": "PASSWORD",
"service": "getDocumentImages",
"target": {
    "email": "[email protected]"
    }
}

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