Create a session
There are three steps to follow to integrate the In Branch API:
- Create the session
- Send instructions
- Generate results
Every time an end user elects to supply an ID document on the relying party app / website / custom product, you will need to create a session with Yoti to the initiate the session and perform ID checks.
POST https://api.yoti.com/idverify/v1/sessions
Good to know
It's worth reading our Identity Verification documentation to understand how we complete the Yoti document review process
{
"client_session_token_ttl": 604800 ,
"resources_ttl": 8700000,
"user_tracking_id": "some-tracking-id",
"block_biometric_consent": false,
"ibv_options": { },
"notifications": { },
"requested_checks": [ ],
"requested_tasks": [ ],
"required_documents": [ ],
"sdk_config": { }
}
IBV options property
Parmeter | Description | Mandatory |
---|---|---|
support | Each resource will be mapped to a list of allowed sources in the results
| ✅ |
Notifications
For information on notifications please head over here. We have included two additional notifications
Parmeter | Description |
---|---|
NEW_PDF_SUPPLIED | When the user completes the prerequisite flow, they will have an option to download the PDF. You can subscribe to be notified when the user has done this. |
INSTRUCTIONS_EMAIL_REQUESTED | If you do not enable this notification an email will automatically be sent to the user with their instructions. If you do enable this notification the email service will be revoked and you will need to configure this set up yourself. Yoti will send an async notification to prompt you to retrieve the PDF from Yoti and send it to the customer. |
Example response
If the request is successful and a session is generated the API will send a response in the form:
{
"client_session_token_ttl": 599,
"client_session_token": "<uuid>",
"session_id": "<uuid>"
}
Response | Description |
---|---|
client_session_token_ttl | Time in seconds until the client session expires |
client_session_token | Used to authenticate the session |
session_id | ID of the session |
Was this page helpful?