Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve uma única entidade Empresa identificada pelo vendor_data.

Quando usar

  • Consulta do estado de verificação atual de uma empresa: o mapa features mostra, de relance, o estado mais recente de cada funcionalidade KYB.
  • Vistas de detalhe no seu próprio painel de administração.
  • Pontuação de risco com base nos contadores agregados e nos estados das funcionalidades.

Notas

  • O vendor_data no URL é sensível a maiúsculas e minúsculas.
  • Devolve 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 obtidos do registo (legal_name, registration_number, country_code) refletem a sessão de Verificação de empresas (KYB) aprovada mais recente.

Permissões

A função tem de conceder read:businesses.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

vendor_data
string
obrigatório

O seu identificador exclusivo para a empresa — uma string de formato livre (NÃO um UUID), correspondida exatamente como enviada.

Resposta

Detalhe completo da empresa incluindo metadados e dados agregados da sessão.

Detalhe completo da empresa. Estende BusinessListItem com metadados e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para esta empresa.

vendor_data
string | null

O seu identificador exclusivo para esta empresa (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor.

display_name
string | null

Nome de apresentação personalizado definido por si

Denominação legal oficial proveniente do registo ou introduzida manualmente

registration_number
string | null

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

country_code
string | null

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

effective_name
string | null

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

status
enum<string>

Estado do ciclo de vida do registo da empresa (NÃO é um estado da sessão). ACTIVE é o padrão, FLAGGED marca-o para atenção manual, 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 para esta 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 análise

features
object

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

features_list
object[]

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

last_session_at
string<date-time> | null

Carimbo de data/hora da sessão mais recente

first_session_at
string<date-time> | null

Carimbo de data/hora da primeira sessão

last_activity_at
string<date-time> | null

Carimbo de data/hora da atividade mais recente (mudança de estado, atualização da sessão, etc.)

tags
object[]

Etiquetas atribuídas a esta empresa

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que associou a esta empresa. O valor predefinido é {}.

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