Create a session

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

Endpoint

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

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 as soon as possible.

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"

    }

}