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。送ると保存済みリストを置き換えます。
statusstringNodraft または active。整理用ラベルのみ。

不明な 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 で失敗します。
  • 不明な featureCodes409check_list_invalid_feature)です。
  • マージ後の countries の外にあるフィーチャーは、世界向けであるか countries が空でない限り 409check_list_feature_country_mismatch)です。
  • 更新はクレジットを消費しません。保存したコードの実行はカタログ呼び出しです。SmartBatch は別製品です。
  • 製品の手順: Check List