Skip to main content

更新清单

更新你拥有的 Check List。只发送要更改的字段。未发送的字段保持原值。合并后的文档会重新校验,因此合并后 name 仍必须存在。

保存更改不会执行查询,也不会消耗积分。在 Smart-Agent 中,创建后国家会被锁定 — 此 API 仍接受你发送的新 countries 数组。

Endpoint

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

返回更新后的列表。当用户添加或移除服务(featureCodes)、更改名称或设置 status 时使用此接口。无效的 id 和其他客户的列表返回 404

Headers

NameValue
Content-Typeapplication/json
AuthorizationBearer <token>

令牌必须是客户 JWT。没有 clientId 的令牌返回 403

Parameters

NameTypeRequiredDescription
idstringYes创建或列表接口返回的 Check List ObjectId。

Body

请求中所有字段都是可选的。合并后,name 仍为必填。

NameTypeRequiredDescription
namestringNo显示名称。去首尾空格,1–150 个字符。
countriesstring[]No国家名称。发送时会替换已存储的列表。
domainsstring[]Nopeoplevehicles 和/或 businesses。发送时会替换已存储的列表。
featureCodesstring[]NoAppFeature code 值。发送时会替换已存储的列表。
statusstringNodraftactive。仅整理标签。

未知的 featureCodes 会失败。国家与合并后的 countries 不符的服务会失败,除非该服务是全球范围或 countries 为空。

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

Response

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

Notes

  • 未发送的字段保持原值。发送 featureCodes 会替换整个数组 — 不会对代码做补丁合并。
  • 合并后,Joi 仍要求 name。清空名称会以 ValidationError 失败。
  • 未知的 featureCodes 返回 409check_list_invalid_feature)。
  • 功能所属国家不在合并后的 countries 中时返回 409check_list_feature_country_mismatch),除非该功能是全球范围或 countries 为空。
  • 更新不消耗积分。执行已保存的代码是目录调用。SmartBatch 是另一套产品。
  • 产品说明:Check List