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

# Listar rascunhos de partes KYB via API

> Liste as pessoas-chave que você está preparando para uma sessão KYB antes de enviá-las. Este endpoint da API da Didit retorna a lista.



## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/session/{sessionId}/kyb/parties/drafts/
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/parties/drafts/:
    get:
      tags:
        - Sessions
      summary: Listar os rascunhos de partes de KYB
      description: >-
        Lista as partes que você está preparando para esta sessão de KYB, das
        mais antigas para as mais recentes. Um rascunho não é uma parte
        declarada: ele não aparece na decisão nem no console e não cria nenhuma
        sessão de verificação até que você o envie com `POST
        /v3/session/{sessionId}/kyb/parties/submit/`. Requer `write:businesses`.
      operationId: get_v3_session_kyb_party_drafts
      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: Os rascunhos armazenados.
          content:
            application/json:
              schema:
                type: object
                properties:
                  parties:
                    type: array
                    items:
                      type: object
                      required:
                        - draft_id
                        - created_at
                        - updated_at
                        - party
                      properties:
                        draft_id:
                          type: string
                          format: uuid
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        party:
                          type: object
                          required:
                            - entity_type
                            - nationality
                          properties:
                            entity_type:
                              type: string
                              enum:
                                - person
                                - company
                              description: Se a parte é uma pessoa física ou uma empresa.
                            full_name:
                              type: string
                              maxLength: 255
                              description: >-
                                Nome completo de uma pessoa. Envie este campo ou
                                `first_name` e `last_name`.
                            first_name:
                              type: string
                              maxLength: 128
                            last_name:
                              type: string
                              maxLength: 128
                            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: >-
                                Função exercida pela parte. Intercambiável com
                                `roles`; quando ambos são enviados, eles são
                                mesclados.
                            roles:
                              type: array
                              items:
                                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: >-
                                Todas as funções que a parte exerce. Uma pessoa
                                precisa de pelo menos uma função (aqui ou em
                                `role`).
                            position:
                              type: string
                              maxLength: 128
                              description: Cargo de uma pessoa.
                            date_of_birth:
                              type: string
                              format: date
                              nullable: true
                            company_name:
                              type: string
                              maxLength: 255
                              description: >-
                                Nome de uma parte do tipo empresa. Obrigatório
                                quando `entity_type` é `company`.
                            registration_number:
                              type: string
                              maxLength: 100
                              description: Número de registro de uma parte que é empresa.
                            email:
                              type: string
                              format: email
                              description: >-
                                Para onde o link de verificação é enviado.
                                Obrigatório quando a parte precisa concluir a
                                verificação, o que depende das configurações de
                                função e dos limiares de propriedade do fluxo de
                                verificação (workflow).
                            ownership_percent:
                              type: number
                              nullable: true
                              description: Participação na empresa detida pela parte.
                            nationality:
                              type: string
                              maxLength: 100
                              description: >-
                                Nacionalidade de uma pessoa ou país de
                                constituição de uma empresa. Obrigatório para
                                todas as partes.
                            phone_number:
                              type: string
                              maxLength: 32
                            custom_fields:
                              type: object
                              additionalProperties: true
                              description: Campos extras definidos pelo fluxo.
                            skip_verification:
                              type: boolean
                              default: false
                              description: >-
                                Solicite que a verificação desta parte seja
                                pulada. Atendido apenas quando a função da parte
                                permite pular a verificação nas configurações de
                                Pessoas-chave do fluxo.
                  node_id:
                    type: string
                    nullable: true
              example:
                parties:
                  - draft_id: 5b0d7a52-9d3e-4f0c-8c6a-0e5f3a1b2c4d
                    created_at: '2026-10-31T10:00:00Z'
                    updated_at: '2026-10-31T10:00:00Z'
                    party:
                      entity_type: person
                      first_name: Ana
                      last_name: Lopez
                      roles:
                        - ubo
                        - director
                      ownership_percent: 60
                      nationality: MEX
                      email: ana.lopez@example.com
                      date_of_birth: '1984-06-12'
                node_id: node_kyb_key_people
        '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_party_drafts(
                "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.listKybPartyDrafts("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.ListKYBPartyDrafts(ctx, \"33333333-4444-5555-6666-777777777777\", didit.SessionsListKYBPartyDraftsParams{})\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().listKybPartyDrafts("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->listKybPartyDrafts('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_party_drafts("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.ListKybPartyDraftsAsync("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.