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:
But in certain cases where a country name has spaces i.e. the United Kingdom the service name will be like:
You will find all of the countries where there is an exception in the data coverage section of the documentation.
The following are all values that will be returned in the result object of the response.
No matching identity found in the data sources
SERVICE CANNOT BE COMPLETED
The underlying data sources are having a processing issue. Resubmit this query at a later time
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.
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.
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
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:
Will return a PASS - ALL CHECKS PASSED result
Will return a FAIL - NO MATCH result
Will return a REVIEW result. The issues array will include all issues available.
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