Management API: Erase a Visitor

Erase a visitor when somebody asks you to delete their data. This is Erase this visitor on an event in the dashboard, from code, so a deletion request your own systems handle can reach Fingerly too. Only admin management keys can erase; a developer key answers 403.

Path parameter

organization_idstringrequired
Your organization, from Describe the key. A path naming any other organization answers 404.

Erase a visitor

DELETE/api/v1/management/organizations/{organization_id}/visitors/{visitor_id} Management key

Path parameter

visitor_idstringrequired
The visitor_id from an identification.

Answers 202 with the erasure. What happens, and when:

At once: the visitor's identity, so a device that comes back is a new visitor, and the webhook events that name it, including ones not yet delivered.
Within the hour: its stored identifications, their deferred reports and its archived submissions.
Kept: totals already folded into your dashboards, which hold no visitor ID.

Asking again while an erasure is pending returns that one. A visitor ID your organization never saw is accepted and erases nothing, so an erasure is safe to send for any ID a person gives you.

List visitor erasures

GET/api/v1/management/organizations/{organization_id}/visitor-erasures Management key

The last hundred erasures, newest first.

Response

erasuresVisitorErasure[]
Each erasure.
5 child fields
- idstring
  The erasure's ID.
- visitor_idstring
  The visitor it erases.
- statusstring
  pending while stored events and archived submissions are being removed, then done.
- requested_atstring
  When it was asked for. The visitor's identity was removed at this moment.
- completed_atstring
  When everything else was removed. Omitted while pending.

Errors

Status	Code	When
`403`	`insufficient_role`	The key is a developer key.
`422`	`invalid_visitor_id`	The ID is not a visitor ID: visitor IDs are 20 letters and digits.