Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

To facilitate the secure deletion of personal and/or biometric data, please utilize the following IDV API endpoint:

  • PUT /v1/identity-verifications/{id}/redact, where {id} signifies the specific IDV (Identity Verification) identification id.

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.


Upon initiating a deletion request, processing commences immediately. To monitor the status of your requests, execute a GET operation on /v1/identity-verifications/{id}, which provides access to detailed redaction information for each event. Key details available include:

{
  "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"
}

This approach ensures both compliance with privacy regulations and protection of individual privacy by offering precise control over personal and biometric information management.


  • No labels