Skip to main content

チェックリストを取得

id で Check List を 1 件読み込みます。リストは JWT 上のクライアントに属している必要があります。無効な ObjectId、存在しないリスト、他のクライアントのリストは 404 を返します。

この呼び出しは照会を実行せず、クレジットも消費しません。ドキュメントの featureCodes を使って、各カタログ API を自分で呼び出してください。

Endpoint

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

保存済みリストを返します: namecountriesdomainsfeatureCodesstatus。これらのコードを、対応する SmartCheck / カタログ URL と一緒に使います。このパスにチェックリスト実行アクションはありません。

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

トークンは クライアント JWT である必要があります。clientId のないトークンは 403 を返します。

Parameters

NameTypeRequiredDescription
idstringYes作成または一覧から得た Check List の ObjectId。

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

  • 無効な ObjectId と他のクライアントのリストは、どちらも 404check_list_not_found)です。
  • 応答にはホスト型の再開 URL やバッチ URL は含まれません。Check List は組み合わせだけを保存します。
  • フィールドを変えるには チェックリストを更新 を使います。削除するには チェックリストを削除 を使います。
  • featureCodes のコードを実行するのは通常のカタログ呼び出しで、そこでクレジットが消費されます。