> ## 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 pessoas-chave KYB na API > Na Didit, liste as pessoas-chave que está a preparar para uma sessão de verificação de empresas (KYB) antes de as submeter. ## OpenAPI ````yaml pt/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: >- Liste as partes que está a preparar para esta sessão de KYB, as mais antigas primeiro. Um rascunho não é uma parte declarada: não aparece na decisão nem na consola e não cria nenhuma sessão de verificação até que o submeta 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). Tem de 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 do passo de KYB. Apenas necessário quando o fluxo tem mais de um nó de KYB; por predefinição, a Didit utiliza o nó próprio da sessão. schema: type: string responses: '200': description: Os rascunhos guardados. 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 singular 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 desempenhada pela parte. Intercambiável com `roles`; quando ambas forem enviadas, são combinadas. 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: >- Cada função que a parte desempenha. Uma pessoa necessita 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 da empresa. Obrigatório quando `entity_type` é `company`. registration_number: type: string maxLength: 100 description: Número de registo de uma entidade empresarial. email: type: string format: email description: >- Para onde a ligação de verificação é enviada. Obrigatório quando a parte tem de concluir a verificação, o que depende das definições de funções e dos limiares de propriedade do fluxo. ownership_percent: type: number nullable: true description: Percentagem da empresa que a parte detém. 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 adicionais definidos pelo fluxo. skip_verification: type: boolean default: false description: >- Pedir para ignorar a verificação desta parte. Respeitado apenas quando a função da parte permite ignorar nas definiçõ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 âmbito expirou. Este é o único caso que devolve `401`: uma chave em falta, inválida ou revogada devolve `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 em falta devolve `403`, assim como uma chave de outra aplicação, uma chave com âmbito restrito sem a permissão que este endpoint requer e um pedido proveniente de fora da lista de IPs permitidos da chave; uma chave incorreta, revogada ou expirada devolve `401`. Distinga-as através de `detail`. content: application/json: schema: type: object properties: detail: type: string description: Mensagem de erro legível. examples: Missing or invalid credentials: summary: Sem cabeçalho x-api-key ou a chave falhou a 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 sessão value: detail: You do not have permission to perform this action. Scoped key without decisions write: summary: 'Chave com âmbito não tem decisions: write' value: detail: This API key has no write access to decisions. IP not allowed: summary: >- Pedido proveniente de fora da lista de permissões de IP da chave value: detail: This API key can't be used from this IP address. '404': description: >- A sessão não existe, foi eliminada, pertence a outra aplicação ou está fora dos limites de uma chave com âmbito restrito; nenhum detalhe os distingue. 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: >- 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: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.