Scanning Basic
Instantly scan an identity document for validation purposes. You can also match your customer to the document and have the document details returned to your application.
Please see the table below for a list of features to decide which option fits your business best.
Feature | basic | enhanced |
Data Extraction | yes | yes |
Expiration Check | yes | yes |
Age Check | yes | yes |
Target Data Matching | yes | yes |
Automatically Recognizes Document Type | no | yes |
Automatically Recognizes Document Region | no | yes |
Enhanced Security Checks | no | yes |
Selfie Matching | no | yes |
Expanded International Coverage | no | yes |
post
https://docs.idresponse.com
/process/comprehensive/gateway
DCAMSPLUS5.0
{
"user": "[email protected]",
"pass": "PASSWORD",
"service": "DCAMSPLUS5.0",
"reference": "12345",
"rules": "additional matching rules",
"target": {
"license": { // this object will accept any identity document except a passport i.e. driving license or identity card.
"front": "base64 encoded image file",
"back": "base64 encoded image file",
"state": "CT",
"region": "United States"
},
"passport":{
"front": "base64 encoded image file"
},
"age": "21+",
"fn": "John",
"ln": "Smith",
"dob": "19870621",
"test_key": "dcams_pass"
}
}
If you send both the
license
and passport
objects the system will prefer the license
and ignore the passport.
If you want to verify a passport please remove the license
object and only send the passport
object.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_pass | Will return a PASS action result |
dcams_fail_expired | Will return a FAIL action result |
If you are using one of the matching rule sets and want to force a REVIEW then use the
dcams_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.The following are all values that will be returned in the result object of the response.
action | detail | description |
FAIL | NOT A VALID DOCUMENT | We can not detect the image as a valid identity document |
FAIL | DOCUMENT NOT VERIFIED | We have detected an identity document, but the confidence level is below the threshold |
FAIL | DOCUMENT IS EXPIRED | The document's expiration date is in the past |
FAIL | DOCUMENT AGE CHECK FAILED | The Date of Birth on the document does not meet the minimum age requirement |
REVIEW | TRANSACTION REQUIRES FURTHER ATTENTION | One of the matching rules was not met (this only happens when using an additional rule set) |
PASS | ALL CHECKS PASSED | The document is valid, is not expired, the Date of Birth meets the minimum age requirement and additional matching rules all passed. |
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 |
DCAMSPLUS5.0 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 is valid
- 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
You can set a new rule set.
Rule Set Name | Description |
DCAMS5_0_RuleSet_NAME_DOB | Base Ruleset + Name and DOB on target must match the document |
DCAMS5_0_RuleSet_NAME | Base Ruleset + Name on target must match the document |
DCAMS5_0_RuleSet_NAME_ADDR | Base Ruleset + Name and Address on target must match the document |
DCAMS5_0_RuleSet_NAME_STATE | Base Ruleset + Name and State on target must match the document |
DCAMS5_0_RuleSet_NAME_STATE_DOB | Base Ruleset + Name, State and Date of Birth on target must match the document |
DCAMS5_0_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.
- 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
Last modified 1yr ago