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.
{"output": {"input": {"DriversLicense":"{}","FirstName":"John","LastName":"Smith","Age":"21+","DateOfBirth":"19870621","TestKey":"dcams_manual_review_completed" },"documents": [] },"meta": {"confirmation":95742258,"reference":"12345","service":"DCAMSPLUS5.0.Manual","timestamp":"2020-07-02 10:29:33","company":"Company ABC, Inc.","user":"user@company.com" },"result": {"action":"PENDING","detail":"MORE INFORMATION IS REQUIRED","issues": [] },"continuations": {"polling": {"url":"\/process\/continue","template": {"polled": { "status": "PROCESSING", // on initial request the status will either be PROCESSING when the action is PENDING or ERROR when the action is FAIL
"test_key":"","expiry":"2020-07-03 10:29:35" },"token":"37a0dvjedoyiovnwyhixf49cxm9a45la" },"instructions":"Please submit template at 2.0 second intervals until polling is complete." } }}
Sample Initial Request Body
{"user": "user@company.com","pass": "PASSWORD","service": "DCAMSPLUS5.0.Manual","reference": "12345","rules": "additional matching rules","target": {"license": { // this object will accept any identity document i.e. driving license, identity card or passport."front":"base64 encoded image file","back":"base64 encoded image file" },"age":"21+","fn":"John","ln":"Smith","dob":"19870621","test_key":"dcams_manual_review_completed" }}
Test Key Initial Submission Scenarios
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.
Action and Detail Responses For the Initial Request
The following are all values that will be returned in the result object of the initial response.
Possible Status Responses
On the initial request the status will always be PROCESSING or ERROR. You will only see COMPLETED during a polling request.
DCAMSPLUS5.0.Manual (Polling Request)
POSThttps://docs.idresponse.com/process/continue
This is the polling request.
Request Body
{ "final": { // this object should be ignored. Please continue to send poll requests to the above URL in the same fashion as the first request until you get a completed result.
"template": {"token":"37a0dvjedoyiovnwyhixf49cxm9a45la" },"url": "\/process\/status" },"meta": {"company":"Company ABC, Inc.","confirmation":95743502,"reference":"12345","service":"DCAMSPLUS5.0.Manual","timestamp":"2020-07-02 10:39:37","user":"user@company.com" },"output": {"documents": { //this is the test case data in the DB. "Address":"109 S FOSTER RD","City":"BATON ROUGE","Confidence":100,"DateOfBirth":"19720629","DocumentNumber":"003009381","ExpirationDate":"20300329","FirstName":"LOUISA ANNA","IssueDate":"20140714","LastName":"SAMPLE","MiddleName":"","State":"LA","Zip":"70806-0000","CountryCode":"USA",// (ISO Alpha 2 or 3)"DocumentType":"DRIVERS LICENSE"// other values are PASSPORT, IDENTITY CARD and UNKNOWN },"input": {"Age":"21+","DateOfBirth":"19870621","DriversLicense":"{}","FirstName":"John","LastName":"Smith","TestKey":"dcams_manual_review_completed" },"polled": {"instructions":"Poll request has completed.","status":"COMPLETED" } },"result": {"action":"REVIEW","detail":"TRANSACTION REQUIRES FURTHER ATTENTION", "issues": ["LAST NAME DOES NOT MATCH DOCUMENT", "DOB DOES NOT MATCH DOCUMENT", "FIRST NAME DOES NOT MATCH DOCUMENT"]
}}
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 and Detail Responses for the Polling Request
Issues Responses for the Polling Request
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.
Rules
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
