Retrieve results

After the user has completed their in-branch session you will then be able to retrieve the result of the IBV session.

Each session has a configured 'time to live' (TTL) which must be above 300 seconds (5 minutes). When a session is created, it remains active until it's time to live is reached. For any active session, you can use the Yoti API to retrieve a report on the session (containing all the end-user's uploaded documents and associated metadata). If you wish to be notified on the progress of the session please use notifications.

This sections explains how to:

  • Retrieve the results of the session

If you would like information on retrieving the ID document images, user information and the report head here.

GET https://api.yoti.com/idverify/v1/session/<sessionId>/configuration

Example of the configured response stating what documentation and checks are required.

{
"client_session_token_ttl": 599,
"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"requested_checks": [ ... ],
"capture": {
...
"required_resources": [
{
"type": "ID_DOCUMENT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "REQUIRED",
...

"allowed_sources": [
{ "type": "END_USER" },
{
"type": "IBV",
"allowed_providers": [ "UK_POST_OFFICE" ],
}
]

},
{
"type": "SUPPLEMENTARY_DOCUMENT",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "REQUIRED",
...

"allowed_sources": [ ] // exactly as above

Hint Face capture is the result of the image capture of the user.

GET https://api.yoti.com/idverify/v1/session/<sessionId>/

Example of a response outlining the state of the checks. Once the checks are complete a recommendation value will be issued for each one.

{…}

The following is present in every session result.

Value

Description

Resources

A container of all ID documents and liveness captures for this session.

Checks

A container of all checks performed for this session


  Last updated by Josh Steadman
On This Page
Retrieve results