Welcome to the developer documentation for integrating the Age Verification Service.
You can integrate the service using:
API An API integration, please contact us for the developer documentation.
Portal To view session results only.
The main steps for the integration are:
Create a session
Add your methods and configure your thresholds.
Launch the user view
Results.
This section describes the API interactions for a web and mobile web integration. Data is exchanged securely between the relying party (your backend), Yoti and the client (the end user’s browser or mobile device).
A session represents a single end-to-end interaction with the Yoti age verification service. You’ll receive the session ID (identifier) in the response when you create a session. Each time a user on your app or website initiates an age verification, you should create a new session with Yoti to perform the checks.
Once the Yoti Client has launched, it will take the end user through the appropriate age capture flow. Once this flow is completed, the end user is redirected back to the relying business so that they may continue their journey. These redirects are defined when generating the session.
The session can be retrieved using the session ID. The response from this endpoint contains information on the age of the user, the result and the method.