v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Interview

Delete PII data for single onboarding session by external ID.

Delete single onboarding session using the external ID as identifier. Note: Works with <Glossary>Admin Token</Glossary>.Please, bear in mind that usage of this API endpoint for deletion of Customer Data will mean that Incode will no longer have access to it nor will be able to review or analyze any issue related to deleted Customer Data. After deletion, as Incode will not be able to retrieve the deleted Customer Data, any potential claims related to such data will be waived by Customer. Finally, for clarity purposes, Incode may continue to process information derived from Customer Data that has been deidentified, anonymized, and/or aggregated such that the data is no longer considered Personal Data under applicable Data Protection Laws and in a manner that does not identify individuals or Customer to improve its services and defend its legitimate interests.

delete/omni/session/externalId

Query parameters

externalIdstring required

Specify which external-id.

keepCustomerboolean

True or false. Indicates whether to keep idenity of the customer or not. Default is false(which means session and customer identity both will be deleted).

sendNotificationboolean

Flag to send a notification about a change interview status

Headers

api-versionstring required

Response

OK

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status