메인 콘텐츠로 건너뛰기
PATCH
cURL
부분 업데이트에는 PATCH를 사용합니다. 워크플로 이름을 바꾸려면 workflow_label만 전송합니다.
워크플로의 검사 항목을 변경하려면 원하는 features 배열 전체를 전송합니다. 이렇게 하면 기존 기능 순서와 구성이 대체됩니다.
v3 API는 워크플로를 단순하게 유지합니다. 선형 경로 하나와 최종 상태 단계 하나만 지원합니다. 분기, 작업 노드, webhook 노드는 여기서 허용되지 않습니다.

기능 구성 참조

PATCH에서 features를 전송하면 배열이 기존 기능 순서와 구성을 대체합니다. 필수 구성을 모두 다시 포함해야 합니다. 정확한 config 객체는 기능에 따라 다릅니다. 전체 필드 목록, 기본값, 필수 설정, 값 범위, 예시는 워크플로 기능 구성에서 확인하십시오. OCR의 경우 config.documents_allowed를 생략하거나 null을 보내거나 {}를 보내면 지원되는 모든 문서 유형을 허용합니다. 워크플로를 특정 국가나 문서 유형으로 제한하려는 경우에만 포함합니다. QUESTIONNAIRE의 경우 config.questionnaire_uuid가 필수입니다.

워크플로 설정 업데이트

기능 목록을 변경하지 않고 세션 수준 설정을 패치할 수 있습니다. 변경할 필드만 전송합니다.
이 URL의 settings_uuid로 목록, 생성 또는 조회 endpoint에서 반환된 워크플로 uuid를 사용합니다.

인증

x-api-key
string
header
필수

Business Console의 Developers -> API keys에서 발급받은 귀하 애플리케이션의 API 키입니다. 기본 키는 전체 접근 권한을 갖습니다. 이름이 지정된 키는 리소스별 none, read, write 범위로 권한을 제한할 수 있으며 특정 워크플로나 승인된 세션, IP 주소 목록, 만료일 등으로 제한할 수도 있습니다. 401은 키가 잘못되었거나 폐기되었거나 만료되었음을 의미합니다. 403은 키가 전송되지 않았거나, 키에 해당 리소스나 작업에 대한 접근 권한이 없거나, 요청이 허용된 IP 목록 외부 주소에서 발생했음을 의미합니다. 세션 경로에서의 404는 해당 세션이 키의 허용 워크플로 또는 상태 범위를 벗어났음을 의미합니다. 미디어 접근 권한이 없는 키는 이미지, 비디오, PDF URL을 null로 수신하며, 세션 write 권한이 없는 키는 세션 링크와 token을 null로 수신합니다. https://docs.didit.me/console/api-keys 를 참고하십시오.

경로 매개변수

settings_uuid
string<uuid>
필수

업데이트할 워크플로의 버전별 UUID입니다.

본문

application/json

워크플로 메타데이터를 업데이트하거나 전체 선형 기능 목록을 대체합니다. 엄격한 필드 화이트리스트가 적용됩니다. 여기에 나열되지 않은 키는 400 오류와 함께 거부됩니다.

workflow_label
string

워크플로의 표시 이름(최대 50자)입니다.

Maximum string length: 50
is_default
boolean

이 워크플로를 새 세션의 기본값으로 설정합니다.

status
enum<string>

버전 관리를 제어합니다. 현재 버전을 즉시 업데이트하려면 생략하십시오(초안은 자동 게시됨). 이미 게시된 버전에 대해 published를 지정하면 새 버전을 생성하여 반환합니다. draft는 해당 버전이 아직 초안 상태일 때만 유효합니다.

사용 가능한 옵션:
draft,
published
features
object[]

제공된 경우 전체 기능 순서 및 구성을 대체합니다.

Minimum array length: 1
is_white_label_enabled
boolean

이 워크플로로 생성된 세션에 화이트 라벨 맞춤 설정을 활성화합니다.

is_desktop_allowed
boolean

데스크톱 브라우저에서 인증 워크플로가 실행되도록 허용합니다.

max_retry_attempts
integer

거부된 인증 후 허용되는 최대 재시도 횟수입니다. 0은 첫 번째 거부 후 사용자를 차단합니다.

필수 범위: 0 <= x <= 10
retry_window_days
integer | null

재시도 횟수를 계산하는 데 사용되는 롤링 윈도우 일수. null은 전체 기간 제한을 적용합니다.

필수 범위: 1 <= x <= 365
face_liveness_max_attempts
integer

세션당 최대 라이브니스 제출 횟수입니다. 기능 수준 구성에서 이를 재정의하지 않는 한, 이 값은 생성된 라이브니스 및 연령 추정 워크플로 노드에도 복사됩니다.

필수 범위: 1 <= x <= 3
face_match_max_attempts
integer

세션당 최대 얼굴 대조 제출 횟수입니다. 기능 수준 구성에서 이를 재정의하지 않는 한, 이 값은 생성된 얼굴 대조 워크플로 노드에도 복사됩니다.

필수 범위: 1 <= x <= 3
session_expiration_time
integer

