Manual Review
Register a document with the Veratad Manual Review Team and then poll for the status.
Last updated
Register a document with the Veratad Manual Review Team and then poll for the status.
Last updated
The manual review service includes two requests:
Initial Request - make an HTTPS POST request with the below body parameters to register the document with the Veratad Manual Review Team. The response for this request will include polling instructions with a unique token for the request.
NOTE: The total payload of the initial request can not be greater than 10mb in size.
Polling Request - make an HTTPS POST request with the template returned from the initial request to find the user's final status. The majority of manual reviews will take 90 seconds to complete, but this is not guaranteed, so continue to poll until you receive the final status.
POST
https://docs.idresponse.com/process/comprehensive/gateway
This is the initial request.
user
string
Your account's API username
pass
string
Your account's API password
service
string
The service name (DCAMSPLUS5.0.Manual)
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)
license
object
The target's document images
front
string
The target's front document image
back
string
The target's back 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
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 provided) and these transactions are free of charge.
test_key
description
dcams_manual_review_completed
Returns a document output when sending template
to process/continue
dcams_manual_review_processing
Will only return a processing
state when sending template
to process/continue
dcams_manual_review_error
Will return an error
state and FAIL
when sending template
to process/continue
The following are all values that will be returned in the result object of the initial response.
Action
Detail
Description
PENDING
MORE INFORMATION IS REQUIRED
The document was accepted and is currently going through manual review process.
FAIL
SERVICE CANNOT BE COMPLETED
There was an issue with the submitted document and it cannot go through the manual review process.
On the initial request the status will always be PROCESSING or ERROR. You will only see COMPLETED during a polling request.
status
description
COMPLETED
The manual review is complete
PROCESSING
The manual review is processing
ERROR
The manual review resulted in error
POST
https://docs.idresponse.com/process/continue
This is the polling request.
user
string
Your Veratad API username
pass
string
Your Veratad API password
polled
object
The polled object that was returned in the template of the initial response
status
string
The status returned in the template of the initial response
test_key
string
The test_key that you want to use during the polling request.
expiry
string
The expiry returned in the template of the initial response
token
string
The token returned in the template of the initial response.
test_key
description
dcams_manual_review_pass
When submitted the polling action will be PASS
dcams_manual_review_fail_expired
When submitted the polling action will be FAIL and detail will be DOCUMENT IS EXPIRED
dcams_manual_review_fail_age
When submitted the polling action will be FAIL and detail will be DOCUMENT AGE CHECK FAILED
dcams_manual_review_fail_not_valid
When submitted the polling action will be FAIL and detail will be NOT A VALID DOCUMENT
dcams_manual_review_fail_not_verified
When submitted the polling action will be FAIL and detail will be DOCUMENT NOT VERIFIED
If you are using one of the additional rule sets and want to get a REVIEW then just send the dcams_manual_review_pass
key and change one of the target attributes to something that does not match the test case returned.
action
detail
description
FAIL
NOT A VALID DOCUMENT
The document is not valid or visible or is cut off
FAIL
DOCUMENT IS EXPIRED
The expiration date on the document is in the past
FAIL
DOCUMENT NOT VERIFIED
The document is not verified
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
DCAMSPLUS5.0.Manual will process with the default base ruleset unless a 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 it 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_Manual_Review_RuleSet_NAME_DOB
Base Ruleset + Name and DOB on target must match the document
DCAMS5_0_Manual_Review_RuleSet_NAME
Base Ruleset + Name on target must match the document