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.

El endpoint admite sondeo 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

Datos del trabajo de importación.

plan_capobject

Cupo de beneficiarios activos del plan y ocupación actual de la cuenta autenticada.

maxinteger

Tope de beneficiarios activos. -1 significa sin tope.

currentinteger

Cantidad de beneficiarios activos guardados, independientemente del filtro de archivados.

requiredinteger

Cantidad de lugares necesarios para crear o reactivar cuentas del trabajo de importación.

exceededboolean

true cuando el trabajo de importación necesita lugares nuevos y supera el cupo disponible.

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, json o pdf.

p. ej. csv
parse_modestring

Modo de lectura del archivo — template: Respeta los encabezados canónicos; free: Formato libre, el sistema deduce la estructura.

p. ej. template
total_rowsinteger

Cantidad de filas extraídas del archivo. Sólo disponible cuando el estado es preview_ready o posterior.

p. ej. 150
valid_countinteger

Cantidad de filas sin errores, listas para la confirmación.

p. ej. 120
correctable_countinteger

Cantidad de filas con errores que admiten corrección. Se persisten salvo que el usuario las rechace.

p. ej. 20
fatal_countinteger

Cantidad de filas que no pueden procesarse con sus datos actuales. No se persisten y se omiten de la confirmación.

p. ej. 5
duplicate_countinteger

Cantidad de filas detectadas como duplicadas dentro del trabajo. Las de duplicate_account se omiten de la confirmación, salvo que la cuenta esté archivada, en cuyo caso se reactiva; las de duplicate_alias se persisten con un sufijo en el 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

Cantidad de filas omitidas durante la ejecución del trabajo. Son las fatales y las duplicate_account sin reactivación posible.

p. ej. 10
llm_invokedboolean

true cuando 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 fallo del trabajo. null cuando no terminó en failed. Por ejemplo, file_corrupt o empty_file.

p. ej. null
error_summarystring | nullanulable

Resumen legible del fallo del trabajo. null cuando no terminó en failed. Los números de tarjeta aparecen enmascarados.

p. ej. null
created_atstring (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

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

Fecha y hora del fin de la lectura del archivo, en ISO 8601 UTC. null mientras no haya terminado.

p. ej. null
committed_atstring | nullanulable

Fecha y hora del inicio de la confirmación, en ISO 8601 UTC. null mientras no se haya confirmado.

p. ej. null
completed_atstring | nullanulable

Fecha y hora de la finalización, en ISO 8601 UTC. null mientras no haya terminado.

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}
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
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d