> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# 기업 상태 업데이트 API: 차단 또는 표시

> Didit 기업(KYB)을 차단, 표시 또는 활성화합니다. 상태는 이후 KYB 세션과 거래 스크리닝에 반영됩니다. 호출당 과금되는 기업 관리 API입니다.



기업 상태 업데이트 프롬프트
        프롬프트를 클립보드에 복사



      
      

\<pre>

\`Goal: Flip ONLY the lifecycle status of a Didit Business (KYB) entity. Use the full PATCH /v3/businesses/{vendor_data}/ when you also need to touch other fields.

Endpoint: PATCH https://verification.didit.me/v3/businesses/{vendor_data}/update-status/
Auth header: x-api-key: <DIDIT_API_KEY>
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices, NOT the session enum).
\- reason (string, optional, max 1000): why the status changed. Recorded on the status-change entry in the company's Activity in the Business Console, only when the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New KYB sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent KYB session creations for the same identifier are rejected. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Registry shows the company dissolved"}'

Response 200: full updated BusinessDetailItem (same shape as GET /v3/businesses/{vendor_data}/). See /reference/data-models.

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one status-change entry to the company's activity (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).

Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key.
\- 403: a scoped API key without businesses write. { "detail": "This API key has no write access to companies." }
\- 404 — vendor_data not found (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

붙여넣을 곳

## 개요[기업 엔터티](https://docs.didit.me/ko/entities/businesses/overview.md)의 상태를 `ACTIVE`, `FLAGGED`, `BLOCKED` 사이에서 변경합니다. 전체 상태 머신은 [엔터티 수명 주기](https://docs.didit.me/ko/entities/lifecycle.md)를 참조하세요.## 사용 시점- 제재 대상이거나 사기가 확인된 기업을 **차단**합니다.
- 수동 검토를 기다리는 기업을 **플래그 지정**합니다.
- 개선 조치가 끝난 후 **차단 해제**합니다.
- 자체 컴플라이언스 시스템에서 받은 외부 신호를 **반영**합니다.## 참고 사항- 유효한 값: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- 상태가 변경된 이유를 기록하려면 선택 사항인 `reason`(최대 1000자)을 전달합니다.
  Didit은 이 값을 Business Console의 해당 기업 **활동**에 있는 상태 변경 항목에 보관합니다.
  이 값은 상태가 실제로 변경된 경우에만 기록됩니다.
- `BLOCKED` 상태의 기업은 새로운 기업 확인(KYB) 세션이 모두 자동 거부되며, 거래 상대방으로 나타나는 경우를 포함하여 새로운 거래도 모두 자동 거부됩니다.
- `previous_status`와 `status`를 포함한 `business.status.updated` 이벤트를 발송합니다.
  webhook에는 `reason`이 포함되지 않습니다.## 적용| 상태 | 새로운 기업 확인(KYB) 세션 | 이 기업이 관련된 거래 |
| - | - | - |
| `ACTIVE` | 정상 흐름 | 정상 흐름 |
| `FLAGGED` | `IN_REVIEW`로 라우팅 | 규칙에 따라 자동으로 에스컬레이션될 수 있음 |
| `BLOCKED` | 자동 거부됨 | 자동 거부됨 |## 권한기본 시크릿 키와 전체 액세스 권한을 가진 [API 키](https://docs.didit.me/ko/console/api-keys.md)는 언제나 이 엔드포인트를 호출할 수 있습니다.
사용자 지정 액세스 권한이 있는 키에는 **기업**(`businesses`) 쓰기 권한이 필요합니다.
일부 워크플로 또는 승인된 세션으로 제한된 키는 이 엔드포인트에 접근할 수 없습니다.Console의 [역할 및 권한](https://docs.didit.me/ko/console/roles-permissions.md)은 팀원이 Console에서 할 수 있는 작업을 결정합니다.
이 설정은 API 키 요청에 대해서는 평가되지 않습니다.## 관련 문서- [엔터티 수명 주기](https://docs.didit.me/ko/entities/lifecycle.md)
- [기업 차단 목록](https://docs.didit.me/ko/entities/businesses/blocklist.md)
- [엔터티 webhook](https://docs.didit.me/ko/entities/webhooks.md)


## OpenAPI

````yaml ko/openapi-25.json PATCH /v3/businesses/{vendor_data}/update-status/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: 신분증 인증 API입니다. x-api-key 헤더로 인증합니다.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: 기업 상태 업데이트
      description: >-
        기업의 수명 주기 `status`만 전환합니다: `ACTIVE`, `FLAGGED` 또는 `BLOCKED`(세션 상태 아님).
        `BLOCKED`는 `vendor_data`를 시스템 차단 목록에 추가하며, `BLOCKED`에서 다른 상태로 변경하면 해당
        항목이 제거됩니다. 각 변경 사항은 선택 사항인 `reason`과 함께 기업의 활동에 기록됩니다. 현재 상태를 그대로 전송하면
        아무것도 변경되지 않으며 `reason`도 기록되지 않습니다. `business.status.updated` webhook에는
        `reason`이 포함되지 않습니다.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: 귀하가 지정한 기업의 고유 식별자입니다(자유 형식 문자열, UUID 아님).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    reason:
                      type: string
                      nullable: true
                      maxLength: 1000
                      description: >-
                        상태가 변경된 이유입니다. 상태가 실제로 변경될 때만 Business Console의 회사
                        **Activity** 상태 변경 항목에 기록됩니다. webhook에는 포함되지 않습니다.
            examples:
              Flag:
                summary: 검토를 위해 기업 플래그 지정
                value:
                  status: FLAGGED
              Block:
                summary: 해당 기업 차단(시스템 차단 목록에 추가)
                value:
                  status: BLOCKED
              Reactivate:
                summary: 기업 재활성화
                value:
                  status: ACTIVE
              Block with reason:
                summary: 해당 기업 차단 및 사유 기록
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: 기업 상태가 업데이트되었습니다. 전체 기업 레코드가 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Blocked:
                  value:
                    didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890
                    vendor_data: company-123
                    display_name: null
                    legal_name: Acme Trading Ltd
                    registration_number: '12345678'
                    country_code: GB
                    effective_name: Acme Trading Ltd
                    status: BLOCKED
                    session_count: 2
                    approved_count: 1
                    declined_count: 0
                    in_review_count: 1
                    features:
                      KYB: Approved
                    features_list:
                      - feature: KYB
                        status: Approved
                    last_session_at: '2026-03-15T10:30:00Z'
                    last_activity_at: '2026-03-15T10:30:00Z'
                    first_session_at: '2026-01-10T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        name: VIP
                        color: '#2567FF'
                    created_at: '2026-01-10T08:00:00Z'
                    metadata:
                      industry: fintech
                    updated_at: '2026-03-15T10:30:00Z'
        '400':
          description: '`status`가 누락되었거나 유효하지 않습니다. 또는 `reason`이 1000자를 초과합니다.'
          content:
            application/json:
              examples:
                Missing status:
                  value:
                    status:
                      - This field is required.
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                Reason too long:
                  value:
                    reason:
                      - Ensure this field has no more than 1000 characters.
        '403':
          description: >-
            API 키가 누락되었거나 유효하지 않거나 폐기되었거나, 해당 키에 이 애플리케이션의 기업을 업데이트할 수 있는 권한이
            없습니다. 누락된 키는 `403`을 반환하며, 잘못되었거나 폐기되었거나 만료된 키는 `401`을 반환합니다.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: 제공된 `vendor_data`를 가진 (삭제되지 않은) 기업이 이 애플리케이션에 존재하지 않습니다.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: 속도 제한 초과. 대기 후 `Retry-After`에 지정된 시간 간격이 지난 뒤 재시도하세요.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: Request was throttled. Expected available in 30 seconds.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/businesses/company-123/update-status/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"status": "BLOCKED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.businesses.update_status(
                "company-123",
                status="FLAGGED",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.businesses.updateStatus("company-123", {
              status: "FLAGGED",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.BusinessesUpdateStatusParams;

            import me.didit.types.EntityStatusUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.businesses().updateStatus("company-123",
            BusinessesUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("FLAGGED"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->businesses->updateStatus('company-123', [
                'status' => 'FLAGGED',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.businesses.update_status(
              "company-123",
              status: "FLAGGED"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Businesses.UpdateStatusAsync("company-123", new
            BusinessesUpdateStatusParams

            {
                Status = "FLAGGED",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: 새 라이프사이클 상태입니다. `BLOCKED`는 `vendor_data`를 시스템 차단 목록에도 추가합니다.
    BusinessDetailItem:
      type: object
      description: 전체 기업 상세 정보입니다. 메타데이터 및 updated_at으로 BusinessListItem을 확장합니다.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: 이 기업에 첨부한 커스텀 메타데이터 JSON입니다. 기본값은 `{}`입니다.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      type: object
      description: 인증된 기업입니다.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: 이 기업에 대한 Didit의 고유 내부 UUID입니다.
        vendor_data:
          type: string
          nullable: true
          description: >-
            귀하가 지정한 해당 기업의 고유 식별자입니다(세션 생성 시 전달됨). 벤더 식별자가 제공되지 않은 경우 null일 수
            있습니다.
        display_name:
          type: string
          nullable: true
          description: 직접 설정한 커스텀 표시 이름
        legal_name:
          type: string
          nullable: true
          description: 등기부 또는 직접 입력에서 가져온 공식 법인명
        registration_number:
          type: string
          nullable: true
          description: 기업 등록번호 또는 법인 설립 번호
        country_code:
          type: string
          nullable: true
          description: '설립 국가(ISO 3166-1 alpha-2, 예: `GB`, `US`).'
        effective_name:
          type: string
          nullable: true
          description: '사용 가능한 최적의 이름: display_name이 설정된 경우 해당 값, 그렇지 않으면 legal_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            기업 레코드의 수명 주기 상태입니다(세션 상태가 아님). 기본값은 `ACTIVE`이며, `FLAGGED`는 수동 확인
            필요로 표시하고, `BLOCKED`는 해당 `vendor_data`에 대한 새 세션을 방지합니다.
        session_count:
          type: integer
          description: 해당 기업의 총 인증 세션 수
        approved_count:
          type: integer
          description: 승인된 세션 수
        declined_count:
          type: integer
          description: 거부된 세션 수
        in_review_count:
          type: integer
          description: 검토 중인 세션 수
        features:
          type: object
          description: >-
            이 기업의 모든 KYB 세션에 걸쳐 집계된 기능별 상태입니다. 현재 유일한 키는 `KYB`(법인 등기부 기업 확인
            상태)입니다. 가능한 값: `Approved`, `Declined`, `In Review`, `Not Finished`,
            `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: '`features`와 동일한 데이터로, `{feature, status}` 객체의 정렬된 배열입니다.'
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: 가장 최근 세션의 타임스탬프
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: 첫 번째 세션의 타임스탬프
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: 가장 최근 활동(상태 변경, 세션 업데이트 등)의 타임스탬프
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: 이 기업에 할당된 태그
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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 를 참고하십시오.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.