> ## 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: 벤더 사용자 엔티티

> vendor_data로 Didit 벤더 사용자 한 명을 조회해 신원 정보, 상태, KYC 카운터, 기능 맵을 가져옵니다. 영구 KYC 신원, 호출당 과금.



사용자 조회 프롬프트
        프롬프트를 클립보드에 복사



      
      

\<pre>

\`Goal: Fetch a single Didit User entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, full_name, date_of_birth, effective_name, portrait_image_url
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map of feature -> latest status)
\- approved_emails, approved_phones, issuing_states
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log: status changes, manual notes, system events)
\- created_at, updated_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as sessions reach terminal status.
\- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing or invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 404 — no user with that vendor_data in this application.
\- 429 — rate-limited.

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

\</pre>



      
      

붙여넣을 곳

## 개요`vendor_data`로 식별되는 단일 [사용자 엔티티](https://docs.didit.me/ko/entities/users/overview.md)를 반환합니다. 응답에는 Didit의 안정적인 내부 식별자인 `didit_internal_id`가 포함됩니다.## 사용 시기- **조회**: 사용자의 현재 인증 상태를 확인합니다. `features` 맵에서 단일 객체로 모든 기능의 최신 상태를 확인할 수 있습니다.
- **상세 보기**: 자체 UI를 렌더링하기 전에 필요할 때 프로필을 가져옵니다.
- **위험 점수 산정**: 세션 카운터와 `features`를 조합하여 자체 시스템에서 사용자별 위험 점수를 산정합니다.## 참고 사항- URL의 `vendor_data`는 대소문자를 구분합니다.
- 애플리케이션에 해당 `vendor_data`를 가진 사용자가 없으면 `404`를 반환합니다.
- 집계 카운터(`session_count`, `approved_count`, `declined_count`, `in_review_count`)는 세션이 완료될 때 실시간으로 업데이트됩니다.
- 각 필드에 대해서는 [사용자 데이터 모델](https://docs.didit.me/ko/entities/users/data-model.md)을 참조하십시오.## 권한애플리케이션의 활성 API 키라면 누구나 이 endpoint를 호출할 수 있습니다. Didit API 키는 **역할이 아닌 애플리케이션 범위**에 속합니다. Console의 [역할 및 권한](https://docs.didit.me/ko/console/roles-permissions.md)(`read:users` 등)은 Console에서 *사람*이 수행할 수 있는 작업을 결정하며, Management API 트래픽에는 적용되지 않습니다. 이 엔드포인트의 호출 권한은 애플리케이션의 API 키를 읽을 수 있는 대상을 관리하여 통제하십시오.## 관련 항목- [사용자 개요](https://docs.didit.me/ko/entities/users/overview.md)
- [데이터 모델](https://docs.didit.me/ko/entities/users/data-model.md)
- [사용자 목록 조회](https://docs.didit.me/ko/management-api/users/list.md)


## OpenAPI

````yaml ko/openapi-25.json GET /v3/users/{vendor_data}/
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}/:
    get:
      tags:
        - Users
      summary: 사용자 가져오기
      description: >-
        `vendor_data`(정확히 일치)로 [사용자](/entities/users) 한 명을 조회합니다. 목록 뷰에
        `metadata`, `comments`, `updated_at`을 추가하고, `tags`를 상세 태그 링크 형태로 전환합니다.
      operationId: get_user
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            귀하가 지정한 사용자의 고유 식별자입니다. 자유 형식 문자열(UUID 아님)입니다. 이 사용자를 처음 등록한 세션을 생성할
            때 `vendor_data`로 전달한 값과 동일하며, 전송된 값과 정확히 일치해야 합니다.
          example: user-abc-123
      responses:
        '200':
          description: 메타데이터, 댓글/활동 로그 및 집계된 세션 데이터를 포함한 전체 사용자 세부정보입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailItem'
              examples:
                Active user:
                  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: ACTIVE
                    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: null
                        actor_email: analyst@acme.com
                        actor_name: Jane Analyst
                        previous_status: FLAGGED
                        new_status: ACTIVE
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        mentioned_emails: []
                        created_at: '2025-06-01T10:30:00Z'
                    created_at: '2025-06-01T08:00:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
        '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: >-
            유효하지 않거나 해지된 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 GET 'https://verification.didit.me/v3/users/user-abc-123/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.users.retrieve(
                "user-abc-123",
            )
            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.retrieve("user-abc-123");
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.users().retrieve("user-abc-123");
            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->retrieve('user-abc-123');
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.users.retrieve("user-abc-123")
            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.RetrieveAsync("user-abc-123");
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    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.