Modelo de dados de empresa: esquema KYB

Esta página documenta cada campo em uma entidade Business e como a Didit preenche cada um deles.

Campos de identificação

Campo	Tipo	Descrição
`uuid`	UUID	Chave primária atribuída pela Didit. Estável e única.
`didit_internal_id`	string	Identificador interno legível por humanos.
`vendor_data`	string	Seu identificador para a empresa. Único por aplicação. Saiba mais.
`display_name`	string	Nome personalizado exibido no console. O padrão é `legal_name` ou `vendor_data`.
`legal_name`	string	Razão social da empresa conforme registrada, propagada a partir da consulta ao registro da sessão de Verificação de empresas (KYB) aprovada mais recente.
`registration_number`	string	Número de registro oficial da empresa, propagado a partir do registro.
`country_code`	string (ISO 3166-1 alpha-3)	País de constituição.

legal_name, registration_number e country_code são somente leitura quando derivados de uma consulta verificada ao registro. Eles podem ser substituídos manualmente no console ou via PATCH /v3/businesses/{vendor_data}/, mas as substituições ficam sinalizadas no registro de auditoria.

Status

Campo	Tipo	Valores	Descrição
`status`	enum	`ACTIVE`, `FLAGGED`, `BLOCKED`	Controla a aplicação de regras para sessões e transações futuras. Consulte o ciclo de vida.

Campos agregados de sessões

Campo	Tipo	Descrição
`session_count`	int	Total de sessões de Verificação de empresas (KYB) já criadas para esta empresa
`approved_count`	int	Sessões finalizadas com `Approved`
`declined_count`	int	Sessões finalizadas com `Declined`
`in_review_count`	int	Sessões atualmente `In Review`
`features`	object	Status da verificação mais recente da empresa, na chave `KYB`

O mapa `features`

{
  "KYB": "Approved"
}

O mapa contém uma única chave, KYB, com o status da verificação mais recente da empresa: "Not Finished", "Approved", "Declined", "In Review" ou "Resub Requested". Para o status de cada recurso de KYB individual, consulte a decisão da sessão. Use o mapa features como atalho para verificar se uma empresa está totalmente verificada neste momento, sem percorrer todas as sessões.

Registros de data e hora da atividade

Campo	Tipo	Atualizado quando
`first_session_at`	Timestamp ISO	A primeira sessão de Verificação de empresas (KYB) foi criada
`last_session_at`	Timestamp ISO	A sessão mais recente foi criada ou atualizada
`last_activity_at`	Timestamp ISO	Qualquer alteração: sessão, transação, status, perfil, notas
`created_at`	Timestamp ISO	A linha da entidade foi criada
`updated_at`	Timestamp ISO	A linha da entidade foi atualizada pela última vez

Metadados

Campo	Tipo	Descrição
`metadata`	object (JSON)	JSON de formato livre controlado por você
`tags[]`	array	Tags gerenciadas pelo Console ou pela API

Relações (não armazenadas no registro da empresa)

Relação	Como acessar
Sessões de Verificação de empresas (KYB)	`GET /v3/sessions?vendor_data=<value>`
Usuários vinculados (administradores, UBOs, diretores)	Exibidos na página de detalhes da empresa no console; derivados da sessão de Verificação de empresas (KYB) aprovada mais recente
Transações (como solicitante ou contraparte)	Filtre as transações pelo `vendor_data` da empresa
Documentos	Pelas decisões das sessões de Verificação de empresas (KYB)
Ocorrências de AML	Pelas decisões das sessões de Verificação de empresas (KYB)

Exemplo de resposta

{
  "uuid": "f7a9c1b2-4e6d-4f8a-9c5d-2a1b3c4d5e6f",
  "didit_internal_id": "B-2026-00018",
  "vendor_data": "biz-acme",
  "display_name": "Acme Corp",
  "legal_name": "Acme Corporation Limited",
  "registration_number": "12345678",
  "country_code": "GBR",
  "status": "ACTIVE",
  "session_count": 2,
  "approved_count": 1,
  "declined_count": 0,
  "in_review_count": 1,
  "features": {
    "KYB": "Approved"
  },
  "first_session_at": "2025-09-01T12:00:00Z",
  "last_session_at": "2026-04-01T09:00:00Z",
  "last_activity_at": "2026-04-16T10:00:00Z",
  "metadata": { "partner": "Acme Holdings" }
}

Próximos passos

Operações

Criar, atualizar, alterar o status, excluir.

Histórico de KYB

Recupere todas as sessões vinculadas à empresa.

Referência da API

Esquema de GET /v3/businesses//.

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

Visão geral

Preços

Fluxos e verificação

Revisão e operações

Entidades (usuários e empresas)

Configurações e personalização

Segurança e conformidade

Didit Academy

Recursos

Modelo de dados de empresa: esquema KYB

Campos de identificação

Status

Campos agregados de sessões

O mapa `features`

Registros de data e hora da atividade

Metadados

Relações (não armazenadas no registro da empresa)

Exemplo de resposta

Próximos passos

Operações

Histórico de KYB

Referência da API

​Campos de identificação

​Status

​Campos agregados de sessões

​O mapa features

​Registros de data e hora da atividade

​Metadados

​Relações (não armazenadas no registro da empresa)

​Exemplo de resposta

​Próximos passos

Operações

Histórico de KYB

Referência da API

Campos de identificação

Status

Campos agregados de sessões

O mapa `features`

Registros de data e hora da atividade

Metadados

Relações (não armazenadas no registro da empresa)

Exemplo de resposta

Próximos passos