Skip to main content

Check List — Guia da API

Use esta página quando o seu backend deve guardar o mesmo playbook que a UI do Smart-Agent. Para o percurso de produto, veja Check List.

O CRUD da Check List não executa consultas e não gasta créditos. Executar um serviço é uma chamada normal ao catálogo (a mesma URL que você já usa no SmartCheck ou no Postman).

Autenticação​

Todas as rotas precisam de um JWT de cliente (Authorization: Bearer …). Um token sem clientId devolve 403 (Client context required). As listas pertencem a esse cliente.

Endpoints​

MétodoCaminhoFunção
GET/v2/check-listsListar checklists
POST/v2/check-listsCriar uma checklist
GET/v2/check-lists/{id}Obter uma checklist
PUT/v2/check-lists/{id}Atualizar uma checklist
DELETE/v2/check-lists/{id}Apagar uma checklist

Parâmetros de lista: page, perPage (ou limit) e search (ou text) para filtrar por nome. Veja Listar checklists para as duas formas de 200 (com e sem page).

Campos do corpo​

CampoSignificado
nameObrigatório na criação. Máx. 150 caracteres.
countriesPaíses onde você opera (por exemplo Colombia).
domainsAbas opcionais: people, vehicles, businesses.
featureCodesValores code de AppFeature dos serviços da lista.
statusdraft (padrão) ou active. Só rótulo — as duas funcionam igual.

featureCodes desconhecidos falham. Um serviço cujo país não coincide com a lista falha, salvo se for mundial (ou se a lista ainda não tiver países).

Exemplo de criação​

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"
}

A resposta é { "data": { …checklist } }. Guarde data._id. Quando o utilizador adicionar serviços, faça PUT nesse id com os novos featureCodes.

Executar um serviço guardado​

Não existe um endpoint “executar checklist”. Para cada código da lista, chame a URL de catálogo dessa feature como no SmartCheck. Os créditos entram nessas chamadas.

Para enviar a combinação como arquivo ou fila, use SmartBatch (país + códigos + nome). A Check List não inicia o lote.

Relacionado​