Atualizar uma checklist

Atualize uma Check List sua. Envie só os campos que quer alterar. Os campos omitidos mantêm os valores atuais. O documento resultante é revalidado, por isso name ainda deve estar presente depois da fusão.

Guardar as alterações não executa consultas e não gasta créditos. No Smart-Agent, os países ficam bloqueados depois da criação — esta API ainda aceita um novo array countries se você o enviar.

Endpoint

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

Devolve a lista atualizada. Use isto quando o utilizador adicionar ou remover serviços (featureCodes), alterar o nome ou definir status. Ids inválidos e listas de outros clientes devolvem 404.

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.

Body

Todos os campos são opcionais no pedido. Depois da fusão, name continua obrigatório.

Name	Type	Required	Description
name	string	No	Nome visível. Recortado, 1–150 caracteres.
countries	string[]	No	Nomes dos países. Substitui a lista guardada quando enviado.
domains	string[]	No	people, vehicles e/ou businesses. Substitui a lista guardada quando enviado.
featureCodes	string[]	No	Valores code de AppFeature. Substitui a lista guardada quando enviado.
status	string	No	draft ou active. Só rótulo de organização.

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

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: "PUT",
        headers: {
            "Content-Type": "application/json",
            Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
        },
        body: JSON.stringify({
            featureCodes: ["co-cedula", "cl-rut"],
            domains: ["people"],
        }),
    });
    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_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "featureCodes" => ["co-cedula", "cl-rut"],
    "domains" => ["people"]
]));
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')}"
}
payload = {
    "featureCodes": ["co-cedula", "cl-rut"],
    "domains": ["people"],
}
r = requests.put(url, json=payload, headers=headers)
print(r.json())

Go

package main

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

func main() {
    id := "6aa224c87034a338385c28c0"
    body, _ := json.Marshal(map[string]interface{}{
        "featureCodes": []string{"co-cedula", "cl-rut"},
        "domains":      []string{"people"},
    })
    req, _ := http.NewRequest("PUT", "https://api.verifik.co/v2/check-lists/"+id, bytes.NewReader(body))
    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"],
        "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"
}

409

{
    "message": "\"name\" is required",
    "code": "ValidationError"
}

409 invalid feature

{
    "message": "check_list_invalid_feature",
    "code": "check_list_invalid_feature"
}

409 country mismatch

{
    "message": "check_list_feature_country_mismatch",
    "code": "check_list_feature_country_mismatch"
}

Notes

• Os campos omitidos mantêm os valores atuais. Enviar featureCodes substitui o array inteiro — não é uma fusão parcial dos códigos.
• Depois da fusão, o Joi ainda exige name. Limpar o nome falha com ValidationError.
• featureCodes desconhecidos devolvem 409 (check_list_invalid_feature).
• Uma feature cujo país está fora do countries resultante devolve 409 (check_list_feature_country_mismatch), salvo se a feature for mundial ou countries estiver vazio.
• As atualizações não gastam créditos. Executar um código guardado é uma chamada ao catálogo. O SmartBatch é um produto separado.
• Percurso de produto: Check List.