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

Export beneficiaries as CSV

Audience
public
Auth
API key
Permission
beneficiaries:read
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.

Parameters
ParameterInTypeRequiredDescription
formatquerystringoptional

Output format. csv by default; xlsx produces a spreadsheet. Any other value is served as csv.

Default: csv

e.g. csv
limitqueryintegeroptional

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_archivedquerystringoptional

Tri-state filter: omitted = all; 0 = active only; 1 = archived only. Same contract as GET /v1/beneficiaries.

e.g. 0
Request
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.

Response status codesGET /v1/beneficiaries/export
StatusClassDescriptionBody
2002xxFile with the beneficiary list per the requested filter and format.No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Response headers200
HeaderTypeDescription
Content-DispositionstringSuggested filename generated by BrandFilenameHelper.
Content-TypestringVaries by ?format. For CSV: text/csv; charset=UTF-8 with a UTF-8 BOM at the start of the body.
Errors from GET /v1/beneficiaries/export
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0