Retrieve results
After the user has completed their session you will then be able to retrieve the result of the session.
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 recommendations). 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/sessions/{sessionId}
Example of the get session response of a completed session, outlining the state of the checks. A recommendation value of "APPROVE" will be issued for each one. The person in branch will not complete the session if:
- All / Any of the documents are not present
- The profile data doesn't match
- If the wrong documents are brought in
- If the documents are not valid
{
"session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"resources": { },
"checks": [ ]
}
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 |