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.
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.
Check the Authorization guide on how to get an OAuth2 token, with the following scope:
dpv:FraudPreventionAndDetection kyc-age-verification:verify
Create an app on our Sandbox to get credentials and retrieve tokens so you can perform API calls to our operators' production environments, or use the following convenience token to test in mock mode:
mock_sandbox_access_token