https://api.veriko.mx/v1/beneficiaries/imports/{id}Consultar el estado de una importación
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ámetro | Ubicación | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
id* | path | integer | obligatorio | ID numérico del trabajo de importación. p. ej.42 |
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.
| Campo | Tipo | Descripción |
|---|---|---|
data | object | 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 |
id | string | Identificador numérico del trabajo de importación (expresado como string). p. ej.42 |
attributes | object | Datos del trabajo de importación. |
plan_cap | object | Cupo de beneficiarios activos del plan y ocupación actual de la cuenta autenticada. |
max | integer | Tope de beneficiarios activos. |
current | integer | Cantidad de beneficiarios activos guardados, independientemente del filtro de archivados. |
required | integer | Cantidad de lugares necesarios para crear o reactivar cuentas del trabajo de importación. |
exceeded | boolean |
|
status | string | Estado del trabajo de importación — preview_ready |
file_format | string | Formato del archivo subido. Aceptados: csv |
parse_mode | string | Modo de lectura del archivo — template |
total_rows | integer | Cantidad de filas extraídas del archivo. Sólo disponible cuando el estado es 150 |
valid_count | integer | Cantidad de filas sin errores, listas para la confirmación. p. ej.120 |
correctable_count | integer | Cantidad de filas con errores que admiten corrección. Se persisten salvo que el usuario las rechace. p. ej.20 |
fatal_count | integer | 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_count | integer | Cantidad de filas detectadas como duplicadas dentro del trabajo. Las de 5 |
committed_count | integer | Filas efectivamente persistidas en la lista de beneficiarios (solo disponible una vez que el estado es 140 |
skipped_count | integer | Cantidad de filas omitidas durante la ejecución del trabajo. Son las fatales y las 10 |
llm_invoked | boolean |
false |
error_code | string | nullanulable | Código estable del fallo del trabajo. null |
error_summary | string | nullanulable | Resumen legible del fallo del trabajo. null |
created_at | string (date-time) | Timestamp ISO 8601 en UTC con sufijo 2026-05-01T05:14:38Z |
parsed_at | string | nullanulable | Fecha y hora del fin de la lectura del archivo, en ISO 8601 UTC. null |
committed_at | string | nullanulable | Fecha y hora del inicio de la confirmación, en ISO 8601 UTC. null |
completed_at | string | nullanulable | Fecha y hora de la finalización, en ISO 8601 UTC. 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.a1b2c3d4e5f66f5e4d3c2b1a |
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 | Estado actual de la importación con contadores por grupo. | BeneficiaryImportJobResponse |
| 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 | permission_denied | No tienes permiso para acceder a este recurso. Envelope
|