Pular para o conteúdo principal
GET
curl

Visão geral

Retorna uma única entidade de empresa identificada por vendor_data.

Quando usar

  • Consulte o estado de verificação atual de uma empresa: o mapa features mostra de relance o status mais recente de cada recurso de KYB.
  • Telas de detalhes na sua própria interface administrativa.
  • Pontuação de risco com base nos contadores agregados e nos status dos recursos.

Observações

  • vendor_data na URL diferencia letras maiúsculas de minúsculas.
  • Retorna 404 se não existir nenhuma empresa com esse vendor_data.
  • Os contadores agregados (session_count, approved_count, declined_count, in_review_count) são atualizados em tempo real à medida que as sessões de Verificação de empresas (KYB) são concluídas.
  • Os campos derivados do registro (legal_name, registration_number, country_code) refletem a sessão de Verificação de empresas (KYB) aprovada mais recente.

Permissões

A função deve conceder read:businesses.

Relacionados

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

vendor_data
string
obrigatório

Seu identificador exclusivo da empresa: uma string livre (NÃO um UUID), comparada exatamente como enviada.

Resposta

Detalhes completos da empresa, incluindo metadados e dados agregados das sessões.

Detalhes completos da empresa. Estende BusinessListItem com metadata e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para esta empresa.

vendor_data
string | null

Seu identificador exclusivo desta empresa (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado.

display_name
string | null

Nome de exibição personalizado definido por você

Razão social oficial obtida do registro de empresas ou inserida manualmente

registration_number
string | null

Número de registro ou de constituição da empresa

country_code
string | null

País de constituição (ISO 3166-1 alpha-2, por exemplo, GB, US).

effective_name
string | null

Melhor nome disponível: display_name, se definido; caso contrário, legal_name

status
enum<string>

Status do ciclo de vida do registro da empresa (NÃO é um status de sessão). ACTIVE é o padrão, FLAGGED o marca para atenção manual e BLOCKED impede novas sessões para este vendor_data.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Número total de sessões de verificação desta empresa

approved_count
integer

Número de sessões aprovadas

declined_count
integer

Número de sessões recusadas

in_review_count
integer

Número de sessões em revisão

features
object

Status agregado por recurso em todas as sessões de KYB desta empresa. Atualmente, a única chave é KYB (o status da verificação da empresa no registro). Valores possíveis: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Os mesmos dados de features, como um array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Data e hora da sessão mais recente

first_session_at
string<date-time> | null

Data e hora da primeira sessão

last_activity_at
string<date-time> | null

Data e hora da atividade mais recente (mudança de status, atualização da sessão etc.)

tags
object[]

Tags atribuídas a esta empresa

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que você anexou a esta empresa. O padrão é {}.

updated_at
string<date-time>
Última modificação em 1 de novembro de 2026