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

# API para listar partes extraídas do KYB

> Com a API da Didit, leia os acionistas, diretores e percentuais de propriedade citados nos documentos enviados a uma sessão de KYB.



## OpenAPI

````yaml pt-br/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 de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/session/{sessionId}/kyb/extracted-parties/:
    get:
      tags:
        - Sessions
      summary: Listar as partes citadas nos documentos enviados
      description: >-
        Retorna os acionistas e diretores citados nos documentos enviados para
        esta sessão de KYB, consolidados por pessoa e atribuídos aos documentos
        que os citaram. Mostre-os ao solicitante para confirmação e, em seguida,
        declare-os com os endpoints de rascunho de partes. Um intervalo continua
        sendo um intervalo: `ownership_percent.text` mantém o valor literal, e
        `min` / `max` os números extraídos dele. Ninguém é classificado como UBO
        aqui; isso é decidido quando as partes são enviadas, com base nas
        configurações de função e nos limiares de propriedade do fluxo. A mesma
        lista está na decisão da sessão como
        `document_verifications[].extracted_parties`. Requer `read:businesses`
        ou `read:sessions`.
      operationId: get_v3_session_kyb_extracted_parties
      parameters:
        - name: sessionId
          in: path
          required: true
          description: >-
            UUID da sessão de Verificação de empresas (KYB). Ela deve pertencer
            à aplicação da chave de API.
          schema:
            type: string
            format: uuid
            example: 33333333-4444-5555-6666-777777777777
        - name: node_id
          in: query
          required: false
          description: >-
            Nó do fluxo da etapa de KYB. Necessário apenas quando o fluxo tem
            mais de um nó de KYB; por padrão, a Didit usa o próprio nó da
            sessão.
          schema:
            type: string
      responses:
        '200':
          description: Partes nomeadas pelos documentos atuais.
          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: >-
                                      O percentual de propriedade exatamente
                                      como o documento o informa, como `25-50%`,
                                      `>50%` ou `NO EXHIBE`.
                                  min:
                                    type: number
                                    nullable: true
                                    description: >-
                                      O número menor lido de `text`; null quando
                                      o texto não informa nenhum.
                                  max:
                                    type: number
                                    nullable: true
                                    description: >-
                                      Número superior extraído de `text`; null
                                      quando não houver nenhum.
                        documents:
                          type: array
                          description: Os documentos enviados que mencionaram esta parte.
                          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: >-
                      Os acionistas e diretores mencionados nos documentos
                      enviados, consolidados por pessoa. Ninguém é classificado
                      como UBO aqui: isso é decidido quando as partes são
                      enviadas.
                  document_count:
                    type: integer
                    description: >-
                      Número de documentos enviados a partir dos quais a lista
                      foi lida.
                  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: >-
            A chave de API com escopo expirou. Este é o único caso que retorna
            `401`: uma chave ausente, inválida ou revogada retorna `403`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Expired key:
                  summary: A data de validade da chave já passou
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Falha de autenticação ou autorização. Uma chave ausente retorna
            `403`, assim como uma chave de outra aplicação, uma chave com escopo
            sem a permissão exigida por este endpoint e uma requisição de fora
            da lista de IPs permitidos da chave; uma chave incorreta, revogada
            ou expirada retorna `401`. Diferencie-as pelo `detail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              examples:
                Missing or invalid credentials:
                  summary: Cabeçalho x-api-key ausente, ou a chave falhou na validação
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Other application:
                  summary: >-
                    Uma chave válida que pertence a uma aplicação diferente da
                    aplicação da sessão
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without decisions write:
                  summary: 'Chave com escopo sem decisions: write'
                  value:
                    detail: This API key has no write access to decisions.
                IP not allowed:
                  summary: Requisição de fora da lista de IPs permitidos da chave
                  value:
                    detail: This API key can't be used from this IP address.
        '404':
          description: >-
            A sessão não existe, foi excluída, pertence a outra aplicação ou
            está fora dos limites de uma chave com escopo; nenhum detalhe
            diferencia esses casos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Mensagem de erro legível.
              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: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
        a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
        uma data de validade. 401 significa que a chave está errada, revogada ou
        expirada; 403 significa que nenhuma chave foi enviada, que a chave não
        tem acesso a este recurso ou ação, ou que a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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