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

> اقرأ من المستندات المرفوعة إلى جلسة التحقق من الشركات (KYB) في Didit أسماء المساهمين والمديرين ونسب الملكية التي تذكرها تلك المستندات.



## OpenAPI

````yaml ar/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 هذه، مدمجين لكل شخص ومنسوبين إلى المستندات التي وردت أسماؤهم
        فيها. اعرضهم على مقدم الطلب للتأكيد، ثم أعلن عنهم باستخدام نقاط endpoint
        الخاصة بمسودات الأطراف. يظل النطاق نطاقاً: يحتفظ
        `ownership_percent.text` بالرقم الحرفي و`min` / `max` بالأرقام المقروءة
        منه. لا يتم تصنيف أي شخص على أنه UBO هنا؛ يتم تحديد ذلك عند إرسال
        الأطراف، استناداً إلى إعدادات الدور وحدود الملكية الخاصة بسير العمل.
        توجد نفس القائمة في قرار الجلسة كـ
        `document_verifications[].extracted_parties`. يتطلب `read:businesses` أو
        `read:sessions`.
      operationId: get_v3_session_kyb_extracted_parties
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            معرّف UUID لجلسة التحقق من الشركات (KYB). يجب أن تنتمي إلى التطبيق
            الخاص بمفتاح 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: يتم تحديد
                      ذلك عند إرسال الأطراف.
                  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: >-
            فشل في المصادقة أو التفويض. يؤدي المفتاح المفقود إلى إرجاع `403`،
            وكذلك المفتاح التابع لتطبيق آخر، أو المفتاح محدد النطاق الذي يفتقر
            إلى الإذن الذي يتطلبه هذا endpoint، أو الطلب الوارد من خارج قائمة IP
            المسموح بها للمفتاح؛ بينما يؤدي المفتاح الخاطئ أو الملغى أو منتهي
            الصلاحية إلى إرجاع `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 الخاص بتطبيقك، من Developers -> API keys في Business Console.
        يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا
        شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات
        المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن
        المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم
        إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو
        الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير
        404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة
        بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL
        للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك
        إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع
        https://docs.didit.me/console/api-keys.

````

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