Scanning Enhanced

Instantly scan an identity document for verification purposes.

What is the difference between basic and enhanced?

Veratad offers two levels of document scanning service basic and enhanced. Please see the table below for a list of features to decide which service level fits your business best.

Feature

basic

enhanced

Data Extraction

yes

Expiration Check

yes

Age Check

yes

Target Data Matching

yes

Automatically Recognizes Document Type

yes

Automatically Recognizes Document Region

yes

Enhanced Security Checks

yes

Selfie Matching

yes

Expanded International Coverage

yes

DCAMSPLUS5.0.Enhanced

POST https://docs.idresponse.com/process/comprehensive/gateway

Send a POST request with target parameters along with the document image(s) to receive the verification result.

Request Body

Name	Type	Description
user*	string	Your account's API username
pass*	string	Your account's API password
service*	string	The service name DCAMSPLUS5.0.Enhanced or DCAMSPLUS5.0.Enhanced.Selfie
rules	string	The rule set name (if left empty then the base rule set will be used)
reference	string	A unique identifier for your customer
target*	object	The individual being sent for verification
fn	string	The target's first name
ln	object	The target's last name
addr	string	The target's street address (line 1 and line 2)
city	string	the target's city
state	string	The target's state
zip	string	The target's zip
dob	string	The target's Date of Birth (YYYYMMDD format)
document*	object	The target's document image which contains the front attribute
front*	string	The target's front document image
age*	string	The age to check (must be sent like "age+" i.e. "18+", "21+" etc.)
test_key	string	The test key value that you are using to test
back	String	The target's back document image
selfie	String	The target's captured selfie for matching. You must use the "Selfie" service name for service to attempt a match.

Name

Type

Description

user*

string

Your account's API username

pass*

string

Your account's API password

service*

string

The service name DCAMSPLUS5.0.Enhanced or DCAMSPLUS5.0.Enhanced.Selfie

rules

string

The rule set name (if left empty then the base rule set will be used)

reference

string

A unique identifier for your customer

target*

object

The individual being sent for verification

string

The target's first name

object

The target's last name

addr

string

The target's street address (line 1 and line 2)

city

string

the target's city

state

string

The target's state

zip

string

The target's zip

dob

string

The target's Date of Birth (YYYYMMDD format)

document*

object

The target's document image which contains the front attribute

front*

string

The target's front document image

age*

string

The age to check (must be sent like "age+" i.e. "18+", "21+" etc.)

test_key

string

The test key value that you are using to test

back

String

The target's back document image

selfie

String

The target's captured selfie for matching. You must use the "Selfie" service name for service to attempt a match.

{
    "output": {
        "documents": {
            "FirstName": "LOUISA",
            "LastName": "SAMPLE",
            "MiddleName": "ANNA",
            "FullAddress": "109 S FOSTER RD, BATON ROUGE, LA, 70808-0000",
            "Address": "109 S FOSTER RD",
            "City": "BATON ROUGE",
            "State": "LA",
            "Zip": "70808-0000",
            "DateOfBirth": "19720629",
            "Height": "5-08",
            "Sex": "F",
            "EyeColor": "BRN",
            "DocumentNumber": "003009381",
            "IssueDate": "20140714",
            "ExpirationDate": "20300629",
            "CountryCode": "USA", // (ISO Alpha 2 or 3)
            "DocumentType": "DRIVERS LICENSE" // other values are PASSPORT, IDENTITY CARD and UNKNOWN
        }
    },
    "meta": {
        "confirmation": 97147321,
        "reference": "12345",
        "service": "DCAMSPLUS5.0.Enhanced",
        "timestamp": "2020-07-27 13:11:55",
        "company": "Company ABC, INC",
        "user": "user@company.com"
    },
    "result": {
        "action": "PASS",
        "detail": "ALL CHECKS PASSED",
        "issues": []
    }
}

Sample Request Body

{
  "user": "user@company.com",
  "pass": "PASSWORD",
  "service": "DCAMSPLUS5.0.Enhanced",
  "reference": "12345",
  "rules": "DCAMS5_0_Enhanced_RuleSet_NAME_DOB",
  "target": {
    "document": { // this object will accept any identity document i.e. driving license, identity card or passport.
      "front": "base64 encoded image ",
      "back": "base64 encoded image" // the back is an optional field
      "selfie": "base64 encoded image" // only when using DCAMSPLUS5.0.Enahcned.Selfie as the service
    },
    "age": "21+",
    "fn": "John",
    "ln": "Smith",
    "dob": "19870621",
    "test_key": "dcams_enhanced_pass"
  }
}

Action and Detail Responses

The following are all values that will be returned in the result object of the initial response.

