GEThttps://api.veriko.mx/v1/beneficiaries/imports/template

Download bulk import template

Audience
public
Auth
API key
Permission
beneficiaries:create
How-to guide →

Returns a template file in the requested format, with headers in Spanish or English and example rows for CLABE, card and DiMo phone. Serves as a starting point for the bulk import. Header language is negotiated with the Accept-Language header; Spanish is served by default. The import parser then accepts headers in both languages accent-insensitively.

Parameters
ParameterInTypeRequiredDescription
format*querystringrequired

Format of the downloaded template. csv, xls, xlsx, and txt carry the expected columns ready to fill in; json carries the same shape for generating the file from a program.

e.g. csv
Request
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/template' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response status codesGET /v1/beneficiaries/imports/template
StatusClassDescriptionBody
2002xxGenerated template file. Content-Type varies by format (text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel, text/plain, application/json).No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
4224xxinvalid_format — the requested format is not supported.ErrorResponse
Response headers200
HeaderTypeDescription
Content-DispositionstringSuggested download filename.
Content-TypestringVaries by ?format (CSV / XLSX / XLS / TXT / JSON).
Errors from GET /v1/beneficiaries/imports/template
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
422invalid_format

Format must be one of: csv, xlsx, xls, txt, json

Envelope
meta.request_id
c5d6e7f8a9b0