메인 콘텐츠로 건너뛰기
PATCH
curl

개요

기업 엔티티의 변경 가능한 필드를 업데이트합니다. 법인 등기부 조회로 채워진 필드(legal_name, registration_number, country_code)는 기업 확인(KYB) 세션이 처음 승인된 후 읽기 전용이 됩니다.

사용 시기

  • 이름 바꾸기: 내부 화면에서 사용할 더 적절한 display_name을 설정합니다.
  • 메타데이터 업데이트: 기업을 내부 등급 사이에서 옮기거나, 내부 메모를 기록하거나, 태그를 변경합니다.
  • 법인 등기부 데이터 재정의(주의해서 사용): 재정의는 허용되지만 감사 로그에 표시됩니다.

참고 사항

  • URL의 vendor_data는 이 엔드포인트로 변경할 수 없습니다.
  • changed_fields 배열이 포함된 business.data.updated webhook을 전송합니다.
  • 모든 편집 내용은 Business Console의 해당 기업 활동에 기록됩니다. status 변경은 선택 사항인 reason(최대 1000자)과 함께 기록되며, display_name, legal_name, registration_number, country_code 또는 metadata 변경은 프로필 업데이트로 기록됩니다. business.status.updated webhook에는 reason이 포함되지 않습니다.

권한

기본 시크릿 키와 전체 액세스 API 키는 언제든지 이 엔드포인트를 호출할 수 있습니다. 사용자 지정 액세스 권한이 있는 키에는 기업(businesses) 쓰기 권한이 필요합니다. 일부 워크플로나 승인된 세션으로만 제한된 키는 이 엔드포인트에 접근할 수 없습니다. Console의 역할 및 권한은 팀원이 Console에서 할 수 있는 작업을 결정합니다. 이 설정은 API 키 요청에는 평가되지 않습니다.

관련 문서

인증

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 를 참고하십시오.

경로 매개변수

vendor_data
string
필수

귀하가 지정한 기업의 고유 식별자입니다(자유 형식 문자열, UUID 아님).

본문

application/json

부분 업데이트 본문입니다. 변경하려는 필드만 제공하십시오.

display_name
string | null

콘솔에 표시되는 친숙한 표시 이름입니다(UI 표시 시 legal_name보다 우선 적용됨).

등기부 또는 직접 입력에서 가져온 공식 법인명입니다.

registration_number
string | null

기업 등록번호 또는 법인 설립 번호입니다.

country_code
string | null

설립 국가(ISO 3166-1 alpha-2, 예: GB, US).

status
enum<string>

기업 수명 주기 상태입니다. BLOCKED로 설정하면 vendor_data가 시스템 차단 목록에 자동으로 추가되며, BLOCKED가 아닌 상태로 변경하면 해당 차단 목록 항목이 제거됩니다.

사용 가능한 옵션:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

기업에 연결하는 임의의 JSON 객체입니다. 업데이트 시 기존 메타데이터를 완전히 대체합니다. 키만 추가하려면 클라이언트 측에서 병합하십시오.

reason
string | null

상태가 변경된 이유입니다. 상태가 실제로 변경될 때만 Business Console의 회사 Activity 상태 변경 항목에 기록됩니다. webhook에는 포함되지 않습니다.

Maximum string length: 1000

응답

기업이 업데이트되었습니다. 업데이트된 전체 기업 레코드가 반환됩니다.

전체 기업 상세 정보입니다. 메타데이터 및 updated_at으로 BusinessListItem을 확장합니다.

didit_internal_id
string<uuid>

이 기업에 대한 Didit의 고유 내부 UUID입니다.

vendor_data
string | null

귀하가 지정한 해당 기업의 고유 식별자입니다(세션 생성 시 전달됨). 벤더 식별자가 제공되지 않은 경우 null일 수 있습니다.

display_name
string | null

직접 설정한 커스텀 표시 이름

등기부 또는 직접 입력에서 가져온 공식 법인명

registration_number
string | null

기업 등록번호 또는 법인 설립 번호

country_code
string | null

설립 국가(ISO 3166-1 alpha-2, 예: GB, US).

effective_name
string | null

사용 가능한 최적의 이름: display_name이 설정된 경우 해당 값, 그렇지 않으면 legal_name

status
enum<string>

기업 레코드의 수명 주기 상태입니다(세션 상태가 아님). 기본값은 ACTIVE이며, FLAGGED는 수동 확인 필요로 표시하고, BLOCKED는 해당 vendor_data에 대한 새 세션을 방지합니다.

사용 가능한 옵션:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

해당 기업의 총 인증 세션 수

approved_count
integer

승인된 세션 수

declined_count
integer

거부된 세션 수

in_review_count
integer

검토 중인 세션 수

features
object

이 기업의 모든 KYB 세션에 걸쳐 집계된 기능별 상태입니다. 현재 유일한 키는 KYB(법인 등기부 기업 확인 상태)입니다. 가능한 값: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

features와 동일한 데이터로, {feature, status} 객체의 정렬된 배열입니다.

last_session_at
string<date-time> | null

가장 최근 세션의 타임스탬프

first_session_at
string<date-time> | null

첫 번째 세션의 타임스탬프

last_activity_at
string<date-time> | null

가장 최근 활동(상태 변경, 세션 업데이트 등)의 타임스탬프

tags
object[]

이 기업에 할당된 태그

created_at
string<date-time>
metadata
object

이 기업에 첨부한 커스텀 메타데이터 JSON입니다. 기본값은 {}입니다.

updated_at
string<date-time>
마지막 수정일 2026년 11월 7일