DELETEhttps://api.veriko.mx/v1/beneficiaries/{id}

Archive a beneficiary

Audience
public
Auth
API key
Permission
beneficiaries:delete
How-to guide →

Archives the beneficiary account. The record is not deleted: it leaves the active list and the historical validations referencing it stay intact, so archiving leaves no gaps in the history. The operation is reversible without coming back here. A later registration 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.

Parameters
ParameterInTypeRequiredDescription
id*pathintegerrequired

Numeric beneficiary ID.

e.g. 42
Request
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.

Response status codesDELETE /v1/beneficiaries/{id}
StatusClassDescriptionBody
2042xxBeneficiary archived. No response body. Idempotent — a concurrent archive returns 204 without emitting a duplicate audit entry.No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
4044xxThe resource does not exist or is not visible to the clientError
Errors from DELETE /v1/beneficiaries/{id}
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0