Delete Identification
Permanently deletes an identification and all associated data.
warning
This action cannot be undone. Ensure you have downloaded any required data before deletion.
Endpoint
DELETE /api/v1/{customer}/identifications/{transaction-number}
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customer | string | Yes | Your company identifier |
transaction-number | string | Yes | Transaction identifier |
Request
Headers
| Header | Type | Required | Description |
|---|---|---|---|
X-API-LOGIN-TOKEN | string | Yes | Auth token for authentication |
Response
{
"message": "Identification deleted successfully",
"deletedAt": "2024-03-21T11:00:00Z"
}
Archive Identification
As an alternative to deletion, an identification can be archived. Archiving retains the identification data without making it active, which can be useful for audit or compliance purposes.
note
This feature is not enabled by default. Contact IDnow to have it enabled for your account.
Endpoint
POST /api/v1/{customer}/identifications/{transaction-number}/archive
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customer | string | Yes | Your company identifier |
transaction-number | string | Yes | Transaction identifier |
Request
Headers
| Header | Type | Required | Description |
|---|---|---|---|
X-API-LOGIN-TOKEN | string | Yes | Auth token for authentication |
note
This endpoint has no request body.