> ## 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 벤더 사용자를 차단, 플래그 지정 또는 활성화합니다. 상태는 향후 KYC 세션과 거래 스크리닝에 반영됩니다. 호출 건당 과금되는 사용자 관리 기능입니다.



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



      
      

\<pre>

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

Endpoint: PATCH https://verification.didit.me/v3/users/{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" (VendorUserStatusChoices, NOT the session enum).
\- reason (string, optional, max 1000): why the status changed. Recorded as the comment of the STATUS_CHANGED entry in the user's activity (comments[].comment), only when the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New 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 session creations for the same identifier are rejected with a blocklist hit. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed"}'

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

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one STATUS_CHANGED entry to the user's comments activity log (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. { "detail": "Authentication credentials were not provided." }
\- 403 — the API key is revoked or is not valid for this application. { "detail": "You do not have permission to perform this action." }
\- 403: a scoped API key without users write. { "detail": "This API key has no write access to people." }
\- 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/users/overview.md)를 `ACTIVE`, `FLAGGED`, `BLOCKED` 상태 사이에서 이동합니다. 전체 상태 머신은 [엔터티 라이프사이클](https://docs.didit.me/ko/entities/lifecycle.md)을 참조하십시오.## 사용 시기- 사기 또는 컴플라이언스 위반을 확인한 후 **사용자를 차단**합니다.
- 완전히 차단하지 않고 수동 검토가 진행되는 동안 **사용자를 플래그 처리**합니다.
- 적절한 조치를 마친 후 **차단을 해제**합니다.
- **외부 신호를 반영**합니다. 예를 들어 자체 사기 탐지 엔진이 사용자 점수를 임계값 이상으로 산정하면, 이 엔드포인트를 통해 해당 사용자를 `FLAGGED` 상태로 이동합니다.## 참고 사항- 유효한 값은 `ACTIVE`, `FLAGGED`, `BLOCKED`입니다. 유효하지 않은 값을 보내면 400 응답이 반환됩니다.
- 선택 사항인 `reason`(최대 1000자)을 전달하면 상태가 변경된 이유를 기록할 수 있습니다.
  Didit은 이 값을 사용자의 활동 내역에 있는 상태 변경 항목의 코멘트로 저장합니다. 사용자 객체의 `comments[].comment`와 Business Console의 **활동**에서 확인할 수 있습니다.
  상태가 실제로 변경된 경우에만 기록됩니다.
- `BLOCKED` 사용자의 모든 신규 세션과 모든 신규 거래는 자동으로 거부됩니다.
- `previous_status`와 `status`를 포함한 `user.status.updated` webhook 이벤트가 발생합니다.
  이 webhook에는 `reason`이 포함되지 않습니다.## 적용 방식| 상태 | 신규 세션에 대한 영향 | 신규 거래에 대한 영향 |
| - | - | - |
| `ACTIVE` | 일반 흐름 | 일반 흐름 |
| `FLAGGED` | 허용되지만 `IN_REVIEW`로 라우팅됨 | 허용됨. 규칙에 따라 자동으로 에스컬레이션될 수 있음 |
| `BLOCKED` | 자동 거부 | 자동 거부 |## 권한기본 시크릿과 전체 액세스 [API 키](https://docs.didit.me/ko/console/api-keys.md)는 언제든지 이 엔드포인트를 호출할 수 있습니다.
사용자 지정 액세스 권한이 있는 키에는 **사용자**(`users`) 쓰기 권한이 필요합니다.
일부 워크플로 또는 승인된 세션으로 제한된 키는 이 엔드포인트에 접근할 수 없습니다.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/users/blocklist.md)
- [엔터티 webhook](https://docs.didit.me/ko/entities/webhooks.md)


## OpenAPI

````yaml ko/openapi-25.json PATCH /v3/users/{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/users/{vendor_data}/update-status/:
    patch:
      tags:
        - Users
      summary: 사용자 상태 업데이트
      description: >-
        사용자의 수명 주기 `status`만 전환합니다: `ACTIVE`, `FLAGGED` 또는 `BLOCKED`(세션 상태 아님).
        `BLOCKED`는 `vendor_data`를 시스템 차단 목록에 추가하며, `BLOCKED`에서 다른 상태로 변경하면 해당
        항목이 제거됩니다. 각 변경 사항은 사용자의 `STATUS_CHANGED` 활동으로 기록되며, 선택 사항인 `reason`은
        `comment`로 기록됩니다. 현재 상태를 그대로 전송하면 아무것도 변경되지 않으며 `reason`도 기록되지 않습니다.
        `user.status.updated` webhook에는 `reason`이 포함되지 않습니다.
      operationId: update_user_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: 귀하가 지정한 사용자의 고유 식별자입니다.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    reason:
                      type: string
                      nullable: true
                      maxLength: 1000
                      description: >-
                        상태가 변경된 이유입니다. 상태가 실제로 변경될 때만 사용자
                        활동(`comments[].comment` 및 Business Console의
                        **Activity**)의 상태 변경 항목에 기록됩니다. webhook에는 포함되지 않습니다.
            examples:
              Activate:
                summary: 사용자 재활성화
                value:
                  status: ACTIVE
              Flag:
                summary: 검토를 위해 사용자 플래그 지정
                value:
                  status: FLAGGED
              Block:
                summary: 해당 사용자 차단(시스템 차단 목록에 추가)
                value:
                  status: BLOCKED
              Block with reason:
                summary: 해당 사용자 차단 및 사유 기록
                value:
                  status: BLOCKED
                  reason: Chargeback fraud pattern confirmed
      responses:
        '200':
          description: 사용자 상태가 업데이트되었습니다. 전체 사용자 레코드가 반환됩니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailItem'
              examples:
                Blocked:
                  value:
                    didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
                    vendor_data: user-abc-123
                    display_name: null
                    full_name: John Michael Doe
                    date_of_birth: '1990-05-15'
                    effective_name: John Michael Doe
                    status: BLOCKED
                    metadata:
                      tier: premium
                      source: website
                    portrait_image_url: https://<media-host>/...
                    session_count: 3
                    approved_count: 2
                    declined_count: 0
                    in_review_count: 1
                    issuing_states:
                      - USA
                    approved_emails:
                      - john@example.com
                    approved_phones:
                      - '+14155551234'
                    features:
                      ID_VERIFICATION: Approved
                      LIVENESS: Approved
                      FACE_MATCH: Approved
                      AML: Approved
                    features_list:
                      - feature: ID_VERIFICATION
                        status: Approved
                      - feature: LIVENESS
                        status: Approved
                      - feature: FACE_MATCH
                        status: Approved
                      - feature: AML
                        status: Approved
                    last_session_at: '2025-06-15T10:30:00Z'
                    last_activity_at: '2025-06-15T10:30:00Z'
                    first_session_at: '2025-06-01T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        tag:
                          uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b
                          name: VIP
                          color: '#2567FF'
                          description: null
                          source: custom
                          created_at: '2025-05-01T09:00:00Z'
                          updated_at: '2025-05-01T09:00:00Z'
                        added_by_email: analyst@acme.com
                        added_by_name: Jane Analyst
                        created_at: '2025-06-02T11:00:00Z'
                    comments:
                      - uuid: c1111111-2222-4333-8444-555555555555
                        comment_type: STATUS_CHANGED
                        comment: Chargeback fraud pattern confirmed
                        actor_email: null
                        actor_name: null
                        previous_status: ACTIVE
                        new_status: BLOCKED
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        mentioned_emails: []
                        created_at: '2025-06-15T10:30:00Z'
                    created_at: '2025-06-01T08:00:00Z'
                    updated_at: '2025-06-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.
        '401':
          description: >-
            자격 증명이 제공되지 않았습니다. `x-api-key` 헤더(또는 `Authorization: Bearer` token)가
            없는 `/v3/users/*` 경로에 대한 요청은 API에 도달하기 전에 인증 미들웨어에 의해 거부됩니다.
          content:
            application/json:
              examples:
                Missing credentials:
                  value:
                    detail: >-
                      You must be authenticated with a valid access token to
                      access this endpoint.
        '403':
          description: >-
            키가 이 애플리케이션의 사용자를 업데이트할 수 없습니다. 키가 누락되면 `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/users/user-abc-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.users.update_status(
                "user-123",
                status="ACTIVE",
            )
            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.users.updateStatus("user-123", {
              status: "ACTIVE",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\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.EntityStatusUpdateRequest;

            import me.didit.types.UsersUpdateStatusParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.users().updateStatus("user-123",
            UsersUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
                    .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->users->updateStatus('user-123', [
                'status' => 'ACTIVE',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.users.update_status(
              "user-123",
              status: "ACTIVE"
            )
            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.Users.UpdateStatusAsync("user-123", new
            UsersUpdateStatusParams

            {
                Status = "ACTIVE",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: 새 라이프사이클 상태입니다. `BLOCKED`는 `vendor_data`를 시스템 차단 목록에도 추가합니다.
    UserDetailItem:
      type: object
      description: 전체 사용자 세부정보입니다. UserListItem을 메타데이터, 댓글 및 updated_at으로 확장합니다.
      allOf:
        - $ref: '#/components/schemas/UserListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: 이 사용자에 첨부한 커스텀 메타데이터 JSON입니다. 기본값은 `{}`입니다.
            tags:
              type: array
              description: >-
                태그 할당입니다. 참고: 목록 응답에 사용되는 플랫한 `{uuid, name, color}` 형태와 달리, 상세
                응답의 각 항목은 태그 *링크* 객체(`{uuid, tag: {...}, added_by_email,
                added_by_name, created_at}`)입니다.
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: 태그 할당의 UUID입니다(태그 자체의 UUID가 아님).
                  tag:
                    type: object
                    properties:
                      uuid:
                        type: string
                        format: uuid
                      name:
                        type: string
                      color:
                        type: string
                      description:
                        type: string
                        nullable: true
                      source:
                        type: string
                        enum:
                          - didit
                          - custom
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  added_by_email:
                    type: string
                    nullable: true
                  added_by_name:
                    type: string
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
            comments:
              type: array
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                  comment_type:
                    type: string
                    enum:
                      - COMMENT
                      - STATUS_CHANGED
                      - METADATA_UPDATED
                      - TAG_ADDED
                      - TAG_REMOVED
                      - PROFILE_UPDATED
                  comment:
                    type: string
                    nullable: true
                  actor_email:
                    type: string
                    nullable: true
                  actor_name:
                    type: string
                    nullable: true
                  previous_status:
                    type: string
                    nullable: true
                    enum:
                      - ACTIVE
                      - FLAGGED
                      - BLOCKED
                      - null
                  new_status:
                    type: string
                    nullable: true
                    enum:
                      - ACTIVE
                      - FLAGGED
                      - BLOCKED
                      - null
                  previous_value:
                    type: object
                    nullable: true
                    description: PROFILE_UPDATED 항목의 이전 필드 값입니다.
                  new_value:
                    type: object
                    nullable: true
                    description: PROFILE_UPDATED 항목의 새 필드 값입니다.
                  changed_fields:
                    type: array
                    items:
                      type: string
                    description: PROFILE_UPDATED 항목에 의해 변경된 필드의 이름입니다.
                  metadata:
                    type: object
                    nullable: true
                  mentioned_emails:
                    type: array
                    items:
                      type: string
                  created_at:
                    type: string
                    format: date-time
              description: 이 사용자의 활동 로그 및 댓글입니다(상태 변경, 프로필 수정, 수동 메모).
            updated_at:
              type: string
              format: date-time
    UserListItem:
      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: 직접 설정한 커스텀 표시 이름
        full_name:
          type: string
          nullable: true
          description: 인증된 문서에서 추출된 성명
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: '사용 가능한 최적의 이름: display_name이 설정된 경우 해당 값, 그렇지 않으면 full_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            사용자 레코드의 수명 주기 상태입니다(세션 상태가 아님). 기본값은 `ACTIVE`이며, `FLAGGED`는 사용자를 수동
            확인 필요로 표시하고, `BLOCKED`는 해당 `vendor_data`에 대한 새 세션을 방지합니다.
        portrait_image_url:
          type: string
          nullable: true
          description: 사용자의 사전 서명된 인물 사진 URL(몇 시간 후 만료됨)
        session_count:
          type: integer
          description: 해당 사용자의 총 인증 세션 수
        approved_count:
          type: integer
          description: 승인된 세션 수
        declined_count:
          type: integer
          description: 거부된 세션 수
        in_review_count:
          type: integer
          description: 검토 중인 세션 수
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            이 사용자의 승인된 신분증 문서에서 확인된 발급 국가의 ISO 3166-1 alpha-3 코드 목록입니다(예:
            `["USA", "ESP"]`). 없는 경우 빈 배열입니다.
        approved_emails:
          type: array
          items:
            type: string
          description: '이 사용자의 승인된 세션에서 수집된 인증된 이메일 주소입니다(예: `["john@example.com"]`).'
        approved_phones:
          type: array
          items:
            type: string
          description: '이 사용자의 승인된 세션에서 수집된 인증된 전화번호입니다(예: `["+14155551234"]`).'
        features:
          type: object
          description: >-
            이 사용자의 모든 세션에 걸쳐 집계된 기능별 상태입니다. 가능한 키: `ID_VERIFICATION`, `NFC`,
            `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`,
            `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`,
            `AGE_ESTIMATION`, `DATABASE_VALIDATION`. 가능한 값: `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.