DELETE
https://api.veriko.mx/v1/beneficiaries/{id} Archive a beneficiary
How-to guide →Archives (soft-deletes) the beneficiary account: the record moves to status=inactive but is not deleted. Associated historical validations remain intact. A subsequent creation with the same account_number via POST /v1/beneficiaries reactivates the account (200 response with meta.reactivated=true). To list only archived rows use GET /v1/beneficiaries?with_archived=1.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id * | path | integer | required | Numeric beneficiary ID. |
curl -X DELETE 'https://api.veriko.mx/v1/beneficiaries/{id}' \
-H 'Authorization: Bearer mxcep_••••' \
-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 | Permisos insuficientes | ErrorResponse |
| 404 | 4xx | The resource does not exist or is not visible to the caller | Error |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|