Skip to main content

Check List API 指南

当你的后端需要保存与 Smart-Agent 界面相同的那套清单时，用本页。产品说明见 Check List。

Check List 的增删改查不会执行查询，也不会扣积分。执行某项服务是普通的目录调用（与 SmartCheck 或 Postman 相同的 URL）。

鉴权​

每条路由都需要客户 JWT（Authorization: Bearer …）。没有 clientId 的令牌返回 403（Client context required）。列表只属于该客户。

接口​

方法路径用途
GET/v2/check-lists列出清单
POST/v2/check-lists创建清单
GET/v2/check-lists/{id}获取清单
PUT/v2/check-lists/{id}更新清单
DELETE/v2/check-lists/{id}删除清单

列表查询参数：page、perPage（或 limit），以及按名称过滤的 search（或 text）。两种 200 响应形状（带 page 和不带 page）见 列出清单。

请求体字段​

字段含义
name创建时必填。最多 150 个字符。
countries运营国家名称（例如 Colombia）。
domains可选页签：people、vehicles、businesses。
featureCodes列表上服务的 AppFeature code。
statusdraft（默认）或 active。仅整理标签，两者行为相同。

未知的 featureCodes 会失败。国家与列表不符的服务会失败，除非该服务是全球范围（或列表还没有国家）。

创建示例​

POST https://api.verifik.co/v2/check-lists
Authorization: Bearer <client-jwt>
Content-Type: application/json
{
  "name": "KYC Colombia",
  "countries": ["Colombia"],
  "domains": [],
  "featureCodes": [],
  "status": "draft"
}

响应为 { "data": { …checklist } }。保存 data._id。用户添加服务后，对同一 id PUT 新的 featureCodes。

执行已保存的服务​

没有“执行清单”接口。对列表中的每个 code，像 SmartCheck 一样调用该功能的目录 URL。积分在这些调用上扣除。

若要以文件或队列发送这套组合，使用 SmartBatch（国家 + 功能代码 + 名称）。Check List 不会替你启动批次。

相关​