https://api.veriko.mx/v1/beneficiaries/exportExport beneficiaries as CSV
How-to guide →Downloads the beneficiary accounts of the authenticated account as a file, under the same with_archived filter as the list. The file carries a brand header, a UTF-8 BOM, and a "Status" column — Active or Archived — so each account's state survives the download. Numbers come out masked except the CLABE. A card is exported as 4111 •••• •••• 1111 and a phone as ••••5678; the CLABE is exported in full. The criterion, and the other masked surfaces, are covered in data masking. The format is chosen with ?format: csv by default, xlsx as the alternative. The row cap is 100,000, and ?limit asks for fewer — never more — which is what the panel's download uses to preview a short file.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
format | query | string | optional | Output format. Default: csv |
limit | query | integer | optional | Trims the number of rows in the file. It only lowers the cap: a value above 100,000, or below 1, leaves the default cap in place. e.g.500 |
with_archived | query | string | optional | Tri-state filter: omitted = all; 0 |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/export' \
-H 'Authorization: Bearer veriko_••••'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 | Insufficient permissions. | 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 | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|