Sandbox response

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.

Endpoint

GET https://api.yoti.com/sandbox/idverify/v1/sessions/<SESSION_ID>

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 response const response = request.execute();

<?php use Yoti\Http\RequestBuilder; use Yoti\Http\Payload; $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 Response ->execute();

from yoti_python_sdk.http import SignedRequest, RequestHandler import json import requests def execute(request): response = requests.request( url=request.url, data=request.data, headers=request.headers, method=request.method) return response.content def get_session(): signed_request = ( SignedRequest .builder() .with_pem_file("<YOTI_KEY_FILE_PATH>") .with_base_url("https://api.yoti.com/sandbox/idverify/v1") .with_endpoint("/sessions/<SESSION_ID>") .with_http_method("GET") .with_param("sdkId", "<YOTI_CLIENT_SDK_ID>") .build() ) response = signed_request.execute() response_payload = json.loads(response.text) //get Yoti response print(get_session())

byte[] payload = ... try { SignedRequest signedRequest = SignedRequestBuilder.newInstance() .withKeyPair(<YOTI_KEY_FILE_PATH>) .withBaseUrl("https://api.yoti.com/sandbox/idverify/v1") .withEndpoint("/sessions/<SESSION_ID>") .withHttpMethod("GET") .withQueryParameter("sdkId", "<YOTI_CLIENT_SDK_ID>") .build(); YourPojo yourPojo = signedRequest.execute(YourPojo.class); } catch (GeneralSecurityException | URISyntaxException | IOException | ResourceException ex) { ex.printStackTrace(); }

import ( "io/ioutil" "net/http" "github.com/getyoti/yoti-go-sdk/v2/requests" ) sdkID := "<YOTI_CLIENT_SDK_ID>"; key, _ := ioutil.ReadFile("<YOTI_KEY_FILE_PATH>") // Create session sessionRequest, _ := requests.SignedRequest{ HTTPMethod: http.MethodGet, BaseURL: "https://api.yoti.com/sandbox/idverify/v1", Endpoint: "/sessions/<SESSION_ID>", Params: map[string]string{ "sdkId": sdkID, }, Headers: map[string][]string{ "Content-Type": {"application/json"}, "Accept": {"application/json"}, }, }.WithPemFile(key).Request() //get Yoti response sessionResponse, _ := http.DefaultClient.Do(sessionRequest)

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

Session Response

{ "client_session_token_ttl": 3056799, "session_id": "05153de7-1250-4772-abcf-607b010047a5", "state": "COMPLETED", "resources": { "id_documents": [ { "id": "73ea4890-c80b-4e5b-8437-02f5f72a777e", "tasks": [], "source": { "type": "IBV" }, "created_at": "2025-05-01T14:53:00Z", "last_updated": "2025-05-01T14:53:01Z", "document_type": "PASSPORT", "issuing_country": "GBR", "pages": [ { "capture_method": "CAMERA", "media": { "id": "a1d75647-35ad-467b-9faf-be14029b8e81", "type": "IMAGE", "created": "2025-05-01T14:53:01Z", "last_updated": "2025-05-01T14:53:01Z" }, "frames": [ { "media": { "id": "0d8db5e5-c9b6-4f26-841e-c396e1e3a658", "type": "IMAGE", "created": "2025-05-01T14:53:03Z", "last_updated": "2025-05-01T14:53:03Z" } }, { "media": { "id": "09327307-2a75-42dc-aac1-cd3fa5cb7bcc", "type": "IMAGE", "created": "2025-05-01T14:53:04Z", "last_updated": "2025-05-01T14:53:04Z" } }, { "media": { "id": "7f8adbe2-9ba5-4e45-bebb-2ebed258eb72", "type": "IMAGE", "created": "2025-05-01T14:53:05Z", "last_updated": "2025-05-01T14:53:05Z" } } ] } ] } ], "supplementary_documents": [], "liveness_capture": [], "face_capture": [], "applicant_profiles": [ { "id": "83169ac1-84c5-4e4e-bab6-93a18184edbe", "tasks": [], "source": { "type": "RELYING_BUSINESS" }, "created_at": "2025-05-01T14:52:29Z", "last_updated": "2025-05-01T14:52:29Z", "media": { "id": "e19f3a27-f18b-497d-8f06-49dc5ee5c3ce", "type": "JSON", "created": "2025-05-01T14:52:29Z", "last_updated": "2025-05-01T14:52:29Z" } } ] }, "checks": [ { "type": "IBV_VISUAL_REVIEW_CHECK", "id": "8bb86c0e-9672-4470-93d6-603fb72701d3", "state": "DONE", "resources_used": [ "73ea4890-c80b-4e5b-8437-02f5f72a777e" ], "generated_media": [], "report": { "recommendation": { "value": "APPROVE" }, "breakdown": [] }, "created": "2025-05-01T14:53:07Z", "last_updated": "2025-05-01T14:53:07Z" }, { "type": "DOCUMENT_SCHEME_VALIDITY_CHECK", "id": "67f5003e-3fd4-4154-ad74-a0bafaa53d2c", "state": "DONE", "resources_used": [ "73ea4890-c80b-4e5b-8437-02f5f72a777e" ], "generated_media": [], "report": { "recommendation": { "value": "APPROVE" }, "breakdown": [] }, "created": "2025-05-01T14:53:07Z", "last_updated": "2025-05-01T14:53:07Z", "scheme": "UK_GDS" }, { "type": "PROFILE_DOCUMENT_MATCH", "id": "d0936b43-09df-4111-9e0b-839f5e87c705", "state": "DONE", "resources_used": [ "73ea4890-c80b-4e5b-8437-02f5f72a777e", "83169ac1-84c5-4e4e-bab6-93a18184edbe" ], "generated_media": [], "report": { "recommendation": { "value": "APPROVE" }, "breakdown": [] }, "created": "2025-05-01T14:53:07Z", "last_updated": "2025-05-01T14:53:07Z" } ], "user_tracking_id": "some_id" }

Last updated by Kiran Bali on Mar 23, 2026

Was this page helpful?