완료되지 않은 세션이 만료되기까지 남은 시간(초)입니다. 최소 1시간(3600), 최대 4주(2419200).

필수 범위: 3600 <= x <= 2419200

응답

워크플로가 업데이트되었습니다. 본문은 결과 버전의 전체 구성입니다(GET /v3/workflows/{settings_uuid}/와 동일한 원시 VerificationSettings 형태). 업데이트로 인해 새 버전이 생성된 경우(게시된 행에 status: "published" 전송), 반환된 uuid 및 version은 패치한 항목과 다릅니다. 후속 호출에는 반환된 uuid를 사용하십시오.

아래 필드는 타입이 지정되어 있습니다. 또한 이 객체는 워크플로 설정의 다른 모든 열(기능 토글, 임계값, 경고 작업, 허용된 문서, 콜백)을 추가 속성으로 전달합니다. workflow_type에 적용되지 않는 필드는 null입니다.

uuid
string<uuid>

버전별 식별자(settings_uuid)입니다. 워크플로의 모든 버전에는 고유한 식별자가 있습니다.

workflow_id
string<uuid>

워크플로의 모든 버전에서 공유되는 안정적인 식별자입니다. 이 식별자로 생성된 세션은 게시된 최신 버전을 사용합니다.

workflow_label
string

워크플로의 표시 이름입니다.

workflow_type
enum<string> | null

워크플로 템플릿입니다. 템플릿 없이 생성된 그래프 워크플로의 경우 null입니다.

사용 가능한 옵션:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

이 워크플로가 애플리케이션의 기본 워크플로인지 여부입니다.

is_archived
boolean

보관된 워크플로는 새 세션을 시작할 수 없습니다.

version
integer

워크플로 내의 버전 번호입니다.

status
enum<string>

초안 버전은 편집할 수 있으며, 게시된 버전은 변경할 수 없고 새 세션에 사용됩니다.

사용 가능한 옵션:
draft,
published
published_at
string<date-time> | null

이 버전이 게시된 시점입니다. 초안의 경우 null입니다.

is_simple_workflow
boolean

워크플로에 사용자 지정 workflow_graph가 없는 경우 true입니다.

is_editable
boolean

draft 버전인 경우에만 true입니다.

workflow_url
string<uri>

이 워크플로로 세션을 시작하는 공개 URL입니다.

workflow_graph
object | null

워크플로의 그래프 구조(노드 및 에지)입니다. 단순 워크플로의 경우 null입니다.

features
string

" + "로 연결된 활성화된 기능입니다(예: "OCR + LIVENESS").

total_price
number | null

세션당 가격입니다. 그래프 워크플로의 경우 가장 비싼 경로의 가격입니다.

min_price
number | null

워크플로에서 가장 저렴한 경로의 가격입니다.

max_price
number | null

워크플로에서 가장 비싼 경로의 가격입니다.

special_add_on_prices
object | null

조직별 부가 기능 가격이며, 설정되지 않은 경우 null입니다.

max_retry_attempts
integer

거부된 인증 후 허용되는 재시도 횟수입니다.

retry_window_days
integer | null

재시도가 허용되는 일수.

session_expiration_time
integer

완료되지 않은 세션이 만료되기까지 남은 시간(초).

questionnaire
object | null

워크플로에 연결된 설문지 또는 null입니다.

kyb_role_settings
object[]

KYB 주요 인물에 대한 역할별 인증 설정입니다.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

현재 서명 가능한 전자 서명 등급입니다. signature_level을 설정하기 전에 확인하십시오. kyc, kyb 및 그래프 워크플로에서 반환됩니다.

is_bank_verification_enabled
boolean

단순 KYC 또는 KYB 워크플로가 은행 확인을 실행하는지 여부입니다. 연락처 단계(및 위치 확인) 이후, 데이터베이스 검증, AML 및 IP 분석 이전에 실행됩니다. 은행 확인은 아직 일반에 공개되지 않았으며, 활성화되지 않은 환경에서 켜려고 하면 거부됩니다.

bank_verification_config
object

BANK_VERIFICATION 노드가 사용하는 것과 동일한 키(예: bank_countries 및 bank_method_order)를 사용하는 단순 워크플로의 은행 인증 설정입니다. 알 수 없는 키는 삭제됩니다. 모든 키는 선택 사항이며 누락된 키는 기본값을 유지하므로 {}는 모든 기본값을 의미합니다. 은행 인증 설정을 참조하십시오.

예시:
is_geolocation_enabled
boolean

단순 KYC 워크플로가 위치 확인을 실행하는지 여부입니다. 연락처 단계 이후, 은행 확인 및 데이터베이스 검증 이전에 실행됩니다. 기업(KYB) 워크플로에서는 실행할 수 없습니다.

geolocation_config
object

간단한 워크플로의 위치 확인 설정으로, GEOLOCATION 노드가 사용하는 것과 동일한 키(예: is_geolocation_geofencing_enabled 및 geolocation_max_attempts)를 갖습니다. 알 수 없는 키는 삭제됩니다. 모든 키는 선택 사항이며 누락된 키는 기본값을 유지하므로 {}는 모든 기본값을 의미합니다.

예시:
마지막 수정일 2026년 11월 7일