https://api.veriko.mx/v1/beneficiaries/imports/{id}/previewPrevisualizar las filas extraídas de la importación
Guía de uso →Devuelve las filas extraídas del archivo en un trabajo de importación (paginadas y filtrables por grupo).
Disponible solo cuando la importación está en preview_ready o estados posteriores con total_rows>0.
| Parámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | integer | obligatorio | ID numérico del trabajo de importación. p. ej.42 |
buckets | query | array<string> | opcional | Qué filas incluir, según cómo quedaron al leer el archivo — ["valid","correctable"] |
page | query | integer | opcional | Número de página (1-based). Predeterminado: 1 |
per_page | query | integer | opcional | Filas por página (1–100). Predeterminado: 25 |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/preview' \
-H 'Authorization: Bearer veriko_••••'Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
data | array | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con |
type | string | Tipo del recurso JSON:API (siempre beneficiary_import_row |
id | string | Identificador numérico de la fila (expresado como string). p. ej.123 |
attributes | object | Campos de la fila analizada. |
row_index | integer | Posición (desde el 0) de la fila en el archivo original. Permite al usuario localizar la fila en el documento fuente. p. ej.5 |
status | string | Grupo de clasificación — valid |
parsed_account | string | nullanulable | Número de cuenta extraído del archivo (normalizado). El propietario de la importación puede ver y editar este valor en la vista de vista previa; 012180004412345678 |
parsed_account_type | string | nullanulable | Tipo de cuenta detectado. Los tipos son clabe |
parsed_bank_code | string | nullanulable | Código SPEI (5 dígitos) del banco resuelto, derivado de 40012 |
parsed_bank_name | string | nullanulable | Nombre oficial del banco resuelto resuelto. Es BBVA MEXICO |
parsed_label | string | nullanulable | Etiqueta/alias extraída del archivo (o asignada automáticamente). Proveedor ABC |
error_codes | array | Códigos de error estables de la fila (p.ej. [] |
corrections_applied | object | Auto-correcciones que el sistema aplicó a esta fila (p.ej. {} |
user_overrides | object | Correcciones manuales del usuario enviadas mediante {} |
raw_preview | object | Fragmento del archivo original para diagnóstico. Los dígitos de 6 o más caracteres consecutivos aparecen enmascarados ( {} |
created_beneficiary_id | integer | nullanulable | Identificador numérico del beneficiario creado tras la confirmación. null |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. p. ej.1.47.0 |
api_version | string | Versión del prefijo de ruta de la API (ej. v1 |
request_id | string | Identificador único de la petición (hex). p. ej.a1b2c3d4e5f6 |
datetime | object | Descriptor compañero presente en el bloque {"timezone":"UTC","format":"ISO 8601"} |
timezone* | string | Siempre UTC |
format* | string | Siempre ISO 8601 |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Filas paginadas de la vista previa con metadatos de paginación y instantánea de la importación. | BeneficiaryImportPreviewResponse |
| 401 | 4xx | Se requiere autenticación o las credenciales son inválidas | ErrorResponse |
| 403 | 4xx | Permisos insuficientes | ErrorResponse |
| 404 | 4xx | El recurso no existe o no es visible para el cliente | Error |
| Código | Clave | Ejemplo |
|---|---|---|
| 401 | unauthorized | Credenciales de autenticación ausentes o inválidas. Envelope
|
| 403 | forbidden | No tienes permiso para acceder a este recurso. Envelope
|