API reference, Interview

Delete PII data for multiple onboarding sessions with multiple options.

DELETEhttps://demo-api.incodesmile.com/omni/interviews

Delete all PII data for onboarding sessions by given array of interview ids. Note: Works with Admin Token.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

Filter for cleaning interview

idsarray[string]

List of identifiers interviews

flowIdstring

Flow id, if passed, then delete all interviews related to this flow

externalIdstring

Specify which external-id.

externalCustomerIdstring

Specify which external-customer-id.

lastActiveDatestring (date-time)

To delete all interviews active before this date

Configuration for cleaning interview

deletePiiDataOnlybooleanDefaults to true

Boolean, optional. Flag indicating if this is partial delete, where only PII fields should be removed. Default is true. Note: False is allowed to be used only if this organization has the required setting.

deletionModestring

Specifies the type of deletion to perform.

enumBIOMETRICSPIIFULL
sendNotificationbooleanDefaults to false

Flag indicating to send a notification about a change interview status

relatedEntitiesToKeeparray[string]

List of related entities to be saved. Works only when deletePiiDataOnly=true

enumidentitiesfaceTemplatesimagesstatschatsdeviceFingerPrints

Responses

Response body (application/json)

successboolean

Flag indicating request passed successfully.

sessionStatusstring

Session status

enumAliveClosedDeleted
taskIdstring
statusUristring

Was this page helpful?