Exportar beneficiarios como CSV

GET https://api.veriko.mx/v1/beneficiaries/export

Audiencia: public
Autenticación: API key
Permiso: beneficiaries:read

Descarga un archivo con todas las cuentas beneficiarias del usuario autenticado, según el filtro with_archived. El CSV incluye una cabecera de marca, BOM UTF-8 y la columna "Estado" (Activa / Archivada) para que el archivo conserve el estado de cada cuenta. Los números de tarjeta y celular se enmascaran en el export: tarjeta 4111 •••• •••• 1111, celular ••••5678. Las CLABEs se exportan completas. El parámetro ?format permite seleccionar otros formatos soportados por ExportService (csv por default, también xlsx/pdf si están habilitados en el deploy). La marca y el sufijo se generan vía BrandFilenameHelper.

Parámetros
Parámetro	Ubicación	Tipo	Obligatorio	Descripción
`format`	query	`string`	opcional	Formato del archivo. Default `csv`. Los formatos disponibles dependen del deploy. Predeterminado: `csv`
`with_archived`	query	`string`	opcional	Filtro tri-state: omitido = todas; `0` = solo activas; `1` = solo archivadas. Mismo contrato que `GET /v1/beneficiaries`.

Petición

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/beneficiaries/export' \
  -H 'Authorization: Bearer mxcep_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

**Códigos de respuesta** `GET /v1/beneficiaries/export`
Código	Clase	Descripción	Cuerpo
200	`2xx`	Archivo con la lista de beneficiarios según el filtro y formato solicitados.	Sin cuerpo
401	`4xx`	Se requiere autenticación o las credenciales son inválidas	`ErrorResponse`
403	`4xx`	Permisos insuficientes	`ErrorResponse`

**Cabeceras de respuesta** `200`
Cabecera	Tipo	Descripción
`Content-Disposition`	`string`	Sugerencia de nombre de archivo generada por `BrandFilenameHelper`.
`Content-Type`	`string`	Varía según `?format`. Para CSV: `text/csv; charset=UTF-8` con BOM UTF-8 al inicio del cuerpo.

**Errores de `GET /v1/beneficiaries/export`**
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`