Output

The response returns an array of matches along with request metadata, pagination, and an error container. For a typical age-verification call, the matches[0].minimumAgeMet boolean is the primary output consumed by downstream compliance logic.

📘

About matchTypeCode

Individual field objects (firstName, lastName, age) carry a matchTypeCode indicating how that field matched the input. Common values: NA (not supplied in request), FULL_MATCH, PARTIAL_MATCH, NO_MATCH.

Top-level response

Field	Type	Description
authType	string	Authentication scope used for this request. Common value: "All".
warning	string | null	Non-fatal warning message, if any. Null when the request completed without warnings.
matches	array	Array of matched identity records. Each entry is scored independently. See the Match object below.
responseRecordCount	integer	Number of records returned in the matches array.
pagination	object	Pagination metadata for the result set. See sub-fields below.
databaseQueryInfo	array	Diagnostic information about the databases queried. Empty for standard requests.
searchCriteria	array	Echo of the resolved search criteria used internally. Empty for standard requests.
totalRequestExecutionTimeMs	integer	Total server-side execution time in milliseconds.
requestId	string	Unique identifier for this request. Returns "NULL" when no request ID is assigned.
requestType	string	Echo of the request type. Empty string for AgeVerify.
requestTime	string (ISO 8601)	Server timestamp when the request was processed, with timezone offset.
isError	boolean	True if the request resulted in a fatal error. When true, inspect the error object.
error	object	Error container. Always present; inputErrors and warnings are empty arrays on success.

pagination

Field	Type	Description
currentPageNumber	integer	Zero-indexed page number.
resultsPerPage	integer	Page size requested.
totalPages	integer	Total number of pages available.
totalResults	integer	Total matching records across all pages.

error

Field	Type	Description
inputErrors	array	Validation errors related to the request body (e.g., missing identifier).
warnings	array	Non-fatal warnings raised during processing.

Match object

Field	Type	Description
firstName.value	string	First name of the matched identity.
firstName.matchTypeCode	string	NA when not supplied; otherwise FULL_MATCH, PARTIAL_MATCH, or NO_MATCH.
lastName.value	string	Last name of the matched identity.
lastName.matchTypeCode	string	Match-type indicator for last name.
minimumAgeMet	boolean	Primary output. True if the matched subject's computed age is ≥ MinimumAgeRequired. Consume this field directly for pass/fail decisions.
age.value	string	Age in years as a string.
age.matchTypeCode	string	Match-type indicator for age when DOB was supplied; NA otherwise.
compositeMatchScore	integer (0–100)	Confidence score for the overall identity match. Not a direct percentage of matched fields; reflects weighted signal strength across all supplied identifiers.
scoreDescriptions	array	Nine-element array of per-dimension match descriptions. Array order: [Address, Name, DOB, Phone, Email, SSN, City, Zip, State]. Values include NA, FULL_PHONE_MATCH, FULL_EMAIL_MATCH, FULL_NAME_MATCH, PARTIAL_*, and NO_*_MATCH variants.

Example response

JSON

{
  "authType": "All",
  "warning": null,
  "matches": [
    {
      "firstName": { "value": "Test", "matchTypeCode": "NA" },
      "lastName":  { "value": "Test", "matchTypeCode": "NA" },
      "minimumAgeMet": true,
      "age": { "value": "43", "matchTypeCode": "NA" },
      "compositeMatchScore": 100,
      "scoreDescriptions": [
        "NA","NA","NA","FULL_PHONE_MATCH","NA","NA","NA","NA","NA"
      ]
    }
  ],
  "responseRecordCount": 1,
  "pagination": {
    "currentPageNumber": 0,
    "resultsPerPage": 0,
    "totalPages": 0,
    "totalResults": 1
  },
  "databaseQueryInfo": [],
  "searchCriteria": [],
  "totalRequestExecutionTimeMs": 62,
  "requestId": "NULL",
  "requestType": "",
  "requestTime": "2026-04-10T11:26:56.0762113-07:00",
  "isError": false,
  "error": { "inputErrors": [], "warnings": [] }
}