> ## 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 में KYB सत्र के तैयार प्रमुख व्यक्तियों की घोषणा करें और जिन पक्षों को इसकी ज़रूरत है, उनका KYC सत्यापन शुरू करें।



## OpenAPI

````yaml hi/openapi-25.json POST /v3/session/{sessionId}/kyb/parties/submit/
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/submit/:
    post:
      tags:
        - Sessions
      summary: KYB पार्टी ड्राफ़्ट सबमिट करें
      description: >-
        संग्रहीत ड्राफ़्ट को कंपनी के प्रमुख व्यक्तियों के रूप में घोषित करें।
        यह आपकी API कुंजी के तहत होस्ट किया गया प्रमुख व्यक्ति चरण है: Didit
        वर्कफ़्लो की भूमिका सेटिंग्स और स्वामित्व थ्रेशोल्ड से यह तय करता है कि
        किन पक्षों को सत्यापित किया जाना चाहिए, उनमें से प्रत्येक के लिए एक
        व्यक्तिगत KYC सत्र (या कॉर्पोरेट स्वामी के लिए KYB सब-सत्र) बनाता है,
        वर्कफ़्लो द्वारा मांगे गए ईमेल भेजता है, और सत्र को आगे बढ़ाता है।
        प्रत्येक चाइल्ड सत्र का बिल होस्ट किए गए फ़्लो की तरह ही लिया जाता है।
        ड्राफ़्ट उपयोग कर लिए जाते हैं। एक सफल सबमिट के बाद कॉल दोहराने से कुछ
        नहीं बदलता है और यह `already_submitted: true` और पहले से मौजूद पक्षों के
        साथ `200` का उत्तर देता है। सत्र प्रमुख व्यक्ति चरण पर होना चाहिए।
        प्रत्येक व्यक्ति को उनका `kyc_session_url` भेजें, या इसे एम्बेड करें।
        इसके लिए `write:businesses` आवश्यक है।
      operationId: post_v3_session_kyb_parties_submit
      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
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                locale:
                  type: string
                  maxLength: 10
                  description: >-
                    सत्र जिस चरण में आगे बढ़ता है, उसके रिस्पॉन्स का अनुवाद करने
                    के लिए उपयोग किया जाने वाला लोकेल।
            example:
              locale: es
      responses:
        '200':
          description: घोषित (या पहले से घोषित) पक्ष।
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  next_step:
                    type: string
                    nullable: true
                    description: सत्र जिस चरण पर है।
                  status:
                    type: string
                    description: व्यवसाय सत्र की स्थिति।
                  advanced:
                    type: boolean
                    description: >-
                      `true` जब इस कॉल ने पक्षों की घोषणा की और सत्र को आगे
                      बढ़ाया।
                  already_submitted:
                    type: boolean
                    description: '`true` जब पक्षों को पहले के कॉल द्वारा घोषित किया गया था।'
                  kyb_key_people_status:
                    type: string
                  parties:
                    type: array
                    items:
                      $ref: '#/components/schemas/KYBKeyPeopleParty'
              example:
                valid: true
                next_step: FINISHED
                status: In Progress
                advanced: true
                already_submitted: false
                kyb_key_people_status: In Progress
                parties: []
        '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.
        '402':
          description: चाइल्ड सत्यापन सत्रों के लिए संगठन के पास कोई क्रेडिट नहीं बचा है।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: मानव-पठनीय त्रुटि संदेश।
              example:
                detail: Insufficient credits.
        '403':
          description: >-
            प्रमाणीकरण या प्राधिकरण विफलता। अनुपस्थित कुंजी `403` लौटाती है, और
            किसी अन्य एप्लिकेशन की कुंजी, इस endpoint के लिए आवश्यक अनुमति के
            बिना वाली स्कोप्ड कुंजी, तथा कुंजी की IP अनुमति सूची (allowlist) के
            बाहर से किया गया अनुरोध भी यही लौटाता है; गलत, निरस्त या समय-सीमा
            समाप्त कुंजी `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.
        '409':
          description: >-
            `kyb_no_party_drafts`: सबमिट करने के लिए कुछ भी नहीं है।
            `kyb_parties_already_submitted`: पार्टियों के घोषित होने के बाद
            ड्राफ़्ट जोड़े गए थे। `kyb_step_mismatch`: सत्र प्रमुख व्यक्ति चरण
            पर नहीं है (`next_step` इसके चरण का नाम बताता है)।
            `kyb_session_not_writable`: सत्र समाप्त हो चुका है।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: मानव-पठनीय त्रुटि संदेश।
                  code:
                    type: string
                  next_step:
                    type: string
              example:
                detail: There are no draft parties to submit.
                code: kyb_no_party_drafts
        '429':
          description: >-
            रेट लिमिट पार हो गई: प्रति मिनट प्रति API कुंजी 300 राइट (POST,
            PATCH, DELETE) अनुरोध। पुनः प्रयास करने से पहले `Retry-After` सेकंड
            प्रतीक्षा करें; `X-RateLimit-*` हेडर बजट दिखाते हैं।
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: मानव-पठनीय त्रुटि संदेश।
              examples:
                Rate limited:
                  summary: वर्तमान मिनट का बजट समाप्त हो गया
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
          headers:
            Retry-After:
              description: पुनः प्रयास करने से पहले प्रतीक्षा करने के सेकंड।
              schema:
                type: integer
                minimum: 1
                example: 30
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.submit_kyb_parties(
                "33333333-4444-5555-6666-777777777777",
                locale="es",
            )
            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.submitKybParties("33333333-4444-5555-6666-777777777777",
            {
              locale: "es",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.SubmitKYBParties(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsSubmitKYBPartiesParams{\n\tLocale: didit.String(\"es\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.SessionsSubmitKybPartiesParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.sessions().submitKybParties("33333333-4444-5555-6666-777777777777",
            SessionsSubmitKybPartiesParams.builder()
                    .locale("es")
                    .build());
            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->submitKybParties('33333333-4444-5555-6666-777777777777',
            [
                'locale' => 'es',
            ]);

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

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

            result = didit.sessions.submit_kyb_parties(
              "33333333-4444-5555-6666-777777777777",
              locale: "es"
            )
            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.SubmitKybPartiesAsync("33333333-4444-5555-6666-777777777777",
            new SessionsSubmitKybPartiesParams

            {
                Locale = "es",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    KYBKeyPeopleParty:
      type: object
      description: >-
        व्यवसाय सत्यापन (KYB) सत्र की एक प्रमुख व्यक्ति पार्टी, उसके चाइल्ड
        सत्यापन के साथ। वही पार्टी व्यवसाय सत्र निर्णय के
        `key_people_checks[].submitted.parties[]` में दिखाई देती है।
      required:
        - uuid
        - entity_type
        - source
        - name
        - is_active
        - is_skipped
        - requires_verification
        - roles
        - kyc_session_deleted
        - kyb_sub_session_deleted
      properties:
        uuid:
          type: string
          format: uuid
          description: पक्ष पहचानकर्ता।
        entity_type:
          type: string
          enum:
            - person
            - company
          description: क्या पक्ष कोई व्यक्ति है या कंपनी।
        source:
          type: string
          enum:
            - REGISTRY
            - USER
          description: >-
            `REGISTRY`: कंपनी रजिस्ट्री से लिया गया। `USER`: Key People स्क्रीन
            में दर्ज किया गया।
        name:
          type: string
          description: पक्ष का डिस्प्ले नाम।
        first_name:
          type: string
          nullable: true
          description: पहला नाम (व्यक्ति)।
        last_name:
          type: string
          nullable: true
          description: अंतिम नाम (व्यक्तियों का)।
        company_name:
          type: string
          nullable: true
          description: कंपनी का नाम (कंपनी पक्ष)।
        registration_number:
          type: string
          nullable: true
          description: कंपनी पंजीकरण संख्या (कंपनी पक्ष)।
        email:
          type: string
          format: email
          nullable: true
          description: वह ईमेल जिस पर सत्यापन लिंक भेजा जाता है।
        nationality:
          type: string
          nullable: true
          description: व्यक्तियों के लिए राष्ट्रीयता, कंपनियों के लिए निगमन का देश।
        phone_number:
          type: string
          nullable: true
          description: पक्ष के लिए एकत्र किया गया फ़ोन नंबर।
        date_of_birth:
          type: string
          format: date
          nullable: true
          description: जन्म तिथि (व्यक्ति)।
        position:
          type: string
          nullable: true
          description: मुक्त-पाठ पद का नाम (व्यक्तियों के लिए)।
        custom_fields:
          type: object
          additionalProperties: true
          description: >-
            वर्कफ़्लो-परिभाषित कस्टम फ़ील्ड जो पार्टी के लिए एकत्र किए गए हैं,
            फ़ील्ड कुंजी द्वारा अनुक्रमित।
        is_active:
          type: boolean
          description: क्या पक्ष सक्रिय है।
        is_skipped:
          type: boolean
          description: >-
            क्या पक्ष सत्यापन से मुक्त है। पुनः जनरेट करने पर यह साफ़ हो जाता
            है।
        requires_verification:
          type: boolean
          description: >-
            क्या भूमिका और स्वामित्व के नियमों को इस पक्ष के लिए सत्यापन की
            आवश्यकता है।
        roles:
          type: array
          description: कंपनी में पक्ष द्वारा धारित भूमिकाएं।
          items:
            type: object
            required:
              - role
              - ownership_percent
              - voting_percent
            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
                description: भूमिका कोड।
              ownership_percent:
                type: number
                nullable: true
                description: इस भूमिका के लिए स्वामित्व प्रतिशत, जब ज्ञात हो।
              voting_percent:
                type: number
                nullable: true
                description: इस भूमिका के लिए मतदान-अधिकार प्रतिशत, जब ज्ञात हो।
        kyc_session_id:
          type: string
          format: uuid
          nullable: true
          description: चाइल्ड व्यक्तिगत KYC सत्र (व्यक्ति)।
        kyc_session_status:
          type: string
          nullable: true
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
            - null
          description: >-
            चाइल्ड KYC सत्र की स्थिति। हटाया गया सत्र वही स्थिति बनाए रखता है जो
            हटाए जाने के समय उसकी थी।
        kyc_session_url:
          type: string
          format: uri
          nullable: true
          description: >-
            चाइल्ड KYC सत्र का होस्टेड लिंक। जब कोई नहीं है या इसे हटा दिया गया
            था, और बिना `sessions: write` वाली स्कोप्ड API कुंजी के लिए `null`।
        kyc_session_deleted:
          type: boolean
          description: चाइल्ड KYC सत्र हटा दिया गया था, इसलिए यह कभी सेटल नहीं हो सकता।
        kyb_sub_session_id:
          type: string
          format: uuid
          nullable: true
          description: चाइल्ड KYB सत्र (कंपनी पक्षकार)।
        kyb_sub_session_status:
          type: string
          nullable: true
          enum:
            - Not Started
            - In Progress
            - Approved
            - Declined
            - In Review
            - Expired
            - Abandoned
            - Kyc Expired
            - Resubmitted
            - Awaiting User
            - null
          description: चाइल्ड KYB सत्र की स्थिति।
        kyb_sub_session_url:
          type: string
          format: uri
          nullable: true
          description: >-
            चाइल्ड KYB सत्र का होस्टेड लिंक, उन्हीं `null` नियमों के साथ जो
            `kyc_session_url` के लिए हैं।
        kyb_sub_session_deleted:
          type: boolean
          description: '`kyc_session_deleted` का कंपनी-पक्ष समकक्ष।'
        verification_workflow_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - adaptive_age_verification
            - biometric_authentication
            - address_verification
            - questionnaire_verification
            - email_verification
            - phone_verification
            - null
          description: वर्कफ़्लो का प्रकार जिसे चाइल्ड सत्र चलाता है।
        verification_workflow_id:
          type: string
          format: uuid
          nullable: true
          description: वर्कफ़्लो जो चाइल्ड सत्र चलाता है।
        verification_workflow_label:
          type: string
          nullable: true
          description: उस वर्कफ़्लो का लेबल।
        verification_workflow_features:
          type: array
          nullable: true
          description: चाइल्ड सत्र के वर्कफ़्लो की सुविधाएँ उनकी वर्तमान स्थिति के साथ।
          items:
            type: object
            required:
              - feature
              - status
            properties:
              feature:
                type: string
                description: सुविधा कोड, उदाहरण के लिए `ID_VERIFICATION` या `LIVENESS`।
              status:
                type: string
                description: सुविधा स्थिति, चलने तक `Not Finished`।
        didit_internal_id:
          type: string
          format: uuid
          nullable: true
          description: सत्यापित व्यक्ति का Didit पहचानकर्ता, ज्ञात होने पर।
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
        से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
        किया जा सकता है: प्रति संसाधन 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.