API para listar partes extraídas do KYB

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.list_kyb_extracted_parties(
    "33333333-4444-5555-6666-777777777777",
)
print(result)

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);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.ListKYBExtractedParties(ctx, "33333333-4444-5555-6666-777777777777", didit.SessionsListKYBExtractedPartiesParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

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);

<?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());

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));

{
  "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"
}

GET

session

{sessionId}

kyb

extracted-parties

Python

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.list_kyb_extracted_parties(
    "33333333-4444-5555-6666-777777777777",
)
print(result)

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);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.ListKYBExtractedParties(ctx, "33333333-4444-5555-6666-777777777777", didit.SessionsListKYBExtractedPartiesParams{})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

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);

<?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());

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));

{
  "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"
}

Autorizações

x-api-key

string

header

obrigatório

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.

Parâmetros de caminho

sessionId

string<uuid>

obrigatório

UUID da sessão de Verificação de empresas (KYB). Ela deve pertencer à aplicação da chave de API.

Exemplo:

"33333333-4444-5555-6666-777777777777"

Parâmetros de consulta

node_id

string

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.

Resposta

Partes nomeadas pelos documentos atuais.

parties

object[]

obrigatório

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.

Show child attributes

document_count

integer

obrigatório

Número de documentos enviados a partir dos quais a lista foi lida.

node_id

string | null

Última modificação em 1 de novembro de 2026