Skip to main content

Deleting client data

Requirements
  • API key pair
  • scanRef of verification
Verification data deletion endpoint

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/delete

Deleting verification​

Request structure​

Endpoint will remove data from iDenfy's system such as client photos of their document and face, parsed document information, names, surnames, etc.

Only parameter necessary is scanRef of the verification.

Request example​

{
  "scanRef": "350e2420-8850-11e9-baa5-309c231b1bac"
}

Response example​

For successful API calls, which correctly delete all data, there will be no message, just a response with a positive 200 status.

Response - failed​

Failed API calls will return a message identifying the problem.

{
  "message": "Token has not expired yet.",
  "identifier": "PARTNER_ERROR",
  "documentation": "https://documentation.idenfy.com",
  "severity": "NOT_SEVERE"
}
note

Note that in case of a malformed JSON body or API key/secret mismatch you will receive a standard iDenfy API error response. For more on iDenfy API responses visit iDenfy error messages.