Delete Session

It is possible to delete a session or image (media) before the defined retention period (ttl) is over.

Deleting the session will also delete all media from that session. You can delete a session yourself by sending a DELETE request to the endpoint below.

DELETE https://api.yoti.com/idverify/v1/sessions/{sessionId}

SDK Example:

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>")

.withMethod("DELETE")

.withQueryParam("sdkId", "<YOTI_CLIENT_SDK_ID>")

.build();

//get Yoti response

const response = await request.execute();

Yoti recommends starting a new session for the same applicant doing a re-verification or needing to edit their session.

Last updated by Jason Martyres on Aug 9, 2023

Was this page helpful?