https://api.veriko.mx/v1/beneficiaries/imports/template Download bulk import template
How-to guide →Returns a template file in the requested format with headers in the user's language (ES or EN, per the app_lang cookie) and example rows for CLABE, card and DiMo phone. Serves as a starting point for the bulk import. The import parser accepts headers in both languages accent-insensitively. Cookie-only. The endpoint requires session-cookie authentication — API keys receive 401 unauthorized even when they have the permission. This isolates the template flow to the user dashboard.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
format * | query | string | required | Template file format. |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/template' \
-H 'Authorization: Bearer mxcep_••••'
Python example — coming soon.
JavaScript example — coming soon.
PHP example — coming soon.
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | Generated 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 |
| 401 | 4xx | Not authenticated or caller using an API key. Templates are cookie-only — API keys receive 401 even with the `beneficiaries:create` permission. | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| 422 | 4xx | `invalid_format` — the requested format is not supported. | ErrorResponse |
| Header | Type | Description |
|---|---|---|
Content-Disposition | string | Suggested download filename. |
Content-Type | string | Varies by `?format` (CSV / XLSX / XLS / TXT / JSON). |
| Status | Code | Detail |
|---|---|---|
| 401 | unauthorized | This endpoint requires cookie authentication. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|
| 422 | invalid_format | Format must be one of: csv, xlsx, xls, txt, json Envelope
|