DELETE
https://api.veriko.mx/v1/beneficiaries/{id}Archive a beneficiary
How-to guide →Archives the beneficiary account. The record is not deleted: it leaves the active, visible list, and the historical validations referencing it stay intact, so archiving a beneficiary does not affect its validation history.
The operation is reversible. A later registration with the same account_number reactivates the account and responds with HTTP status 200, with meta.reactivated=true in the body.
Archived beneficiaries are listed with GET /v1/beneficiaries?with_archived=1.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id* | path | integer | required | Numeric beneficiary ID. e.g.42 |
curl -X DELETE 'https://api.veriko.mx/v1/beneficiaries/{id}' \
-H 'Authorization: Bearer veriko_••••' \
-H 'Content-Type: application/json'Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Status | Class | Description | Body |
|---|---|---|---|
| 204 | 2xx | Beneficiary archived. No response body. Idempotent — a concurrent archive returns 204 without emitting a duplicate audit entry. | No body |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 403 | 4xx | Insufficient permissions. | ErrorResponse |
| 404 | 4xx | The resource does not exist or is not visible to the client | Error |
| Status | Code | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | permission_denied | You do not have permission to access this resource. Envelope
|