https://api.veriko.mx/v1/beneficiaries/imports/{id}/preview Preview de filas extraídas del import
Guía de uso →Devuelve las filas extraídas del archivo, paginadas y filtrables por bucket. CLABEs y celulares se muestran en claro al propietario del job; las tarjetas también van completas en la vista del propietario (la vista admin cross-user las enmascara). Disponible solo cuando el job 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 job de importación. |
buckets[] | query | array<string> | opcional | Filtra por uno o más buckets. Sin este parámetro devuelve todas las filas. Valores fuera del enum se descartan silenciosamente. |
page | query | integer | opcional | Número de página (1-based). Predeterminado: |
per_page | query | integer | opcional | Filas por página (1–100). Predeterminado: |
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/{id}/preview' \
-H 'Authorization: Bearer mxcep_••••'
Ejemplo en Python — próximamente.
Ejemplo en JavaScript — próximamente.
Ejemplo en PHP — próximamente.
| Campo | Tipo | Descripción |
|---|---|---|
type | string | Tipo del recurso JSON:API (siempre `beneficiary_import_row`). |
id | string | ID numérico de la fila expresado como string (formato JSON:API). |
attributes | object | Campos de la fila parseada. |
row_index | integer | Posición 0-based de la fila en el archivo original. Permite al usuario localizar la fila en el documento fuente. |
status | string | Bucket de clasificación: `valid` — lista para commit; `correctable` — corregida automáticamente, confirmable; `fatal` — error no corregible, se omite; `duplicate_account` — cuenta ya registrada (se reactiva si estaba archivada); `duplicate_alias` — alias duplicado, se persiste con sufijo. |
parsed_account | string | null anulable | Número de cuenta normalizado extraído del archivo. El propietario del job puede ver y editar este valor en la vista de preview; `null` si no fue posible extraer una cuenta. |
parsed_account_type | string | null anulable | Tipo de cuenta detectado. `null` si `parsed_account` es nulo. |
parsed_bank_code | string | null anulable | Código Banxico de 5 dígitos del banco receptor derivado de la cuenta parseada. `null` si no pudo resolverse. |
parsed_bank_name | string | null anulable | Nombre del banco receptor resuelto. `null` si no pudo resolverse. |
parsed_label | string | null anulable | Etiqueta/alias extraída del archivo o asignada automáticamente. `null` si no fue posible extraer una etiqueta y no se asignó automáticamente. |
error_codes | array | Códigos de error estables de la fila (p.ej. `clabe_checksum_failed`, `alias_missing`). Vacío para filas `valid`. |
corrections_applied | object | Auto-correcciones que el sistema aplicó a esta fila (p.ej. `{ "alias_auto_assigned": "Proveedor 001" }`). Vacío si no hubo correcciones. |
user_overrides | object | Overrides manuales del usuario enviados via `PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}`. Tienen precedencia sobre los valores parseados en el commit. |
raw_preview | object | Fragmento del archivo original para diagnóstico. Los dígitos de 6 o más caracteres consecutivos aparecen enmascarados (`••••`) para evitar exposición de PANs en payloads de depuración. |
created_beneficiary_id | integer | null anulable | ID del registro de beneficiario creado tras el commit. `null` hasta que el job completó y esta fila fue persistida. |
| Código | Clase | Descripción | Cuerpo |
|---|---|---|---|
| 200 | 2xx | Filas paginadas del preview con metadatos de paginación y snapshot del job. | 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 llamador | Error |
| Código | Clave | Detalle |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | forbidden | You do not have permission to access this resource. Envelope
|