Skip to main content
POST
identity.verification.delete

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by identity.verification.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
eraseBiometrics
boolean

True also purges every retained face template of the person before deleting the verification. Leave it out to delete the verification and let the account's own retention policy decide about face data.

Response

The result

deleted
boolean
required

The verification was deleted, permanently.

biometrics
string
required

What happened to the face data: deleted with the verification, retained as an image-free template under the account's policy, or none (the verification had no face data).