Knowyourcustomerageverification

Know Your Customer Age Verification

Verify Age Threshold

client.knowyourcustomerageverification.verify(, ?): KnowyourcustomerageverificationVerifyResponse { ageCheck, contentLock, identityMatchScore, 2 more }

POST/knowyourcustomerageverification/verify

ModelsExpand Collapse

KnowyourcustomerageverificationVerifyResponse { ageCheck, contentLock, identityMatchScore, 2 more }

Response to an age verification request

ageCheck: "true" | "false" | "not_available"

Indicate "true" when the age of the user is the same age or older than the age threshold (age >= age threshold), and "false" if not (age < age threshold). If the API Provider doesn’t have enough information to perform the validation, a not_available can be returned.

One of the following:

"true"

"false"

"not_available"

contentLock?: "true" | "false" | "not_available"

Indicate "true" if the subscription associated with the phone number has any kind of content lock (i.e certain web content blocked) and "false" if not. If the information is not available the value not_available can be returned.

One of the following:

"true"

"false"

"not_available"

identityMatchScore?: number

The overall score of identity information available in the API Provider, information either provided in the request body comparing it to the one that the API Provider holds or directly using internal API Provider’s information. It is optional for the API Provider to return the Identity match score.

minimum0

maximum100

parentalControl?: "true" | "false" | "not_available"

Indicate "true" if the subscription associated with the phone number has any kind of parental control activated and "false" if not. If the information is not available the value not_available can be returned.

One of the following:

"true"

"false"

"not_available"

verifiedStatus?: boolean

Indicate true if the information provided has been compared against information based on an identification document legally accepted as an age verification document (Note), otherwise indicate false. Note: Depending on the country, credit-check or other mechanism can be used instead of official identification for Age Verification. For details, please contact API Provider.