API de UBO do registro KYB: beneficiários finais

curl

curl -X POST https://verification.didit.me/v3/kyb/ubo/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "kyb_response_id": "69aeeb95febb0f1704042259",
    "vendor_data": "company-1234"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.kyb.listUbos({
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234",
});
console.log(result);

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

result, err := client.KYB.ListUBOs(ctx, didit.KYBRegistryCandidateRequest{
	KYBResponseID: "69aeeb95febb0f1704042259",
	VendorData:    didit.String("company-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.KYBRegistryCandidateRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.kyb().listUbos(KYBRegistryCandidateRequest.builder()
        .kybResponseId("69aeeb95febb0f1704042259")
        .vendorData("company-1234")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->kyb->listUbos([
    'kyb_response_id' => '69aeeb95febb0f1704042259',
    'vendor_data' => 'company-1234',
]);
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.Kyb.ListUbosAsync(new KYBRegistryCandidateRequest
{
    KybResponseId = "69aeeb95febb0f1704042259",
    VendorData = "company-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e",
  "kyb_registry": {
    "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d",
    "node_id": "feature_kyb_registry",
    "status": "In Review",
    "registry_status": "active",
    "data_resolved": true,
    "company_name": "Tesco PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "region": "",
    "company_type": "Public Limited Company",
    "incorporation_date": "1947-11-27",
    "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
    "tax_number": "GB412 8925 93",
    "risk_level": "low risk",
    "verification_status": "verified",
    "is_from_registry": true,
    "fetch_status": "resolved",
    "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "nature_of_business": null,
    "registered_capital": null,
    "registered_capital_amount": null,
    "registered_capital_currency": null,
    "website": "https://www.tesco.com/",
    "email": "customer.service@tesco.co.uk",
    "phone": "03301231688",
    "legal_entity_identifier": null,
    "location_of_registration": null,
    "financial_summary": {
      "currency": "Pound (£)",
      "total_number_of_shares": "8174378721",
      "meta_detail": {
        "Class_Of_Share": "Ordinary"
      }
    },
    "officers": [
      {
        "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b",
        "name": "CHRISTOPHER JON TAYLOR",
        "designation": "Secretary",
        "role": "secretary",
        "nationality": null,
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      },
      {
        "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c",
        "name": "MELISSA BETHELL",
        "designation": "Director",
        "role": "director",
        "nationality": "British",
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      }
    ],
    "beneficial_owners": [],
    "addresses": [
      {
        "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
        "type": "legal_entity_registry_address",
        "description": "registered office address"
      }
    ],
    "industries": null,
    "accounts": {
      "last_account": "26 February 2025",
      "next_account": "26 February 2026",
      "due_by_date": "26 August 2026"
    },
    "registry_data": {
      "ubo_resolution": {
        "parent_chain": [],
        "subsidiaries": [],
        "unresolved": []
      }
    },
    "user_provided_data": null,
    "confirmed_by_user_at": null,
    "last_console_edit_at": null,
    "is_editable": true
  },
  "vendor_data": "company-1234",
  "metadata": null,
  "created_at": "2026-06-11T10:45:00.000000+00:00"
}

POST

kyb

ubo

curl

curl -X POST https://verification.didit.me/v3/kyb/ubo/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "kyb_response_id": "69aeeb95febb0f1704042259",
    "vendor_data": "company-1234"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.kyb.listUbos({
  kyb_response_id: "69aeeb95febb0f1704042259",
  vendor_data: "company-1234",
});
console.log(result);

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

result, err := client.KYB.ListUBOs(ctx, didit.KYBRegistryCandidateRequest{
	KYBResponseID: "69aeeb95febb0f1704042259",
	VendorData:    didit.String("company-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.KYBRegistryCandidateRequest;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.kyb().listUbos(KYBRegistryCandidateRequest.builder()
        .kybResponseId("69aeeb95febb0f1704042259")
        .vendorData("company-1234")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->kyb->listUbos([
    'kyb_response_id' => '69aeeb95febb0f1704042259',
    'vendor_data' => 'company-1234',
]);
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.Kyb.ListUbosAsync(new KYBRegistryCandidateRequest
{
    KybResponseId = "69aeeb95febb0f1704042259",
    VendorData = "company-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "9d4f2c7a-1b3e-4a5c-8d6f-0e9a8b7c6d5e",
  "kyb_registry": {
    "uuid": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d",
    "node_id": "feature_kyb_registry",
    "status": "In Review",
    "registry_status": "active",
    "data_resolved": true,
    "company_name": "Tesco PLC",
    "registration_number": "00445790",
    "country_code": "GB",
    "region": "",
    "company_type": "Public Limited Company",
    "incorporation_date": "1947-11-27",
    "registered_address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
    "tax_number": "GB412 8925 93",
    "risk_level": "low risk",
    "verification_status": "verified",
    "is_from_registry": true,
    "fetch_status": "resolved",
    "alternative_names": "TESCO STORES (HOLDINGS) PUBLIC LIMITED COMPANY",
    "nature_of_business": null,
    "registered_capital": null,
    "registered_capital_amount": null,
    "registered_capital_currency": null,
    "website": "https://www.tesco.com/",
    "email": "customer.service@tesco.co.uk",
    "phone": "03301231688",
    "legal_entity_identifier": null,
    "location_of_registration": null,
    "financial_summary": {
      "currency": "Pound (£)",
      "total_number_of_shares": "8174378721",
      "meta_detail": {
        "Class_Of_Share": "Ordinary"
      }
    },
    "officers": [
      {
        "uuid": "a1b2c3d4-e5f6-4789-9a0b-1c2d3e4f5a6b",
        "name": "CHRISTOPHER JON TAYLOR",
        "designation": "Secretary",
        "role": "secretary",
        "nationality": null,
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      },
      {
        "uuid": "b2c3d4e5-f6a7-4890-8b1c-2d3e4f5a6b7c",
        "name": "MELISSA BETHELL",
        "designation": "Director",
        "role": "director",
        "nationality": "British",
        "is_active": true,
        "kyc_status": null,
        "kyc_session_url": null
      }
    ],
    "beneficial_owners": [],
    "addresses": [
      {
        "address": "Tesco House, Shire Park, Kestrel Way, Welwyn Garden City, United Kingdom, AL7 1GA",
        "type": "legal_entity_registry_address",
        "description": "registered office address"
      }
    ],
    "industries": null,
    "accounts": {
      "last_account": "26 February 2025",
      "next_account": "26 February 2026",
      "due_by_date": "26 August 2026"
    },
    "registry_data": {
      "ubo_resolution": {
        "parent_chain": [],
        "subsidiaries": [],
        "unresolved": []
      }
    },
    "user_provided_data": null,
    "confirmed_by_user_at": null,
    "last_console_edit_at": null,
    "is_editable": true
  },
  "vendor_data": "company-1234",
  "metadata": null,
  "created_at": "2026-06-11T10:45:00.000000+00:00"
}

Use este endpoint depois que POST /v3/kyb/search/ retornar empresas candidatas, quando você precisar dos beneficiários finais: os acionistas, além das pessoas físicas e das controladoras corporativas identificadas ao longo da cadeia de propriedade (registry_data.ubo_resolution). A cobrança segue o preço de UBO do país (preços por país). O nível entregue é o mais alto que o país e o registro conseguem fornecer, e registry_tier_delivered indica o que foi cobrado: shareholders quando o relatório não aponta nenhuma pessoa física como beneficiário final, basic quando não existe nenhum registro de propriedade (nesse caso, registry_ownership_status é unavailable) ou not_held quando a fonte de propriedade respondeu que não mantém essa empresa em seus registros (status de propriedade). Quando o relatório ainda está sendo preparado ou a seção de propriedade ainda não foi obtida do registro, o endpoint retorna 202 Accepted, kyb_registry.fetch_status: "pending", kyb_registry.registry_ownership_status: "pending" e registry_tier_delivered: null. Guarde o request_id retornado e consulte GET /v3/session/{request_id}/decision/ até que registry_checks[0].company.fetch_status seja resolved. A Didit conclui automaticamente o relatório pendente e cobra o nível entregue assim que ele fica pronto. Não repita a requisição de compra enquanto ela estiver pendente: cada novo POST cria uma requisição separada. Disponível apenas na v3. POST /v2/kyb/select/ e POST /v3/kyb/select/ mantêm seu contrato e seu preço.

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.

Corpo

application/json

kyb_response_id

string

obrigatório

Identificador do candidato retornado por POST /v3/kyb/search/ (kyb_registry.companies[].kyb_response_id). Efêmero: use-o logo após a busca que o gerou. Os identificadores podem ser longos, então armazene e envie o valor exatamente como retornado, sem cortar nem presumir um tamanho.

Maximum string length: 1024

Exemplo:

"69aeeb95febb0f1704042259"

vendor_data

string

Seu identificador para esta empresa; retornado na resposta e armazenado com a sessão da empresa.

metadata

object | null

JSON livre armazenado com a sessão de empresa e retornado na resposta.

save_api_request

boolean

padrão:true

Deve ser true (o padrão). As seleções de registro KYB são sempre persistidas para que o faturamento e a recuperação possam ser rastreados; false retorna 400.

Resposta

Relatório da empresa retornado e faturado no nível entregue. Relatórios de propriedade ainda em preparação podem retornar 202; guarde o request_id para recuperar a decisão salva.

request_id

string<uuid>

Id da sessão de empresa criada para esta consulta. O registro armazenado (visível no console) continua sendo atualizado se o registro de empresas responder depois da resposta.

registry_tier_requested

enum<string>

O nível que este endpoint vende: basic (Lite) para países selecionados, shareholders, ubo.

Opções disponíveis:

basic,

shareholders,

ubo

registry_tier_delivered

enum<string> | null

O nível efetivamente entregue e faturado. Inferior ao solicitado quando os registros do país não contêm dados de propriedade, quando o registro não possui informações de propriedade desta empresa ou quando o relatório resolvido de uma requisição ubo não indica nenhuma pessoa física como beneficiário final.

Opções disponíveis:

basic,

shareholders,

ubo,

null

kyb_registry

object

Perfil completo da empresa no registro.

Show child attributes

vendor_data

string | null

Eco dos vendor_data que você enviou.

metadata

object | null

Eco do metadata que você enviou.

created_at

string<date-time>

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