> ## 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: 벤더 KYB 엔티티

> vendor_data로 단일 Didit 기업(KYB)을 조회합니다. 등록부 기반 신원 정보, 상태, 집계된 KYB 카운터, features 맵을 반환합니다. 호출당 과금.



기업 조회 프롬프트
        프롬프트를 클립보드에 복사



      
      

\<pre>

\`Goal: Fetch a single Didit Business (KYB) entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/businesses/{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 normalisation. URL-encode it.

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

Response 200 (BusinessDetailItem) — 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, legal_name, registration_number, country_code, region, effective_name
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map: KYB_REGISTRY, KYB_AML, KYB_DOCUMENTS, ... -> latest status)
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log)
\- tags, created_at, updated_at, last_activity_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as Business Verification (KYB) sessions reach terminal status.
\- Registry-derived fields reflect the latest approved KYB session's registry data.
\- For bulk lookups, prefer paging GET /v3/businesses/ and indexing locally on vendor_data.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing/invalid x-api-key.
\- 403 — lacks read:businesses.
\- 404 — no business 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/businesses/overview.md)를 반환합니다.## 사용 시점- 기업의 현재 인증 상태를 **조회**합니다. `features` 맵에서 모든 KYB 기능의 최신 상태를 한눈에 확인할 수 있습니다.
- 자체 관리자 UI의 **상세 보기**.
- 누적 카운터와 기능 상태를 사용한 **위험 점수 산정**.## 참고 사항- URL의 `vendor_data`는 대소문자를 구분합니다.
- 해당 `vendor_data`를 가진 기업이 없으면 `404`를 반환합니다.
- 누적 카운터(`session_count`, `approved_count`, `declined_count`, `in_review_count`)는 기업 확인(KYB) 세션이 완료되면 실시간으로 업데이트됩니다.
- 등기부에서 가져온 필드(`legal_name`, `registration_number`, `country_code`)는 가장 최근에 승인된 기업 확인(KYB) 세션을 반영합니다.## 권한역할에 `read:businesses` 권한이 있어야 합니다.## 관련 문서- [기업 개요](https://docs.didit.me/ko/entities/businesses/overview.md)
- [데이터 모델](https://docs.didit.me/ko/entities/businesses/data-model.md)
- [기업 목록 조회](https://docs.didit.me/ko/management-api/businesses/list.md)


## OpenAPI

````yaml ko/openapi-25.json GET /v3/businesses/{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/businesses/{vendor_data}/:
    get:
      tags:
        - Businesses
      summary: 기업 조회
      description: >-
        `vendor_data`(정확히 일치)로 특정 [기업](/entities/businesses)을 가져옵니다. 목록 뷰에
        `metadata` 및 `updated_at`을 추가합니다. 삭제된 기업은 404를 반환합니다.
      operationId: get_business
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: 귀하가 지정한 기업의 고유 식별자입니다. 자유 형식 문자열(UUID 아님)이며, 전송된 값과 정확히 일치해야 합니다.
          example: company-123
      responses:
        '200':
          description: 메타데이터 및 집계된 세션 데이터를 포함한 전체 기업 상세 정보입니다.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Active business:
                  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: ACTIVE
                    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'
        '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/businesses/company-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.businesses.retrieve(
                "company-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.businesses.retrieve("company-123");
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Retrieve(ctx, \"company-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.businesses().retrieve("company-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->businesses->retrieve('company-123');
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

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