チェックリストを更新
自分が所有する Check List を更新します。変えたいフィールドだけ送ってください。省略したフィールドは現在の値のままです。マージ後のドキュメントは再バリデーションされるため、マージ後も name が必要です。
変更の保存は照会を実行せず、クレジットも消費しません。Smart-Agent では作成後に国はロックされますが、この API は新しい countries 配列を送れば受け付けます。
Endpoint
PUT https://api.verifik.co/v2/check-lists/{id}
更新後のリストを返します。ユーザーがサービス(featureCodes)を追加・削除するとき、名前を変えるとき、status を設定するときに使います。無効な id と他のクライアントのリストは 404 です。
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <token> |
トークンは クライアント JWT である必要があります。clientId のないトークンは 403 を返します。
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | 作成または一覧から得た Check List の ObjectId。 |
Body
リクエスト上のフィールドはすべて任意です。マージ後は、name が依然として必須です。
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | 表示名。トリム済み、1〜150 文字。 |
countries | string[] | No | 国名。送ると保存済みリストを置き換えます。 |
domains | string[] | No | people、vehicles、および/または businesses。送ると保存済みリストを置き換えます。 |
featureCodes | string[] | No | AppFeature の code。送ると保存済みリストを置き換えます。 |
status | string | No | draft または active。整理用ラベルのみ。 |
不明な featureCodes は失敗します。国がマージ後の countries と一致しないサービスは、そのサービスが世界向けであるか countries が空でない限り失敗します。
Request
- Node.js
- PHP
- Python
- Go
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();
<?php
$id = "6aa224c87034a338385c28c0";
$ch = curl_init("https://api.verifik.co/v2/check-lists/" . $id);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Content-Type: application/json",
"Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"featureCodes" => ["co-cedula", "cl-rut"],
"domains" => ["people"]
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
echo curl_exec($ch);
import os, requests
check_list_id = "6aa224c87034a338385c28c0"
url = f"https://api.verifik.co/v2/check-lists/{check_list_id}"
headers = {
"Content-Type": "application/json",
"Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
payload = {
"featureCodes": ["co-cedula", "cl-rut"],
"domains": ["people"],
}
r = requests.put(url, json=payload, headers=headers)
print(r.json())
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"os"
)
func main() {
id := "6aa224c87034a338385c28c0"
body, _ := json.Marshal(map[string]interface{}{
"featureCodes": []string{"co-cedula", "cl-rut"},
"domains": []string{"people"},
})
req, _ := http.NewRequest("PUT", "https://api.verifik.co/v2/check-lists/"+id, bytes.NewReader(body))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer "+os.Getenv("VERIFIK_TOKEN"))
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
var out map[string]interface{}
json.NewDecoder(resp.Body).Decode(&out)
fmt.Println(out)
}
Response
- 200
- 403
- 404
- 409
- 409 invalid feature
- 409 country mismatch
{
"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"
}
}
{
"message": "Client context required",
"code": "Forbidden"
}
{
"message": "check_list_not_found",
"code": "check_list_not_found"
}
{
"message": "\"name\" is required",
"code": "ValidationError"
}
{
"message": "check_list_invalid_feature",
"code": "check_list_invalid_feature"
}
{
"message": "check_list_feature_country_mismatch",
"code": "check_list_feature_country_mismatch"
}
Notes
- 省略したフィールドは現在の値のままです。
featureCodesを送ると配列全体が置き換わります。コードのパッチマージではありません。 - マージ後、Joi は依然として
nameを要求します。名前を空にするとValidationErrorで失敗します。 - 不明な
featureCodesは409(check_list_invalid_feature)です。 - マージ後の
countriesの外にあるフィーチャーは、世界向けであるかcountriesが空でない限り409(check_list_feature_country_mismatch)です。 - 更新はクレジットを消費しません。保存したコードの実行はカタログ呼び出しです。SmartBatch は別製品です。
- 製品の手順: Check List。