Skip to main content

Lire une checklist

Chargez une Check List par id. La liste doit appartenir au client du JWT. Un ObjectId invalide, une liste absente ou une liste appartenant à un autre client renvoie 404.

Cet appel n’exécute pas de consultations et ne consomme pas de crédits. Utilisez featureCodes du document pour appeler chaque API catalogue vous-même.

Endpoint

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

Renvoie la liste enregistrée : name, countries, domains, featureCodes et status. Utilisez ces codes avec les URL SmartCheck / catalogue correspondantes. Il n’y a pas d’action d’exécution de checklist sur ce chemin.

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

Le jeton doit être un JWT client. Un jeton sans clientId renvoie 403.

Parameters

NameTypeRequiredDescription
idstringYesObjectId Check List issu de la création ou de la liste.

Request

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();

Response

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

Notes

  • Les ObjectId invalides et les listes d’autres clients renvoient tous les deux 404 (check_list_not_found).
  • La réponse n’inclut pas d’URL de reprise hébergée ni d’URL de lot. Check List stocke uniquement le mélange.
  • Pour modifier les champs, utilisez Mettre à jour une checklist. Pour la retirer, utilisez Supprimer une checklist.
  • Exécuter un code de featureCodes est un appel catalogue normal et consomme des crédits à cet endroit.