United States
Age verification via trusted and verified data sources in the United States.
Last updated
Age verification via trusted and verified data sources in the United States.
Last updated
POST
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.
Name | Type | Description |
---|---|---|
Use the test_key
attribute to test the service. 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. The below sample request is one of the available test cases. To access more click the link below.
The following are all values that will be returned in the result object of the response.
AgeMatch will process with the default base ruleset unless a different rule set is specified in the query.
The base rule set will return a PASS when:
A match is found
The target is not deceased
The target meets the minimum age requirement
The following are additional matching rule sets. Each set is the above base default rule set plus additional matching requirements of the input elements.
user*
string
Your account's API username
pass*
string
Your account's API password
service*
string
The service name (AgeMatch5.0)
rules
string
See rules explanation below
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
addr*
string
The target's street address (line 1 and line 2)
city
string
the target's city
state
string
The target's state
zip*
string
The target's zip
dob
string
The target's Date of Birth (YYYYMMDD format)
ssn
string
The target's SSN (either 4 or 9)
phone
string
The target's phone number
string
The target's email address
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
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
FAIL
TARGET IS DECEASED
Target found as a deceased identity
FAIL
AGE NOT SUBMITTED
No age to check was provided in the query
FAIL
POSSIBLE MINOR
Target found, but a minor age detected
PASS
ALL CHECKS PASSED
Target was found is not deceased and meets the age requirement
Ruleset Name
Description
AgeMatch5_0_RuleSet_YOB
Base + Year of Birth Must Match
AgeMatch5_0_RuleSet_YOB_SSN
Base + Year of Birth and SSN Must Match
AgeMatch5_0_RuleSet_DOB
Base + Full Date of Birth Must Match
AgeMatch5_0_RuleSet_DOB_SSN
Base + Full DOB and SSN Must Match
AgeMatch5_0_RuleSet_ADDR
Base + Address Must Match
AgeMatch5_0_RuleSet_ADDR_YOB
Base + Address and Year of Birth Must Match
AgeMatch5_0_RuleSet_ADDR_YOB_SSN
Base + Address, Year of Birth and SSN Must Match
AgeMatch5_0_RuleSet_ADDR_DOB_SSN_PHONE
Base + Address and Date of Birth Must Match
AgeMatch5_0_RuleSet_ADDR_YOB_SSN_PHONE
Base + Address, Year of Birth, SSN and Phone Must Match
AgeMatch5_0_RuleSet_ADDR_DOB_PHONE
Base + Address, Date of Birth and Phone Must Match
AgeMatch5_0_RuleSet_ADDR_YOB_PHONE
Base + Address, Year of Birth and Phone Must Match
AgeMatch5_0_RuleSet_ADDR_SSN_PHONE
Base + Address, SSN and Phone Must Match
AgeMatch5_0_RuleSet_ADDR_PHONE
Base + Address and Phone Must Match
AgeMatch5_0_RuleSet_YOB_SSN_PHONE
Base + Year of Birth, SSN and Phone Must Match
AgeMatch5_0_RuleSet_DOB_SSN_PHONE
Base + Date of Birth, SSN and Phone Must Match
AgeMatch5_0_RuleSet_YOB_PHONE
Base + Year of Birth and Phone Must Match
AgeMatch5_0_RuleSet_DOB_PHONE
Base + Date of Birth and Phone Must Match
AgeMatch5_0_RuleSet_SSN_PHONE
Base + SSN and Phone Must Match
AgeMatch5_0_RuleSet_PHONE
Base + Phone Must Match