GEThttps://api.veriko.mx/v1/beneficiaries/imports/{id}/preview

Previsualizar las filas extraídas de la importación

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

Devuelve las filas extraídas del archivo en un trabajo de importación (paginadas y filtrables por grupo).

Responde en cualquier estado del trabajo; antes de preview_ready la lista sale vacía.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
id*pathintegerobligatorio

ID numérico del trabajo de importación.

p. ej. 42
bucketsqueryarray<string>opcional

Qué filas incluir, según cómo quedaron al leer el archivo — valid: Se persiste tal cual; correctable: Tiene un problema que la plataforma sabe arreglar sola; fatal: No se puede aprovechar y se descarta. duplicate_account y duplicate_alias son filas que chocan con un beneficiario que ya existe (por número o por nombre); por número se descarta y por nombre se guarda igual. Sin este filtro se devuelven todas.

p. ej. ["valid","correctable"]
pagequeryintegeropcional

Número de página (1-based).

Predeterminado: 1

p. ej. 1
per_pagequeryintegeropcional

Filas por página (1–100).

Predeterminado: 25

p. ej. 25
Petición
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.

Respuesta 200BeneficiaryImportPreviewResponse — Filas paginadas de la vista previa con metadatos de paginación y instantánea de la importación.
CampoTipoDescripción
dataarray

Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con type, id, attributes).

typestring

Tipo del recurso JSON:API. Siempre beneficiary_import_row.

p. ej. beneficiary_import_row
idstring

Identificador numérico de la fila (expresado como string).

p. ej. 123
attributesobject

Datos de la fila interpretada.

row_indexinteger

Posición de la fila dentro del archivo original, empezando en 0. Permite localizar la fila en el documento original.

p. ej. 5
statusstring

Grupo de clasificación — valid: Lista para confirmación; correctable: Corregida automáticamente; fatal: Error no corregible, se omite; duplicate_account: Cuenta ya registrada (se reactiva si estaba archivada); duplicate_alias: Alias duplicado, se persiste con sufijo.

p. ej. valid
parsed_accountstring | 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; null cuando no fue posible extraer una cuenta.

p. ej. 012180004412345678
parsed_account_typestring | nullanulable

Tipo de cuenta detectado. Los tipos son clabe, card y phone. Además de null cuando parsed_account es nulo.

p. ej. clabe
parsed_bank_codestring | nullanulable

Código SPEI (5 dígitos) del banco resuelto, derivado de \ parsed_account. Es null cuando no pudo resolverse.

p. ej. 40012
parsed_bank_namestring | nullanulable

Nombre oficial del banco resuelto resuelto. Es null cuando no pudo resolverse.

p. ej. BBVA MEXICO
parsed_labelstring | nullanulable

Etiqueta/alias extraída del archivo (o asignada automáticamente). null cuando no fue posible extraer una etiqueta y no se asignó automáticamente.

p. ej. Proveedor ABC
error_codesarray

Códigos de error estables de la fila (p.ej. clabe_checksum_failed, alias_missing). Vacío para filas valid.

p. ej. []
corrections_appliedobject

Auto-correcciones que el sistema aplicó a esta fila (p.ej. { "alias_auto_assigned": "Proveedor 001" }). Vacío si no hubo correcciones.

p. ej. {}
user_overridesobject

Correcciones manuales del usuario enviadas mediante PATCH /v1/beneficiaries/imports/{id}/rows/{rowId}. Tienen precedencia sobre los valores parseados en la confirmación.

p. ej. {}
raw_previewobject

Fragmento del archivo original para diagnóstico. Las series de 13 a 19 dígitos que no son una CLABE (18 dígitos) aparecen enmascaradas (•••• y los últimos cuatro), igual que un número de celular de 10 dígitos cuando lo precede una etiqueta como «cuenta» o «celular», para evitar exposición de números de tarjeta en los cuerpos de depuración.

p. ej. {}
created_beneficiary_idinteger | nullanulable

Identificador numérico del beneficiario creado tras la confirmación. null hasta que la importación completó y esta fila fue persistida.

p. ej. null
metaobject

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.

versionstring

Versión de la API que procesó la petición.

p. ej. 1.47.0
api_versionstring

Versión del prefijo de ruta de la API (ej. v1).

p. ej. v1
request_idstring

Identificador único de la petición (hex).

p. ej. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Descriptor compañero presente en el bloque meta de cada respuesta (y en el meta del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.

p. ej. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Siempre UTC: La zona canónica para cada campo datetime del cuerpo.

p. ej. UTC
format*string

Siempre ISO 8601: Sufijo Z explícito en cada datetime.

p. ej. ISO 8601
linksobject

Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Códigos de respuestaGET /v1/beneficiaries/imports/{id}/preview
CódigoClaseDescripciónCuerpo
2002xxFilas paginadas de la vista previa con metadatos de paginación y instantánea de la importación.BeneficiaryImportPreviewResponse
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4044xxEl recurso no existe o no es visible para el clienteError
Errores de GET /v1/beneficiaries/imports/{id}/preview
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d