> ## 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/extracted-parties/
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/extracted-parties/:
    get:
      tags:
        - Sessions
      summary: アップロードされた書類に記載された当事者を一覧表示
      description: >-
        このKYBセッションにアップロードされた書類に記載されている株主と取締役を、人物ごとに統合し、その人物を記載した書類に紐づけて返します。申請者に提示して確認してもらい、その後パーティのドラフトエンドポイントで申告してください。範囲は範囲のまま保持されます。`ownership_percent.text`には記載どおりの数値が、`min`
        /
        `max`にはそこから読み取った数値が入ります。ここでは誰もUBOとして分類されません。UBOかどうかは、パーティの送信時に、ワークフローの役割設定と所有構造のしきい値に基づいて判断されます。同じリストは、セッションの判定に`document_verifications[].extracted_parties`として含まれています。`read:businesses`または`read:sessions`が必要です。
      operationId: get_v3_session_kyb_extracted_parties
      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
                required:
                  - parties
                  - document_count
                properties:
                  parties:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        entity_type:
                          type: string
                          enum:
                            - person
                            - company
                        first_name:
                          type: string
                          nullable: true
                        last_name:
                          type: string
                          nullable: true
                        appointment_date:
                          type: string
                          nullable: true
                        designation:
                          type: string
                          nullable: true
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              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
                              ownership_percent:
                                type: object
                                properties:
                                  text:
                                    type: string
                                    nullable: true
                                    description: >-
                                      `25-50%`、`>50%`、`NO
                                      EXHIBE`など、書類に記載されているとおりの所有比率。
                                  min:
                                    type: number
                                    nullable: true
                                    description: '`text`から読み取った小さい方の数値。記載がない場合はnullです。'
                                  max:
                                    type: number
                                    nullable: true
                                    description: '`text`から読み取った上限の数値。記載がない場合はnullです。'
                        documents:
                          type: array
                          description: この当事者を記載していたアップロード済みの書類。
                          items:
                            type: object
                            properties:
                              document_uuid:
                                type: string
                                format: uuid
                              document_type:
                                type: string
                                nullable: true
                              document_subtype:
                                type: string
                                nullable: true
                              original_filename:
                                type: string
                                nullable: true
                              status:
                                type: string
                                nullable: true
                    description: >-
                      アップロードされた書類に記載された株主と取締役を、人物ごとにまとめたものです。ここでは誰もUBOとして分類されません。UBOかどうかは当事者の提出時に決定されます。
                  document_count:
                    type: integer
                    description: リストの読み取り元となったアップロード済み書類の数です。
                  node_id:
                    type: string
                    nullable: true
              example:
                parties:
                  - name: Ana Lopez
                    entity_type: person
                    first_name: Ana
                    last_name: Lopez
                    appointment_date: null
                    designation: Administrador unico
                    roles:
                      - role: shareholder
                        ownership_percent:
                          text: 60%
                          min: 60
                          max: 60
                    documents:
                      - document_uuid: 0a3f1e2c-7c2f-4a1b-9d55-2f8d2a5d6b41
                        document_type: OWNERSHIP_STRUCTURE
                        document_subtype: ARTICLES_OF_INCORPORATION
                        original_filename: acta_constitutiva.pdf
                        status: Approved
                document_count: 1
                node_id: node_kyb_documents
        '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_extracted_parties(
                "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.listKybExtractedParties("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.ListKYBExtractedParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBExtractedPartiesParams{})\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().listKybExtractedParties("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->listKybExtractedParties('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_extracted_parties("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.ListKybExtractedPartiesAsync("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.