United States

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

post
AgeMatch5.0

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 name (AgeMatch5.0)
rules
optional
string
See rules explanation below
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
addr
required
string
The target's street address (line 1 and line 2)
city
optional
string
the target's city
state
optional
string
The target's state
zip
required
string
The target's zip
dob
optional
string
The target's Date of Birth (YYYYMMDD format)
ssn
optional
string
The target's SSN (either 4 or 9)
phone
optional
string
The target's phone number
email
optional
string
The target's email address
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, LLC",
"user": "ws@company.com"
},
"result": {
"action": "PASS",
"detail": "ALL CHECKS PASSED",
"issues": []
}
}

Service Testing

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.

Sample Request Body

{
"user": "USERNAME",
"pass": "PASSWORD",
"service": "AgeMatch5.0",
"reference": "12345 {A UNIQUE ID}",
"rules": "AgeMatch5_0_RuleSet_YOB_SSN",
"target":{
"fn":"Barbara",
"ln": "Miller",
"addr": "123 Main St",
"city": "Stratford",
"state": "CT",
"zip": "06614",
"dob": "19740821",
"ssn": "854125698",
"phone": "2015106000",
"email": "bmiller@veratad.com",
"age": "21+",
"test_key": "general_identity"
}
}

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

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

Rules

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

Additional Rule Sets

The following are additional matching rule sets. Each set is the above base default rule set plus additional matching requirements of the input elements.

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