GET https://api.veriko.mx/v1/beneficiaries/imports/template

Descargar plantilla de importación masiva

Audiencia
public
Autenticación
API key
Permiso
beneficiaries:create
Guía de uso →

Devuelve un archivo plantilla en el formato solicitado con encabezados en el idioma del usuario (ES o EN, según la cookie app_lang) y filas de ejemplo para CLABE, tarjeta y celular DiMo. Sirve de punto de partida para la importación masiva. El parser de importación acepta encabezados en ambos idiomas de forma insensible a acentos. Cookie-only. El endpoint exige autenticación por cookie de sesión — los API keys reciben 401 unauthorized aunque tengan el permiso. Esto aísla el flujo de plantillas al dashboard del usuario.

Parámetros
Parámetro Ubicación Tipo Obligatorio Descripción
format * query string obligatorio

Formato del archivo de plantilla.

Petición
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/template' \
  -H 'Authorization: Bearer mxcep_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuesta GET /v1/beneficiaries/imports/template
Código Clase Descripción Cuerpo
200 2xx Archivo plantilla generado. El `Content-Type` varía por formato (`text/csv`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/vnd.ms-excel`, `text/plain`, `application/json`). Sin cuerpo
401 4xx Sin autenticación o caller usando API key. Las plantillas son cookie-only — los API keys reciben 401 incluso con el permiso `beneficiaries:create`. ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
422 4xx `invalid_format` — el formato solicitado no está soportado. ErrorResponse
Cabeceras de respuesta 200
Cabecera Tipo Descripción
Content-Disposition string Sugerencia de nombre de archivo para descarga.
Content-Type string Varía según `?format` (CSV / XLSX / XLS / TXT / JSON).
Errores de GET /v1/beneficiaries/imports/template
Código Clave Detalle
401 unauthorized

This endpoint requires cookie authentication.

Envelope
meta.request_id
b4c5d6e7f8a9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
422 invalid_format

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

Envelope
meta.request_id
c5d6e7f8a9b0