Retrieve results

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 its 'time to live' is reached. For any active session, you can use the Yoti SDK to retrieve a report on the session (containing the end-user's uploaded documents and associated metadata).

This page explains how to:

• Retrieve the results of the session.
• Retrieve the associated media.
• Display the Identity Profile Report for the session.

Result of the session

Session retrieval requires a session ID, this is generated from the create a session endpoint. Below is a basic example of what retrieving a session looks like:

// Returns a session result

const sessionResult = await idvClient.getSession(sessionId);

​

// Returns the session state

const state = sessionResult.getState();

​

// Returns session resources

const resources = session.getResources();

The following are present in every session result:

Retrieve the Media

Document images from the user, text extraction fields and liveness captures for the session are available inside the resources container. These can be retrieved by looking at the relevant media ID inside the documents collection.

// Returns a collection of ID Documents

const idDocuments = resources.getIdDocuments();

​

// Returns document fields object

const documentFields = idDocuments[0].getDocumentFields();

​

const mediaId = documentFields.getMedia().getId();

const media = await idvClient.getMediaContent(sessionId, mediaId);

​

const buffer = media.getContent();

const base64Content = media.getBase64Content();

const mimeType = media.getMimeType();

Retrieve the Identity Profile

Once the session has reached the state of 'Completed', identity profile can be successfully retrieved.

In case of a successful transaction, once the identity profile is received, the identity profile report JSON will be accessible. This contains the media ID which can then be used to get the full JSON response of the report.

const identityProfile = sessionResult.getIdentityProfile();

const identityProfileReport = identityProfile.getIdentityProfileReport();

​

const mediaId = identityProfileReport.getMedia().getId();

const identityProfileReportMedia = await idvClient.getMediaContent(sessionId, mediaId);

​

const identityProfileReportMediaBuffer = identityProfileReportMedia.getContent();

Session Result Parameters

The session result contains the session metadata, ID checks, uploaded documents and the identity profile report.

Example JSON Response

{

    "client_session_token_ttl": 8490,

    "session_id": "52098976-42d0-4051-a80f-7fc3438e4d9e",

    "state": "COMPLETED",

    "resources": {...},

    "checks": [...],

    "biometric_consent": "2024-06-24T14:44:33Z",

    "advanced_identity_profile": {...}

}