International

Age verification via trusted and verified data sources in countries outside of the United States.

What countries are covered?

Click this link to see what countries are covered for the AgeMatch International Service.

post
AgeMatch5.0.{CountryName}

https://production.idresponse.com/process/comprehensive/gateway
Make an HTTPS POST request with the following body parameters to find out if the target meets your age requirement. You will receive a synchronous response in 2-3 seconds with a result object that includes an action and a detail.
Request
Response
Request
Body Parameters
user
required
string
Your account's API username
pass
required
string
Your account's API password
service
required
string
The service nameAgeMatch5.0.{CountryName}The "CountryName" should match the value in the international coverage section.
reference
optional
string
A unique identifier for your customer
target
required
object
The individual being sent for verification
fn
required
string
The target's first name
ln
required
object
The target's last name
addr1
required
string
The target's house number or name, plus street
addr2
optional
string
the target's apt, flat or floor
addr3
optional
string
The target's further address details
addr4
optional
string
The target's further address details
addr5
optional
string
The target's city
addr6
optional
string
The target's locality (e.g. county)
addr7
optional
string
The target's state or UK county
zip
required
string
The target's zip/postal code
dob
optional
string
The target's Date of Birth (YYYYMMDD format)
international_id
optional
string
The target's international id number.This is sometimes required. Check the international coverage page for more details.
phone
optional
string
The target's phone number
age
required
string
The age to check (must be sent like "age+" i.e. "18+", "21+" etc.)
test_key
optional
string
The test key value that you are using to test
Response
200: OK
Transaction processed and result returned
{
"meta": {
"confirmation": 71483084,
"reference": "12345",
"service": "AgeMatch5.0",
"timestamp": "2019-10-17 14:29:48",
"company": "Company ABC, Inc.",
"user": "user@company.com"
},
"result": {
"action": "PASS",
"detail": "ALL CHECKS PASSED",
"issues": []
}
}

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:

AgeMatch5.0.Canada

But in certain cases where a country name has spaces i.e. the United Kingdom the service name will be like:

AgeMatch5.0.UK

You will find all of the countries where there is an exception in the data coverage section of the documentation.

Sample Request Body

{
"user": "user@company.com",
"pass": "PASSWORD",
"service": "AgeMatch5.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

AGE NOT VERIFIED

Target found, but no DOB information available or the DOB did not match

FAIL

POSSIBLE MINOR

Input DOB is under the age to check

FAIL

SERVICE CANNOT BE COMPLETED

The underlying data sources are having a processing issue. Resubmit this query at a later time

PASS

ALL CHECKS PASSED

Target was found and meets the age requirement

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_fail_age_not_verified

Will return a FAIL - AGE NOT VERIFIED result

international_fail_possible_minor

Will return a FAIL - POSSIBLE MINOR result

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.

Rules

AgeMatch International will process with the following rules by default

The base ruleset will return a PASS when:

  • A match is found

  • The target meets the minimum age requirement

The base ruleset will return a FAIL when:

  • No Match Found

  • The target's age has not been verified

  • The service can not be completed