https://api.veriko.mx/v1/beneficiaries/export Export beneficiaries as CSV
How-to guide →Downloads a file with all beneficiary accounts for the authenticated user per the with_archived filter. The CSV includes a brand header, UTF-8 BOM and an "Estado" column (Activa / Archivada) so the file preserves each account's lifecycle. Card and phone numbers are masked in the export: card 4111 •••• •••• 1111, phone ••••5678. CLABEs are exported in full. The ?format parameter selects alternate formats supported by ExportService (csv by default; xlsx/pdf when enabled on the deploy). The filename brand and suffix are generated via BrandFilenameHelper.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
format | query | string | optional | Output format. Default `csv`. Available formats depend on the deploy. Default: |
with_archived | query | string | optional | Tri-state filter: omitted = all; `0` = active only; `1` = archived only. Same contract as `GET /v1/beneficiaries`. |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/export' \
-H 'Authorization: Bearer mxcep_••••'
Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | File with the beneficiary list per the requested filter and format. | No body |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| Header | Type | Description |
|---|---|---|
Content-Disposition | string | Suggested filename generated by `BrandFilenameHelper`. |
Content-Type | string | Varies by `?format`. For CSV: `text/csv; charset=UTF-8` with a UTF-8 BOM at the start of the body. |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|