Delete Multiple onboarding sessions with multiple options.

POSThttps://demo-api.incodesmile.com/omni/delete/interviews

Deprecated — this endpoint is marked deprecated in the Omni API specification.

Delete all onboarding sessions by given array of interview ids. The endpoint is executed asynchronously. Note: Requires admin login token reference - /executive/log-in 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.

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

interviewIdsarray[string]

deletePiiFieldsOnlybooleanDefaults to false

Flag indicating if this is partial delete, where only PII fields should be removed.

piiFieldsToKeeparray[string]

keepEnrolledUserbooleanDefaults to false

Flag indicating if user that was previously enrolled from this session should stay enrolled in the system after this session is deleted

keepTemplatesbooleanDefaults to false

Flag indicating if face templates created during onboarding process, should remain in DB

keepImagesbooleanDefaults to false

Flag indicating if images captured during onboarding process should remain in the system

keepDeviceFingerprintsbooleanDefaults to false

Flag indicating if device fingerprint stored during onboarding process should remain in the system

keepEventsbooleanDefaults to false

Flag indicating if events stored during onboarding process should remain in the system

keepValidationTestsbooleanDefaults to false

Flag indicating if validation tests stored during onboarding process should remain in the system

keepVideoArchivesbooleanDefaults to false

Flag indicating if video archives stored during onboarding process should remain in the system

keepConferenceEventsbooleanDefaults to false

Flag indicating if events stored during conference video call should remain in the system

keepChatsbooleanDefaults to false

Flag indicating if chat stored during conference video call should remain in the system

keepStatsbooleanDefaults to false

Flag indicating if statistics stored during onboarding process should remain in the system

deletionModestring

Specifies the type of deletion to perform.

enumBIOMETRICSPIIFULL

Responses

Response body (application/json)

successboolean

Flag indicating request passed successfully.

sessionStatusstring

Session status

enumAliveClosedDeleted

taskIdstring

statusUristring