> ## 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.

# KYB主要人物ドラフト一覧取得API

> DiditのAPIで、KYBセッションに向けて準備中の主要人物を、提出前に一覧で取得します。まだ提出していない主要人物のドラフトが対象です。



## OpenAPI

````yaml ja/openapi-25.json GET /v3/session/{sessionId}/kyb/parties/drafts/
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/session/{sessionId}/kyb/parties/drafts/:
    get:
      tags:
        - Sessions
      summary: KYB関係者の下書きを一覧表示
      description: >-
        このKYBセッション用に準備中の当事者を古い順に一覧表示します。下書きは申告済みの当事者ではありません。`POST
        /v3/session/{sessionId}/kyb/parties/submit/`で送信するまで、判定やコンソールには表示されず、認証セッションも作成されません。`write:businesses`が必要です。
      operationId: get_v3_session_kyb_party_drafts
      parameters:
        - name: sessionId
          in: path
          required: true
          description: 法人確認 (KYB) セッションのUUIDです。APIキーのアプリケーションに属している必要があります。
          schema:
            type: string
            format: uuid
            example: 33333333-4444-5555-6666-777777777777
        - name: node_id
          in: query
          required: false
          description: >-
            KYBステップのワークフローノード。ワークフローに複数のKYBノードがある場合にのみ必要です。デフォルトでは、Diditはセッション自身のノードを使用します。
          schema:
            type: string
      responses:
        '200':
          description: 保存された下書き。
          content:
            application/json:
              schema:
                type: object
                properties:
                  parties:
                    type: array
                    items:
                      type: object
                      required:
                        - draft_id
                        - created_at
                        - updated_at
                        - party
                      properties:
                        draft_id:
                          type: string
                          format: uuid
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        party:
                          type: object
                          required:
                            - entity_type
                            - nationality
                          properties:
                            entity_type:
                              type: string
                              enum:
                                - person
                                - company
                              description: 当事者が個人か企業か。
                            full_name:
                              type: string
                              maxLength: 255
                              description: >-
                                人物の氏名。これを送信するか、`first_name`と`last_name`を送信してください。
                            first_name:
                              type: string
                              maxLength: 128
                            last_name:
                              type: string
                              maxLength: 128
                            role:
                              type: string
                              enum:
                                - director
                                - non_executive_director
                                - secretary
                                - chairman
                                - ubo
                                - shareholder
                                - representative
                                - founder
                                - legal_advisor
                                - authorized_signatory
                                - trustee
                                - beneficiary
                                - settlor
                                - protector
                                - company_officer
                                - investor
                                - other
                              description: 当事者が持つ役割。`roles`と互換性があり、両方が送信された場合は統合されます。
                            roles:
                              type: array
                              items:
                                type: string
                                enum:
                                  - director
                                  - non_executive_director
                                  - secretary
                                  - chairman
                                  - ubo
                                  - shareholder
                                  - representative
                                  - founder
                                  - legal_advisor
                                  - authorized_signatory
                                  - trustee
                                  - beneficiary
                                  - settlor
                                  - protector
                                  - company_officer
                                  - investor
                                  - other
                              description: >-
                                当事者が持つすべての役割です。個人には少なくとも1つの役割(ここまたは`role`で指定)が必要です。
                            position:
                              type: string
                              maxLength: 128
                              description: 人物の役職。
                            date_of_birth:
                              type: string
                              format: date
                              nullable: true
                            company_name:
                              type: string
                              maxLength: 255
                              description: 企業当事者の名称。`entity_type`が`company`の場合は必須です。
                            registration_number:
                              type: string
                              maxLength: 100
                              description: 企業当事者の登記番号。
                            email:
                              type: string
                              format: email
                              description: >-
                                認証リンクの送信先です。当事者が検証を完了する必要がある場合は必須です。これはワークフローの役割設定と所有構造のしきい値によって決まります。
                            ownership_percent:
                              type: number
                              nullable: true
                              description: 当事者が保有する会社の持分割合。
                            nationality:
                              type: string
                              maxLength: 100
                              description: 個人の国籍、または企業の設立国。すべての当事者で必須です。
                            phone_number:
                              type: string
                              maxLength: 32
                            custom_fields:
                              type: object
                              additionalProperties: true
                              description: ワークフローで定義された追加フィールド。
                            skip_verification:
                              type: boolean
                              default: false
                              description: >-
                                この当事者の認証のスキップを申請します。ワークフローの主要人物設定で、当事者の役割にスキップが許可されている場合にのみ受け付けられます。
                  node_id:
                    type: string
                    nullable: true
              example:
                parties:
                  - draft_id: 5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d
                    created_at: '2026-10-31T10:00:00Z'
                    updated_at: '2026-10-31T10:00:00Z'
                    party:
                      entity_type: person
                      first_name: Ana
                      last_name: Lopez
                      roles:
                        - ubo
                        - director
                      ownership_percent: 60
                      nationality: MEX
                      email: ana.lopez@example.com
                      date_of_birth: '1984-06-12'
                node_id: node_kyb_key_people
        '401':
          description: >-
            スコープ付きAPIキーの有効期限が切れています。`401`が返されるのはこの場合のみです。キーが指定されていない場合、無効な場合、または取り消されている場合は`403`が返されます。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              examples:
                Expired key:
                  summary: キーの有効期限が過ぎています
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            認証または認可に失敗しました。キーがない場合、別のアプリケーションのキーの場合、このエンドポイントに必要な権限を持たないスコープ付きキーの場合、キーのIP許可リスト外からのリクエストの場合は`403`を返し、誤った、失効した、または期限切れのキーの場合は`401`を返します。`detail`で区別してください。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              examples:
                Missing or invalid credentials:
                  summary: x-api-keyヘッダーがないか、キーの検証に失敗しました
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: セッションとは別のアプリケーションに属する有効なキー
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions write:
                  summary: 'スコープ付きキーにdecisions: write権限がない'
                  value:
                    detail: This API key has no write access to decisions.
                IP not allowed:
                  summary: キーのIP許可リスト外からのリクエスト
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            セッションが存在しない、削除されている、別のアプリケーションに属している、またはスコープ付きキーの制限外です。これらを区別する詳細は返されません。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: 人が読めるエラーメッセージ。
              example:
                detail: Session not found.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.list_kyb_party_drafts(
                "33333333-4444-5555-6666-777777777777",
            )
            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.sessions.listKybPartyDrafts("33333333-4444-5555-6666-777777777777");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.ListKYBPartyDrafts(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBPartyDraftsParams{})\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.sessions().listKybPartyDrafts("33333333-4444-5555-6666-777777777777");

            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->sessions->listKybPartyDrafts('33333333-4444-5555-6666-777777777777');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.sessions.list_kyb_party_drafts("33333333-4444-5555-6666-777777777777")

            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.Sessions.ListKybPartyDraftsAsync("33333333-4444-5555-6666-777777777777");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API
        keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

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