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[]Nopeople, vehicles, 그리고/또는 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로 실패합니다.
  • 알 수 없는 featureCodes409 (check_list_invalid_feature)를 반환합니다.
  • 병합된 countries 밖에 있는 기능은 409 (check_list_feature_country_mismatch)를 반환합니다. 다만 기능이 전 세계이거나 countries가 비어 있으면 허용됩니다.
  • 수정은 크레딧을 쓰지 않습니다. 저장된 코드를 실행하는 것은 카탈로그 호출입니다. SmartBatch는 별도 제품입니다.
  • 제품 안내: Check List.