Overview
Welcome to the developer documentation for integrating our age assurance solution.
The Verifymy Age Assurance solution provides users with a range of convenient and privacy-preserving age verification and estimation methods to meet your platform’s and its users’ individual needs.
This developer documentation will guide you through the implementation steps for both mobile and web.
Age assurance methods
The full range of age verification and estimation methods is listed below. Your integration can offer a combination of one or more of the following verification methods to users.
| Type | Method | Description |
|---|---|---|
Age estimation |
Facial age estimation |
An age estimation method based on a person's facial features captured in a short selfie video. |
Email-based age estimation |
An age estimation method that uses only an email address to accurately determine user age while preserving privacy. |
|
Age verification |
Government-issued ID scan |
An age verification method that uses ID scanning to determine a user's exact age. |
Government-issued ID scan + Facematch |
An age verification method that uses government-issued IDs to determine a user's age and employs face match technology to verify ID ownership. |
|
Mobile phone number |
An age verification method confirming the phone is in the possession of and authorised for use by a person aged 18+. |
|
Credit Card |
An age verification method using credit card authorisation to confirm age. |
|
anonymAGE (Double Anonymity) |
The user uploads a scan of their ID and a selfie to match them to their ID via a 3rd party to ensure complete anonymity. |
User flow
We provide age assurance methods either through Background Age Checks, which typically require no user action, or via an age gate, which involves user participation. Let’s explore these types of integration in more detail.
Background age check
Age checks can be seamlessly integrated without disrupting the user journey.
By utilising data collected during the account creation process, such as their email address, users can be age verified with no further interaction required.
Caution
To utilise a background check, as a regulatory requirement, you must confirm the users ownership of their email address or mobile number via secure means, e.g. a clickable link, One-Time Password (OTP) or OAuth.
Age Gate Check
If a user’s age cannot be verified using the available data, they will be given a choice of alternative age assurance methods you have made available to them, whereby they can manually input data to complete the verification process.
Example of method choice screen
Example of the facial age estimation process
Example of the government-issued ID scan process
Technical flow
This section describes the key interactions between our service and yours as the user is sent through age verification.
Background Age Check
If you’re using a background age check, you will send the existing user data from your site when you generate the verification URL.
If this background check is successful, we will notify you, and you can redirect the user to your success page.
If the check is unsuccessful, we will provide you with an URL in our response to redirect the user to input their data manually.
Age Gate Check
If you’re not using a background age check, we will provide a verification URL to take the user through the age verification process.
Once their verification is complete, the user will be redirected back to you, and we will provide you with information to retrieve their verification status.
Integration flow
A simplified view of the Verifymy integration:
The integration follows the standard OAuth flow:
- Initiate a verification request with Verifymy
- If the user isn’t instantly approved, send them to the verification URL to complete their verification
- Receive the user back at your redirect URL with a verification ID
- Retrieve the user’s verification result from the status endpoint
Supported browsers
Our age verification journey is supported in the following browsers:
Firefox
Safari
Edge
Supported languages
Our age verification interface is available in the following languages:
English (British)
German
French (France)
Italian
Portuguese (Brazil)
Spanish (Latin America)
Before starting the integration, please ensure you have:
- API Credentials & Business Settings ID: Contact your onboarding manager to request access to the API credentials needed for your integration.
- Redirect URL: Register a valid redirect URL where users will be redirected after completing the verification process.
