Electronic ID

The Electronic ID method allows you to use various electronic ID's in order to verify a user's age. If you are looking to perform age checks in any of the countries that we support eIDs we recommend offering these methods as an option to users. These eID schemes are widely adopted and regularly used, and therefore should lead to high success rates.

To integrate the electronic ID methods without using our UI you must go through the 3 step process detailed below:

1. Request a session
2. Launch URL
3. Retrieve Results

Request a session

The first step is to request a session for a specific electronic ID method.

POST https://age.yoti.com/api/v1/electronic-id/start-session

Request Body

{

  "method": "CZECH_BANK_ID",

  "return_url": "https://<YourDomain>/return",

  "enhanced_checks": true

}

Example Response

{

  "url": "string",

  "conversation_id": "string"

}

Launch URL

The second step in the integration process is to simply launch the url that is retrieved in the API call detailed above. The user will be directed to the relevant electronic Id method, where they will be able to complete the verification process. On completion, the user will be redirected to the "return_url" that was configured in the API call detailed above.

Retrieve Results

The final step in the integration would be to retrieve the results of the age verification. To do this a final call to our API will need to be made.

GET https://age.yoti.com/api/v1/electronic-id/status/{conversationId}

The conversion Id that is returned in the API call to request a session must also be used as a query parameter in this API call.

Example Response

{

  "status": "COMPLETE",

  "data": {

    "fullname": "string",

    "address": "string",

    "date_of_birth": "string"

  }

}