GET https://api.veriko.mx/v1/finance/ceps

Descarga masiva de CEPs (ZIP)

Audiencia
public
Autenticación
API key
Permiso
finance:download
Guía de uso →

Genera un archivo ZIP con todos los CEPs disponibles del rango. Cada validación con cep_xml aporta ceps/cep_<id>.xml; las que tienen cep_pdf_path también incluyen ceps/cep_<id>.pdf (los paths fuera del directorio raíz storage/cep se omiten silenciosamente para defense-in-depth). El ZIP incluye manifest.csv (UTF-8 BOM con sección [HEADER]) y manifest.xlsx (versión rica con freeze pane + autofilter) mapeando cada CEP a su validation_id, fecha, clave_rastreo y archivos. Si el rango está vacío responde 404 no_ceps. Si las fechas no son YYYY-MM-DD o to < from responde 400 invalid_range. Acepta API key. Permiso finance:download (NO finance:generate_self). Para descargar el CEP de una sola validación usa GET /v1/validations/{id}/cep; el estado de cuenta mensual con KPIs (sin los XML/PDF) viene de GET /v1/finance/statement.

Parámetros
Parámetro Ubicación Tipo Obligatorio Descripción
from * query string (date) obligatorio

Fecha de inicio (inclusive, `YYYY-MM-DD`).

to * query string (date) obligatorio

Fecha de fin (inclusive, `YYYY-MM-DD`). Debe ser ≥ `from`.

user_id query string (uuid) opcional

Solo para administradores con `finance:generate_all`. UUID del usuario a consultar.

Petición
curl -X GET 'https://api.veriko.mx/v1/finance/ceps' \
  -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/finance/ceps
Código Clase Descripción Cuerpo
200 2xx ZIP con los XML/PDF de CEP y los manifiestos CSV + XLSX. Sin cuerpo
400 4xx `invalid_range` — fechas mal formadas o `to < from`. ErrorResponse
401 4xx Se requiere autenticación o las credenciales son inválidas ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
404 4xx `no_ceps` — el rango no contiene ningún CEP disponible. ErrorResponse
Cabeceras de respuesta 200
Cabecera Tipo Descripción
Cache-Control string Disables intermediary caching de la descarga.
Content-Disposition string Nombre de archivo sugerido para la descarga.
Content-Length integer Tamaño exacto del ZIP en bytes.
Content-Type string
X-Finance-Items integer Número de CEPs incluidos en el ZIP.
Errores de GET /v1/finance/ceps
Código Clave Detalle
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0