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

# Enviar persones clau KYB: API

> Declara les persones clau preparades d'una sessió KYB i inicia la verificació KYC de cada part que la necessiti amb Didit.



## OpenAPI

````yaml ca/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 de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/session/{sessionId}/kyb/parties/submit/:
    post:
      tags:
        - Sessions
      summary: Envia els esborranys de les parts de KYB
      description: >-
        Declara els esborranys emmagatzemats com a persones clau de l'empresa.
        Aquest és el pas de Persones clau allotjat sota la teva clau d'API:
        Didit decideix a partir de la configuració de rols i els llindars de
        titularitat del flux de treball quines parts s'han de verificar, crea
        una sessió individual de KYC (o una subsessió de KYB per a un titular
        corporatiu) per a cadascuna d'elles, envia els correus electrònics que
        el flux de treball sol·licita i fa avançar la sessió. Cada sessió filla
        es factura com en el flux allotjat. Els esborranys es consumeixen.
        Repetir la crida després d'un enviament satisfactori no canvia res i
        respon `200` amb `already_submitted: true` i les persones que ja
        existeixen. La sessió ha d'estar al pas de Persones clau. Envia el camp
        `kyc_session_url` de cada persona directament a ella, o bé incrusta'l.
        Requereix `write:businesses`.
      operationId: post_v3_session_kyb_parties_submit
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID de la sessió de Verificació d'empreses (KYB). Ha de pertànyer a
            l'aplicació de la clau d'API.
          schema:
            type: string
            format: uuid
            example: 33333333-4444-5555-6666-777777777777
        - name: node_id
          in: query
          required: false
          description: >-
            Node del flux de treball del pas de KYB. Només cal quan el flux de
            treball té més d'un node de KYB; per defecte, Didit utilitza el node
            propi de la sessió.
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                locale:
                  type: string
                  maxLength: 10
                  description: >-
                    Configuració regional utilitzada per traduir la resposta del
                    pas al qual avança la sessió.
            example:
              locale: es
      responses:
        '200':
          description: Parts declarades (o ja declarades).
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                  next_step:
                    type: string
                    nullable: true
                    description: Pas en què es troba la sessió.
                  status:
                    type: string
                    description: Estat de la sessió d'empresa.
                  advanced:
                    type: boolean
                    description: >-
                      `true` quan aquesta crida ha declarat les parts i ha fet
                      avançar la sessió.
                  already_submitted:
                    type: boolean
                    description: >-
                      `true` quan les parts ja s'havien declarat en una crida
                      anterior.
                  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: >-
            La clau d'API amb abast ha caducat. Aquest és l'únic cas que retorna
            `401`: una clau absent, no vàlida o revocada retorna `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Expired key:
                  summary: La data de caducitat de la clau ha passat
                  value:
                    detail: This API key has expired.
        '402':
          description: >-
            L'organització s'ha quedat sense crèdit per a les sessions de
            verificació filles.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              example:
                detail: Insufficient credits.
        '403':
          description: >-
            Fallada d'autenticació o d'autorització. Si falta la clau es retorna
            `403`, igual que amb una clau d'una altra aplicació, una clau amb
            àmbit sense el permís que necessita aquest endpoint o una
            sol·licitud des de fora de la llista d'adreces IP permeses de la
            clau; una clau incorrecta, revocada o caducada retorna `401`.
            Distingeix-les pel camp `detail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Missing or invalid credentials:
                  summary: >-
                    Falta la capçalera x-api-key, o la clau ha fallat la
                    validació
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: >-
                    Una clau vàlida que pertany a una aplicació diferent de la
                    de la sessió
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions write:
                  summary: >-
                    A la clau amb abast li manca el permís d'escriptura de
                    decisions
                  value:
                    detail: This API key has no write access to decisions.
                IP not allowed:
                  summary: >-
                    Sol·licitud des de fora de la llista d'adreces IP permeses
                    de la clau
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            La sessió no existeix, s'ha suprimit, pertany a una altra aplicació
            o queda fora dels límits d'una clau amb abast limitat; cap detall no
            permet distingir entre aquests casos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              example:
                detail: Session not found.
        '409':
          description: >-
            `kyb_no_party_drafts`: no hi ha res a enviar.
            `kyb_parties_already_submitted`: s'han afegit esborranys després de
            declarar les parts. `kyb_step_mismatch`: la sessió no es troba al
            pas Persones clau (`next_step` n'indica el pas).
            `kyb_session_not_writable`: la sessió ha finalitzat.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
                  code:
                    type: string
                  next_step:
                    type: string
              example:
                detail: There are no draft parties to submit.
                code: kyb_no_party_drafts
        '429':
          description: >-
            S'ha superat el límit de freqüència: 300 sol·licituds d'escriptura
            (POST, PATCH, DELETE) per minut per clau d'API. Espera els segons
            indicats a `Retry-After` abans de reintentar; les capçaleres
            `X-RateLimit-*` mostren el pressupost restant.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Missatge d'error fàcil de llegir.
              examples:
                Rate limited:
                  summary: Pressupost per al minut actual esgotat
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
          headers:
            Retry-After:
              description: Segons que cal esperar abans de reintentar.
              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: >-
        Una part de persones clau d'una sessió de Verificació d'empreses (KYB),
        amb la seva verificació dependent. La mateixa part apareix a
        `key_people_checks[].submitted.parties[]` de la decisió de la sessió
        d'empresa.
      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: Identificador de la part.
        entity_type:
          type: string
          enum:
            - person
            - company
          description: Si la part és una persona física o una empresa.
        source:
          type: string
          enum:
            - REGISTRY
            - USER
          description: >-
            `REGISTRY`: obtingut del registre mercantil. `USER`: introduït a la
            pantalla Persones clau.
        name:
          type: string
          description: Nom visible de la part.
        first_name:
          type: string
          nullable: true
          description: Nom de pila (persones).
        last_name:
          type: string
          nullable: true
          description: Cognom (persones físiques).
        company_name:
          type: string
          nullable: true
          description: Nom de l'empresa (parts empresarials).
        registration_number:
          type: string
          nullable: true
          description: Número de registre de l'empresa (parts empresarials).
        email:
          type: string
          format: email
          nullable: true
          description: Correu electrònic al qual s'envia l'enllaç de verificació.
        nationality:
          type: string
          nullable: true
          description: Nacionalitat per a persones, país de constitució per a empreses.
        phone_number:
          type: string
          nullable: true
          description: Número de telèfon recollit per a la part.
        date_of_birth:
          type: string
          format: date
          nullable: true
          description: Data de naixement (persones).
        position:
          type: string
          nullable: true
          description: Càrrec de text lliure (per a persones).
        custom_fields:
          type: object
          additionalProperties: true
          description: >-
            Camps personalitzats definits pel flux de treball i recollits per a
            la part, indexats per clau de camp.
        is_active:
          type: boolean
          description: Si la part està activa.
        is_skipped:
          type: boolean
          description: Si la part està exempta de verificació. En regenerar-la, s'esborra.
        requires_verification:
          type: boolean
          description: >-
            Si les regles de rol i titularitat requereixen una verificació per a
            aquesta part.
        roles:
          type: array
          description: Rols que té la part a l'empresa.
          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: Codi de rol.
              ownership_percent:
                type: number
                nullable: true
                description: Percentatge de titularitat d'aquest rol, quan es conegui.
              voting_percent:
                type: number
                nullable: true
                description: Percentatge de drets de vot per a aquest rol, quan es coneix.
        kyc_session_id:
          type: string
          format: uuid
          nullable: true
          description: Sessió KYC individual filla (persones físiques).
        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: >-
            Estat de la sessió KYC filla. Una sessió eliminada manté l'estat que
            tenia quan es va eliminar.
        kyc_session_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Enllaç allotjat de la sessió de KYC filla. `null` quan no n'hi ha
            cap o s'ha suprimit, i per a una clau d'API amb àmbit restringit
            sense `sessions: write`.
        kyc_session_deleted:
          type: boolean
          description: >-
            La sessió fill de KYC s'ha suprimit, de manera que no es podrà
            liquidar mai.
        kyb_sub_session_id:
          type: string
          format: uuid
          nullable: true
          description: Sessió KYB filla (parts d'empresa).
        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: Estat de la sessió KYB filla.
        kyb_sub_session_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Enllaç allotjat de la sessió de KYB filla, amb les mateixes regles
            de `null` que `kyc_session_url`.
        kyb_sub_session_deleted:
          type: boolean
          description: Homòleg per a empreses de `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: Tipus del flux de treball que executa la sessió filla.
        verification_workflow_id:
          type: string
          format: uuid
          nullable: true
          description: Flux de treball que executa la sessió filla.
        verification_workflow_label:
          type: string
          nullable: true
          description: Etiqueta d'aquest flux de treball.
        verification_workflow_features:
          type: array
          nullable: true
          description: >-
            Funcionalitats del flux de treball de la sessió filla amb els seus
            estats actuals.
          items:
            type: object
            required:
              - feature
              - status
            properties:
              feature:
                type: string
                description: >-
                  Codi de la funcionalitat, per exemple `ID_VERIFICATION` o
                  `LIVENESS`.
              status:
                type: string
                description: Estat de la funcionalitat, `Not Finished` fins que s'executa.
        didit_internal_id:
          type: string
          format: uuid
          nullable: true
          description: Identificador de Didit de la persona verificada, un cop conegut.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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