Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

📁 Table of Contents

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue

...

The request body allows you to specify the scope of the data to be deleted:

  • PersonalData: This option ensures that all client-related information is erased. This includes forms and media but excludes biometric data. Additionally, for KYB (Know Your Business) purposes, any personal data linked to representatives' identifications will also be removed.

  • BiometricData: Selecting this scope results in the deletion of only biometric information associated with KYC (Know Your Customer) identifications, provided such data exists.

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

Upon initiating a deletion request, processing commences immediately.

...

2️⃣ Monitor data deletion

...

  • Status
    colourBlue
    titleget
    operation on /v1/identity-verifications/{id}, which provides access to detailed redaction information for each event.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#F4F5F7

Key details available include:

Code Block
breakoutModewide
languagejson
{
  "clientId": "Identifier of who initiated the deletion",
  "completedUtc": "Timestamp marking when the event was completed",
  "createdUtc": "Timestamp indicating when the event was created",
  "scope": "[ PersonalData, BiometricData ] - Specifies what type of data is being deleted",
  "source": "[ OnDemand, DataRetentionPolicy ] - 'OnDemand' refers to deletions triggered via this API endpoint; 'DataRetentionPolicy' pertains to future implementation for automated deletions based on predetermined client configuration.",
  "status": "[ InProgress, Completed ] - Indicates current status of redaction"
}

...