Skip to main content

Criar uma checklist

Crie uma Check List no cliente autenticado. name é obrigatório. Países, domínios e códigos de feature são opcionais na criação — você pode adicionar serviços depois com Atualizar uma checklist.

Guardar a lista não executa consultas e não gasta créditos. No Smart-Agent, criar leva você de volta ao painel; esta API devolve o documento novo de imediato.

Endpoint

POST https://api.verifik.co/v2/check-lists

Cria uma lista do cliente do JWT. O objeto data da resposta inclui _id — guarde-o para as chamadas GET, PUT e DELETE posteriores. O status padrão é draft.

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

O token deve ser um JWT de cliente. Um token sem clientId devolve 403.

Body

NameTypeRequiredDescription
namestringYesNome visível. Recortado, 1–150 caracteres.
countriesstring[]NoNomes dos países onde você opera (por exemplo Colombia). Duplicados são removidos. Padrão [].
domainsstring[]NoAbas opcionais: people, vehicles, businesses. Padrão [].
featureCodesstring[]NoValores code de AppFeature a guardar na lista. Padrão [].
statusstringNodraft (padrão) ou active. Só rótulo de organização — as duas funcionam igual.

featureCodes desconhecidos falham. Um serviço cujo país não coincide com countries falha, salvo se o serviço for mundial ou countries estiver vazio.

Request

const fetch = require("node-fetch");

async function run() {
const res = await fetch("https://api.verifik.co/v2/check-lists", {
method: "POST",
headers: {
"Content-Type": "application/json",
Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
},
body: JSON.stringify({
name: "KYC Colombia",
countries: ["Colombia"],
domains: [],
featureCodes: [],
status: "draft",
}),
});
console.log(await res.json());
}

run();

Response

{
"data": {
"_id": "6aa224c87034a338385c28c0",
"client": "507f1f77bcf86cd799439013",
"name": "KYC Colombia",
"countries": ["Colombia"],
"domains": [],
"featureCodes": [],
"status": "draft",
"createdAt": "2026-09-10T03:32:00.000Z",
"updatedAt": "2026-09-10T03:32:00.000Z"
}
}

Notes

  • name é o único campo obrigatório. Você pode criar uma lista vazia e adicionar featureCodes depois.
  • Os países são guardados como você os envia (por exemplo Colombia). Não são códigos ISO.
  • status não altera o comportamento do servidor. Listas em rascunho e ativas funcionam igual.
  • Valores de domains desconhecidos falham na validação. Valores permitidos: people, vehicles, businesses.
  • Criar uma lista não gasta créditos. Executar um serviço guardado é uma chamada normal ao catálogo.
  • Não existe um endpoint para executar a checklist. Veja Check List e SmartBatch.