The first step is to request a session for a specific electronic ID method. The three supported headless are:
- Bank ID (Prague)
- Moje ID (Prague)
- EDO App (Poland)
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 |
Example 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 |
Was this page helpful?