Retrieve Results

AI Tools

The response will detail all information, check and task completion status, resource and media data, along with the associated media identifiers.

Sessions can be retrieved at any time, however the integrating backend will be notified when a session update occurs, according to the notifications settings provided at session creation.

Javascript
PHP
Python
Java
Go
C#
    
xxxxxxxxxx
 
const { RequestBuilder, Payload } = require("yoti"); const request = new RequestBuilder()  .withBaseUrl("https://api.yoti.com/sandbox/idverify/v1")  .withPemFilePath("<YOTI_KEY_FILE_PATH>")  .withEndpoint(`/sessions/<SESSION_ID>`)  .withMethod("GET")  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")  .build(); //get Yoti responseconst response = request.execute();
Copy

See below for an example response from the retrieve session endpoint.

Session Response

RTW
DBS
IDENTITY
CUSTOM
    
xxxxxxxxxx
 
{
    "client_session_token_ttl": 8899,    "session_id": "2433153f-f3a6-4003-b14b-2e15f70b612f",    "state": "COMPLETED",    "resources": {...},
    "checks": [...],
    "identity_profile": {...}
}
Copy

Retrieve Media

A second API call will need to be made to retrieve the media related to a session e.g document images. The media is linked to the image will need to be added in the API request.

Javascript
PHP
Python
Java
Go
C#
    
xxxxxxxxxx
 
const { RequestBuilder} = require("yoti"); const request = new RequestBuilder()  .withBaseUrl("https://api.yoti.com/idverify/v1")  .withPemFilePath("<YOTI_KEY_FILE_PATH>") // file path to PEM file  .withEndpoint("/sessions/<sessionId>/media/<mediaId>/content")  .withMethod("GET")  .withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")  .build(); //get Yoti responseconst response = await request.execute();
Copy

Last updated on

Was this page helpful?