# International
## What countries are covered?
Click this link to see what countries are covered for the IDMatch International Service.
{% content-ref url="../coverage/international" %}
[international](https://api.veratad.com/coverage/international)
{% endcontent-ref %}
## IDMatch5.0.{CountryName}
`POST` `https://production.idresponse.com/process/comprehensive/gateway`
Make an **HTTPS POST** request with the following body parameters to find out if the target has provided valid identity attributes. You will receive a synchronous response in 2-3 seconds with a **result** object that includes an **action** and a **detail**.
#### Request Body
| Name | Type | Description |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
| user\* | string | Your account's API username |
| pass\* | string | Your account's API password |
| service\* | string | The service name IDMatch5.0.{CountryName}The "CountryName" should match the value in the international coverage section. |
| 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 |
| addr1 | string | The target's house number or name, plus street |
| addr2 | string | the target's apt, flat or floor |
| addr3 | string | The target's further address details |
| addr4 | string | The target's further address details |
| addr5 | string | The target's city |
| addr6 | string | The target's locality (e.g. county) |
| addr7 | string | The target's state or UK county |
| zip\* | string | The target's zip/postal code |
| dob | string | The target's Date of Birth (YYYYMMDD format) |
| international\_id | string | The target's international id number.This is sometimes required. Check the international coverage page for more details. |
| phone | string | The target's phone number |
| 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 |
{% tabs %}
{% tab title="200 Transaction processed and result returned" %}
```javascript
{
"meta": {
"confirmation": 71483084,
"reference": "12345",
"service": "IDMatch5.0.{CountryName}",
"timestamp": "2019-10-17 14:29:48",
"company": "Company ABC, Inc.",
"user": "user@company.com"
},
"result": {
"action": "PASS",
"detail": "ALL CHECKS PASSED",
"issues": []
}
}
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
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.
{% endhint %}
## Sample Request Body
```javascript
{
"user": "user@company.com",
"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"
}
}
```
## Action and Detail Responses
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. |
## Issues Responses
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 |
## Service Testing
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 |
{% hint style="info" %}
The above are all "canned responses", so the target input will not matter if a valid test key is provided.
{% endhint %}
## Rules
IDMatch International will process with the following rules by default
{% hint style="info" %}
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
{% endhint %}
{% hint style="warning" %}
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
{% endhint %}
{% hint style="danger" %}
The base rule set will return a FAIL when:
* The service could not be completed
* No match found
{% endhint %}