DELETE
https://api.veriko.mx/v1/beneficiaries/{id}Archivar un beneficiario
Guía de uso →Archiva la cuenta beneficiaria. El registro no se borra: sale de la lista activa y visible, las validaciones históricas que lo referencian siguen intactas, de modo que archivar un beneficiario no afecta su historial de validaciones.
La operación es reversible. Un alta posterior con el mismo account_number reactiva la cuenta y responde con un estado HTTP 200 (con meta.reactivated=true en el cuerpo).
Los beneficiarios archivados se consultan con GET /v1/beneficiaries?with_archived=1.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | integer | obligatorio | ID numérico del beneficiario. p. ej.42 |
curl -X DELETE 'https://api.veriko.mx/v1/beneficiaries/{id}' \
-H 'Authorization: Bearer veriko_••••' \
-H 'Content-Type: application/json'Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 204 | 2xx | Beneficiario archivado. Sin cuerpo de respuesta. Idempotente — un archive concurrente responde con un estado HTTP 204 sin emitir duplicados. | Sin cuerpo |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| 404 | 4xx | El recurso no existe o no es visible para el cliente | Error |
| Código | Clave | Ejemplo |
|---|---|---|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|
| 403 | forbidden | No tienes permiso para acceder a este recurso. Envelope
|