Comment on page
International
Identity verification via trusted and verified data sources in countries outside of the United States.
Click this link to see what countries are covered for the IDMatch International Service.
post
https://production.idresponse.com
/process/comprehensive/gateway
IDMatch5.0.{CountryName}
When setting the service name you must view the data coverage section (linked above) and use the country name for your query. Therefore, in the majority of cases the service name will be something like:
IDMatch5.0.Canada
But in certain cases where a country name has spaces i.e. the United Kingdom the service name will be like:
IDMatch5.0.UK
You will find all of the countries where there is an exception in the data coverage section of the documentation.
{
"user": "[email protected]",
"pass": "PASSWORD",
"service": "IDMatch5.0.{CountryName}",
"reference": "12345",
"target":{
"fn":"Barbara",
"ln": "Miller",
"addr1": "123 Main St",
"addr2": "TORONTO",
"addr3": "ON",
"zip": "M4B 1B3",
"dob": "19740821",
"international_id": "854125698",
"phone": "2015106000",
"age": "21+",
"test_key": "international_pass"
}
}
The following are all values that will be returned in the result object of the response.
Action | Detail | Description |
FAIL | NO MATCH | No matching identity found in the data sources |
FAIL | SERVICE CANNOT BE COMPLETED | The underlying data sources are having a processing issue. Resubmit this query at a later time |
REVIEW | TRANSACTION REQUIRES FURTHER ATTENTION | The service was completed and a match was found, but not all of the identity attributes matched. See the issues array for the elements that did not match. |
PASS | ALL CHECKS PASSED | The service was complete, the target was found and all identity attributes provided matched. |
When a transaction returns as REVIEW then there will be a list of issues. This list can include any of the below values.
Issue | Description |
ADDRESS CHECK FAILED | The address provided does not match any on file |
DATE OF BIRTH CHECK FAILED | The Date of Birth provided does not match any on file |
INTERNATIONAL ID CHECK FAILED | The SSN provided does not match any on file |
PHONE CHECK FAILED | The phone number provided does not match any on file |
EMAIL CHECK FAILED | The email address provided does not match any on file |
AGE CHECK FAILED | The target does not meet the age attribute provided |
POSSIBLE MINOR | The target is detected as a minor |
When the test_key is provided the system will dynamically drop the live data sources and use the testing database. These transactions are free of charge. To access live data do not send this attribute. Here are available test cases for the international service:
test key | description |
international_pass | Will return a PASS - ALL CHECKS PASSED result |
international_fail_no_match | Will return a FAIL - NO MATCH result |
international_review | Will return a REVIEW result. The issues array will include all issues available. |
international_fail_cannot_be_completed | Will return a FAIL - SERVICE CANNOT BE COMPELTED result |
The above are all "canned responses", so the target input will not matter if a valid test key is provided.
IDMatch International will process with the following rules by default
The base rule set will return a PASS when:
- The service was completed
- A match is found
- The target meets has provided all valid identity attributes
The base rule set will return a REVIEW when:
- The service was completed
- A match was found
- The target has not provided all accurate identity attributes
In this case a list of issues will be returned to indicate which attributes did not match
The base rule set will return a FAIL when:
- The service could not be completed
- No match found
Last modified 3yr ago