Title
Create new category
Edit page index title
Edit category
Edit link
Electronic ID
Overview
The Electronic ID method allows you to use various electronic ID's in order to verify a user's age.
Users can use the following electronic ID cards to prove their age:
- Swedish Bank ID (Sweden)
- FTN (Finland)
- MitID (Denmark)
- Bank ID (Prague)
- Moje ID (Prague)
- EDO App (Poland)
If you are looking to perform age checks in any of these countries, 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.
Electronic ID Enhanced also supports Polish MojeID, Polish ID, Czech Bank ID and Czech MojeID. With this method, accuracy is increased further as the individual’s information can be matched to purchase data records. The individual’s date of birth and address are shared with the client with this option.
This way of proving age has high accuracy, as the digital IDs have already been verified by a third-party supplier.
This method is good for:
- High assurance
- Regional
To integrate the electronic ID methods you must go through the 3 step process detailed below:
- Request a session
- Launch URL
- 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| Header | Description |
|---|---|
| Authorization | API Key to call the Yoti Age API. Should be sent as a Bearer token |
| Content-Type | application/json |
| Yoti-SDK-Id | Your unique Yoti-Sdk-Id (uuid) |
Request Body
{ "method": "CZECH_BANK_ID", "return_url": "https://<YourDomain>/return", "enhanced_checks": true}| Parameter | Types | Description |
|---|---|---|
| method | String | Electronic Id method:
|
| return_url | String | Url that the user will be redirected towards after they complete the verification process |
| enhanced_checks | boolean | Toggle for enhanced checks, must be set to true |
Response
{ "url": "string", "conversation_id": "string"}| Parameter | Description |
|---|---|
| url | The url that the user needs to be directed towards to complete the verification |
| conversion_id | Unique Id needed to retrieve results |
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 Result
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}| Header | Description |
|---|---|
| Authorization | API Key to call the Yoti Age API. Should be sent as a Bearer token |
| Content-Type | application/json |
| Yoti-SDK-Id | Your unique Yoti-Sdk-Id (uuid) |
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.
Response
{ "status": "COMPLETE", "data": { "fullname": "string", "address": "string", "date_of_birth": "string" }}| Parameter | Description |
|---|---|
| status | IN_PROGRESS - User has not yet completed the process. COMPLETE - The session has been completed, data has successfully been returned. ERROR - We could not provide any Data or an error occurred. FAIL - We have only received a partial result. |
| data | The data of the individual who underwent the verification, including the date of birth. |