DELETE https://api.veriko.mx/v1/beneficiaries/{id}

Archivar un beneficiario

Audiencia
public
Autenticación
API key
Permiso
beneficiaries:delete
Guía de uso →

Archiva (soft-delete) la cuenta beneficiaria: el registro pasa a status=inactive pero no se borra. Las validaciones históricas asociadas permanecen intactas. Una creación posterior con el mismo account_number vía POST /v1/beneficiaries reactivará la cuenta (respuesta 200 con meta.reactivated=true). Para listar solo las archivadas usa GET /v1/beneficiaries?with_archived=1.

Parámetros
Parámetro Ubicación Tipo Obligatorio Descripción
id * path integer obligatorio

ID numérico del beneficiario.

Petición
curl -X DELETE 'https://api.veriko.mx/v1/beneficiaries/{id}' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuesta DELETE /v1/beneficiaries/{id}
Código Clase Descripción Cuerpo
204 2xx Beneficiario archivado. Sin cuerpo de respuesta. Idempotente — un archive concurrente devuelve 204 sin emitir auditoría duplicada. 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 llamador Error
Errores de DELETE /v1/beneficiaries/{id}
Código Clave Detalle
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0