API reference

Data deletion

Requests to delete applicant data.

List deletion requests

GET/v1/deletion-requests

Scopes
privacy:read

Parameters

FieldTypeRequired
cursorquerystringno
limitqueryintegerno

Responses

  • 200DeletionList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Create a deletion request

POST/v1/deletion-requests

Scopes
privacy:write
Required header
Idempotency-Key

Request bodyDeletionCreate

FieldTypeRequired
applicant_idstring (uuid)yes
scopeenum: all_permitted, raw_media, biometric_templates, specific_evidenceyes
evidence_idsarray of string (uuid)no
basisstringyes
reasonstringyes

Responses

  • 202Deletion
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Get a deletion request

GET/v1/deletion-requests/{deletion_id}

Scopes
privacy:read

Parameters

FieldTypeRequired
deletion_idpathstring (uuid)yes

Responses

  • 200Deletion
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503