Skip to main content

Check List — Guía de API

Usa esta página cuando tu backend deba guardar el mismo playbook que guarda la UI de Smart-Agent. Para el recorrido de producto, ver Check List.

El CRUD de Check List no ejecuta consultas y no gasta créditos. Ejecutar un servicio es una llamada normal al catálogo (la misma URL que ya usas en SmartCheck o Postman).

Autenticación​

Todas las rutas necesitan un JWT de cliente (Authorization: Bearer …). Un token sin clientId responde 403 (Client context required). Las listas pertenecen a ese cliente.

Endpoints​

MétodoRutaReferencia
GET/v2/check-listsListar checklists
POST/v2/check-listsCrear una checklist
GET/v2/check-lists/{id}Obtener una checklist
PUT/v2/check-lists/{id}Actualizar una checklist
DELETE/v2/check-lists/{id}Eliminar una checklist

Parámetros de listado: page, perPage (o limit) y search (o text) para filtrar por nombre. Ver Listar checklists para las dos formas de 200 (con y sin page).

Campos del cuerpo​

CampoSignificado
nameObligatorio al crear. Máximo 150 caracteres.
countriesPaíses donde operas (por ejemplo Colombia).
domainsPestañas opcionales: people, vehicles, businesses.
featureCodesValores code de AppFeature de los servicios en la lista.
statusdraft (predeterminado) o active. Solo etiqueta — ambas funcionan igual.

Los featureCodes desconocidos fallan. Un servicio cuyo país no coincide con la lista falla, salvo que el servicio sea mundial (o la lista aún no tenga países).

Ejemplo de creación​

POST https://api.verifik.co/v2/check-lists
Authorization: Bearer <client-jwt>
Content-Type: application/json
{
  "name": "KYC Colombia",
  "countries": ["Colombia"],
  "domains": [],
  "featureCodes": [],
  "status": "draft"
}

La respuesta es { "data": { …checklist } }. Guarda data._id. Cuando el usuario agregue servicios, haz PUT a ese id con los featureCodes nuevos.

Ejecutar un servicio guardado​

No hay un endpoint “ejecutar checklist”. Por cada código de la lista, llama la URL de catálogo de esa feature como en SmartCheck. Los créditos se cobran en esas llamadas.

Para enviar la mezcla como archivo o cola, usa SmartBatch (país + códigos + nombre). Check List no inicia el lote por ti.

Relacionado​