Skip to main content

获取清单

按 id 加载一份 Check List。该列表必须属于 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 中的某个代码是普通的目录调用,并在该调用上扣除积分。