Create session

AI Tools

Create Session

To use ID verification, you will first need to create a session with the "doc_scan" method enabled.

POST https://age.yoti.com/api/v1/sessions

Header	Description
Authorization	API Key to call the Yoti Age Verification API. Should be sent as a Bearer token.
Content-Type	application/json
Yoti-SDK-Id	Your unique Yoti-Sdk-Id (uuid)

The age verification API uses an HTTP authentication scheme called ‘bearer authentication’. This involves security tokens called ‘bearer tokens’. They are the predominant type of access token used with OAuth 2.0. A resource should interpret a bearer token as "Give the bearer of this token access". The client must send this token in the Authorization header when making requests to protected resources.

It is important that your API Key remains strictly confidential. It must be stored securely. We advise that you never commit any code containing your API Key, and never share it beyond the authorised party.

If you believe your API key has been compromised, please generate new API keys in the hub asap.

Request Body

{ "type": "OVER", "doc_scan": { "allowed": true, "threshold": 18, "authenticity": "AUTO", "level": "PASSIVE", "preset_issuing_country": "GBR" }, "ttl": 900, "reference_id": "over_18_example", "notification_url": "https://yourdomain.example/webhook", "callback": { "auto": false, "url": "https://www.example.com" } }

Parameter	Types	Description
allowed	true / false	Enable the verification method to be available for the user to use.
threshold	Integer e.g. 30	Age threshold for under/over age limits. We recommend this to be the exact age of the threshold you want to cover.
authenticity	OFF / AUTO / MANUAL	If you would like to enable this, Yoti will perform a visual check on the document. For more information on the types of checks please head here.
level	NONE / PASSIVE	The level of anti-spoofing for each age verification method. PASSIVE enables an active liveness test and face match for IDV.
preset_issuing_country	Three letter country code e.g GBR	Determines the preset issuing country for the document selection.
type	OVER / UNDER / AGE	This is where you define what preference you want to set for the age of the user.
ttl	seconds (300)	How long the session is valid for, the user will need to complete this before the ttl expires. This must be at least 300 seconds (5 minutes). And can't be longer than 1 month.

Example response

If the request is successful and a session is generated the API will send a response in the form:

{ "id": "uuid", "expires_at": "2020-10-19T16:06:25.080Z" }

Error codes

Error code	Description
201	Success
400	Missing field in post body
401	Missing or unknown SDK ID
403	Incorrect API key

Last updated on

Was this page helpful?