Verify Age Threshold

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

POST/knowyourcustomerageverification/verify

Verify that the age of the subscriber associated with a phone number is equal to or greater than the specified age threshold value.

As it is possible that the person holding the contract and the end-user of the subscription may not be the same, the endpoint also admits a list of optional properties to be included in the request to improve the identification. The response may optionally include the identityMatchScore property with a value that indicates how certain it is that the information returned relates to the person that the API Client is requesting. To increase the reliability of the information returned, the API Provider may include in the response the verifiedStatus property, indicating whether the identity information in its possession has been verified against an identification document legally accepted as an age verification document (Note). 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.

If the API Client indicates request properties includeContentLock or includeParentalControl with value true and the API Provider implements this functionality, then the response will also include contentLock and parentalControl properties to indicate if the subscription has any kind of content filtering enabled. On the other hand, if the request properties are not included or the API Client specifies value false, then the response properties will not be returned. If the API Provider doesn’t implement this functionality, request properties will be ignored and response properties won’t be returned in any case.

ParametersExpand Collapse

params: KnowyourcustomerageverificationVerifyParams { ageThreshold, birthdate, email, 10 more }

ageThreshold: number

Body param: The age to be verified. The indicated range is a global definition of maximum and minimum values allowed to be requested. It is important to note that this range might be more restrictive in some implementations due to local regulations of a country i.e. A country does not allow to request for an age under 18. This limitation must be informed during the onboarding process.

minimum0

maximum120

birthdate?: string

Body param: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).

formatdate

email?: string

Body param: Email address of the customer in the RFC specified format (local-part@domain).

formatemail

familyName?: string

Body param: Last name, family name, or surname of the customer.

familyNameAtBirth?: string

Body param: Last/family/sur- name at birth of the customer.

givenName?: string

Body param: First/given name or compound first/given name of the customer.

idDocument?: string

Body param: Id number associated to the official identity document in the country. It may contain alphanumeric characters.

includeContentLock?: boolean

Body param: If this parameter is included in the request with value true, the response property contentLock will be returned. If it is not included or its value is false, the response property will not be returned.

includeParentalControl?: boolean

Body param: If this parameter is included in the request with value true, the response property parentalControl will be returned. If it is not included or its value is false, the response property will not be returned.

middleNames?: string

Body param: Middle name/s of the customer.

name?: string

Body param: Complete name of the customer, usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.

phoneNumber?: string

Body param: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.

xCorrelator?: string

Header param: Correlation id for the different services

ReturnsExpand 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.

Verify Age Threshold

import Camara from 'camara-sdk';

const client = new Camara({
  bearerToken: process.env['CAMARA_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.knowyourcustomerageverification.verify({
  ageThreshold: 18,
  birthdate: '1978-08-22',
  email: 'federicaSanchez.Arjona@example.com',
  familyName: 'Sanchez Arjona',
  familyNameAtBirth: 'YYYY',
  givenName: 'Federica',
  idDocument: '66666666q',
  includeContentLock: true,
  includeParentalControl: true,
  middleNames: 'Sanchez',
  name: 'Federica Sanchez Arjona',
  phoneNumber: '+34629255833',
});

console.log(response.identityMatchScore);

{
  "ageCheck": "true",
  "verifiedStatus": true,
  "identityMatchScore": 90,
  "contentLock": "false",
  "parentalControl": "true"
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 400,
  "code": "OUT_OF_RANGE",
  "message": "Client specified an invalid range."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "The phone number provided is not associated with a customer account"
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not applicable for the provided phone number"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "No phone number has been provided"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "An explicit phone number has been provided when one is already associated with the access token"
}

Returns Examples

{
  "ageCheck": "true",
  "verifiedStatus": true,
  "identityMatchScore": 90,
  "contentLock": "false",
  "parentalControl": "true"
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 400,
  "code": "OUT_OF_RANGE",
  "message": "Client specified an invalid range."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "The phone number provided is not associated with a customer account"
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not applicable for the provided phone number"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "No phone number has been provided"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "An explicit phone number has been provided when one is already associated with the access token"
}