Exportar los beneficiarios de la cuenta

GEThttps://api.veriko.mx/v1/beneficiaries/export

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

Descarga las cuentas beneficiarias del usuario autenticado como archivo, usa el mismo filtro with_archived que GET /v1/beneficiaries/list-beneficiaries.

El formato de descarga se elige con ?format (csv por defecto, xlsx como alternativa). El tope de filas es de 100 000, y ?limit sirve para pedir menos, nunca más.

Los números de cuenta salen enmascarados (salvo la CLABE): Una tarjeta se exporta como 4111 •••• •••• 1111 y un celular como ••••5678; la CLABE se exporta completa. El criterio y el resto de las superficies enmascaradas están en el enmascarado de datos.

Parámetros
Parámetro	Ubicación	Tipo	Obligatorio	Descripción
`format`	query	`string`	opcional	Formato del archivo. `csv` por defecto; `xlsx` produce una hoja de cálculo. Cualquier otro valor se sirve como `csv`. Predeterminado: `csv` p. ej. `csv`
`limit`	query	`integer`	opcional	Recorta el número de filas del archivo. Solo baja el tope: un valor mayor que 100 000, o menor que 1, deja el tope por defecto. p. ej. `500`
`with_archived`	query	`string`	opcional	Filtro tri-state: omitido = todas; `0` = solo activas; `1` = solo archivadas. p. ej. `0`

Petición

cURLPython•JavaScript•PHP•

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

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	Ejemplo
401	`unauthorized`	Credenciales de autenticación ausentes o inválidas. Envelope meta.request_id `c4d5e6f7a8b9`
403	`forbidden`	No tienes permiso para acceder a este recurso. Envelope meta.request_id `d5e6f7a8b9c0`