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

Consultar el estado de una importación

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

Devuelve el estado de un trabajo de importación y sus contadores por grupo: valid, correctable, fatal, duplicate_account (sumados en duplicate_count) y committed/skipped tras la confirmación.

Puedes sondear este endpoint cada ~2s hasta que status sea preview_ready, completed, failed o cancelled.

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

ID numérico del trabajo de importación.

p. ej. 42
Petición
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/{id}' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200BeneficiaryImportJobResponse — Estado actual de la importación con contadores por grupo.
CampoTipoDescripción
dataobject

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).

p. ej. beneficiary_import
idstring

Identificador numérico del trabajo de importación (expresado como string).

p. ej. 42
attributesobject

Campos de la importación.

statusstring

Estado del trabajo de importación — pending: Subido y en espera de parseo; parsing: En proceso de extracción de filas; preview_ready: Listo para revisión del usuario; committing: Persistiendo filas confirmadas; completed: Importación completada; failed: Fallo no recuperable (ver error_code); cancelled: Cancelado por el usuario.

p. ej. preview_ready
file_formatstring

Formato del archivo subido. Aceptados: csv, xls, xlsx, txt o pdf.

p. ej. csv
parse_modestring

Modo de parseo — template: Formato de columnas fijo (plantilla descargable); free: Formato libre, el sistema deduce la estructura.

p. ej. template
total_rowsinteger

Total de filas extraídas del archivo (solo disponible una vez que el estado es preview_ready o posterior).

p. ej. 150
valid_countinteger

Conteo de filas sin errores, listas para confirmación de persistencia.

p. ej. 120
correctable_countinteger

Filas con correcciones automáticas aplicadas. Se persisten salvo que el usuario las rechace.

p. ej. 20
fatal_countinteger

Filas con errores no corregibles automáticamente. No se persisten y se omiten de la confirmación.

p. ej. 5
duplicate_countinteger

Suma de filas duplicate_account y duplicate_alias. Las filas con duplicate_account se omiten de la confirmación salvo que la cuenta esté archivada (en cuyo caso se reactiva); las duplicate_alias se persisten con sufijo de alias.

p. ej. 5
committed_countinteger

Filas efectivamente persistidas en la lista de beneficiarios (solo disponible una vez que el estado es completed).

p. ej. 140
skipped_countinteger

Filas no persistidas (fatales o duplicate_account sin reactivación posible).

p. ej. 10
llm_invokedboolean

true si el motor de IA (LLM) se utilizó durante el parseo para resolver filas ambiguas en modo libre.

p. ej. false
error_codestring | nullanulable

Código estable del error cuando status=failed (p.ej. file_corrupt, plan_cap_exceeded). null en estados no fallidos.

p. ej. null
error_summarystring | nullanulable

Mensaje diagnóstico legible cuando status=failed. Los números de tarjeta (PANs) aparecen enmascarados en este campo.

p. ej. null
created_atstring (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito. Ejemplo: "2026-05-01T05:14:38Z". Cada campo *_at, *_end, *_start, *_date de la API usa esta forma. El descriptor compañero en meta.datetime permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El new Date(value) nativo del navegador, el datetime.fromisoformat (≥3.11) de Python y el time.Parse(time.RFC3339) de Go parsean este formato directamente.

p. ej. 2026-05-01T05:14:38Z
parsed_atstring | nullanulable

Timestamp (ISO 8601 UTC) de finalización del parseo. null hasta que el parseo completa.

p. ej. null
committed_atstring | nullanulable

Timestamp (ISO 8601 UTC) del inicio de la confirmación. null hasta que la confirmación comienza.

p. ej. null
completed_atstring | nullanulable

Timestamp (ISO 8601 UTC) de finalización de la importación. null mientras la importación no ha completado.

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. a1b2c3d4e5f6
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}
CódigoClaseDescripciónCuerpo
2002xxEstado actual de la importación con contadores por grupo.BeneficiaryImportJobResponse
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}
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0