action

detail

description

FAIL

SERVICE CANNOT BE COMPLETED

There was some type of processing error. Please resubmit this query again

FAIL

NOT A VALID DOCUMENT

Can not detect the image as a valid identity document

FAIL

DOCUMENT NOT VERIFIED

The image had been detected as an identity document, but authentication checks have failed.

FAIL

DOCUMENT IS EXPIRED

The document's expiration date is in the past

FAIL

DOCUMENT AGE CHECK FAILED

The document's Date of Birth does not meet the minimum age requirement

FAIL

SELFIE MATCH FAILED

The selfie provided did not match the face on the ID document

REVIEW

TRANSACTION REQUIRES FURTHER ATTENTION

One of the matching rules was not met (this only happens when using an additional rule set). See issues below for all values possible.

PASS

ALL CHECKS PASSED

The document is valid and verified, is not expired, the Date of Birth meets the minimum age requirement and additional matching rules all passed. Also, this transaction does not require any further images to be provided.

Issues Responses

When a transaction returns as REVIEW then there will be a list of issues. This list can include any of the below values. For this service the REVIEW action will only return if you are not using the base rule set.

Issue

Description

FIRST NAME DOES NOT MATCH THE DOCUMENT

The target's first name does not match the first name discovered on the document

LAST NAME DOES NOT MATCH THE DOCUMENT

The target's last name does not match the last name discovered on the document

DOB DOES NOT MATCH THE DOCUMENT

The target's DOB does not match the DOB discovered on the document

ADDRESS DOES NOT MATCH THE DOCUMENT

The target's address does not match the address discovered on the document

STATE DOES NOT MATCH THE DOCUMENT

The target's state does not match the state discovered on the document

Base Rule Set

DCAMSPLUS5.0.Enhanced will process with the default base ruleset unless a below rule set value is supplied:

The base ruleset will return a PASS when:

The document has passed all verification checks
The document is not expired
The Date of Birth on the document meets the age requirement

The base ruleset will return a REVIEW when:

The base rule set is not used
One or more of the target attributes do not match the document.

The base ruleset will return a FAIL when:

The document is not valid
The document is expired
The Date of Birth on the document does not meet the age requirement
The service could not be completed

Additional Rule Sets

You can set a new rule set.

Rule Set Name

Description

DCAMS5_0_Enhanced_RuleSet_NAME_DOB

Base Ruleset + Name and DOB on target must match the document

DCAMS5_0_Enhanced_RuleSet_NAME

Base Ruleset + Name on target must match the document

DCAMS5_0_Enhanced_RuleSet_NAME_ADDR

Base Ruleset + Name and Address on target must match the document

DCAMS5_0_Enhanced_RuleSet_NAME_STATE

Base Ruleset + Name and State on target must match the document

DCAMS5_0_Enhanced_RuleSet_NAME_STATE_DOB

Base Ruleset + Name, State and Date of Birth on target must match the document

DCAMS5_0_Enhanced_RuleSet_NAME_ADDR_DOB

Base Ruleset + Name, Address and Date of Birth on target must match the document

If you do not see a rule set that you would like to use -- please just ask. We can always create a new rule set for your business purpose.

Test Keys

Use the test_key attribute to test the service. When the test_key is provided the system will return a known canned response (regardless of the image submitted) and these transactions are free of charge.

test_key

description

dcams_enhanced_pass

Will return a PASS action result

dcams_enhanced_fail_age

Will return a FAIL action result with a DOCUMENT AGE CHECK FAILED detail on the initial query

dcams_enhanced_fail_not_valid

Will return a FAIL action result with a DOCUMENT NOT VALID detail on the initial query

dcams_enhanced_fail_expired

Will return a FAIL action result with a DCOUMENT IS EXPIRED detail on the initial query

dcams_enhanced_fail_not_verified

Will return a FAIL action result with a DOCUMENT NOT VERIFIED detail

dcams_enhanced_facematched

Should be used with the selfie query to get a face match success response. Use any failure key above to get the fail response.

If you are using one of the matching rule sets and want to force a REVIEW then use the dcams_enhanced_pass case and change the input target attributes to something other than the target returned.

For example, the test case's first name is LOUISA, so to get a FIRST NAME DOES NOT MATCH THE DOCUMENT issue just change the target's first name to something other than LOUISA.

Helpful Information

The total payload may not exceed 10 MB in size.
The minimum image size is 400 pixels on each side of the document
For the best results ensure:
- The image is not blurry
- There is no glare
- The document takes up at least 80% of the image
- The edges are not cut off
- The document is on a flat surface

PreviousScanning Basic NextManual Review

Last updated 1 year ago