Obter uma checklist

Carregue uma Check List por id. A lista deve pertencer ao cliente do JWT. Um ObjectId inválido, uma lista inexistente ou uma lista de outro cliente devolve 404.

Esta chamada não executa consultas e não gasta créditos. Use featureCodes do documento para chamar cada API do catálogo você mesmo.

Endpoint

GET https://api.verifik.co/v2/check-lists/{id}

Devolve a lista guardada: name, countries, domains, featureCodes e status. Use esses códigos com as URLs correspondentes do SmartCheck / catálogo. Não há ação de executar checklist neste caminho.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

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

Parameters

Name	Type	Required	Description
id	string	Yes	ObjectId da Check List da criação ou da listagem.

Request

Node.js

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

async function run() {
    const id = "6aa224c87034a338385c28c0";
    const res = await fetch(`https://api.verifik.co/v2/check-lists/${id}`, {
        method: "GET",
        headers: {
            "Content-Type": "application/json",
            Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
        },
    });
    console.log(await res.json());
}

run();

PHP

<?php
$id = "6aa224c87034a338385c28c0";
$ch = curl_init("https://api.verifik.co/v2/check-lists/" . $id);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);

Python

import os, requests

check_list_id = "6aa224c87034a338385c28c0"
url = f"https://api.verifik.co/v2/check-lists/{check_list_id}"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
r = requests.get(url, headers=headers)
print(r.json())

Go

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    id := "6aa224c87034a338385c28c0"
    req, _ := http.NewRequest("GET", "https://api.verifik.co/v2/check-lists/"+id, nil)
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+os.Getenv("VERIFIK_TOKEN"))
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    var out map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&out)
    fmt.Println(out)
}

Response

200

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

403

{
    "message": "Client context required",
    "code": "Forbidden"
}

404

{
    "message": "check_list_not_found",
    "code": "check_list_not_found"
}

Notes

• ObjectIds inválidos e listas de outros clientes devolvem 404 (check_list_not_found).
• A resposta não inclui uma URL de retomada hospedada nem uma URL de lote. A Check List só guarda a combinação.
• Para alterar campos, use Atualizar uma checklist. Para removê-la, use Apagar uma checklist.
• Executar um código de featureCodes é uma chamada normal ao catálogo e gasta créditos aí. Veja SmartCheck.