Modelo de dados de empresas: esquema KYB

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

Campos de identidade

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.
`vendor_data`	string	O seu identificador para a empresa. Único por aplicação. Saiba mais.
`display_name`	string	Nome alternativo apresentado na consola. Por omissão, usa `legal_name` ou `vendor_data`.
`legal_name`	string	Denominação legal da empresa, tal como registada, propagada a partir da consulta ao registo feita na sessão de Verificação de empresas (KYB) aprovada mais recente.
`registration_number`	string	Número oficial de registo da empresa, propagado a partir do registo.
`country_code`	string (ISO 3166-1 alpha-3)	País de constituição.

legal_name, registration_number e country_code são só de leitura quando derivados de uma consulta verificada ao registo. Podem ser substituídos manualmente na consola ou através de PATCH /v3/businesses/{vendor_data}/, mas as substituições ficam assinaladas no registo de auditoria.

Estado

Campo	Tipo	Valores	Descrição
`status`	enum	`ACTIVE`, `FLAGGED`, `BLOCKED`	Controla a aplicação das regras nas 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) alguma vez criadas para esta empresa
`approved_count`	int	Sessões terminadas com `Approved`
`declined_count`	int	Sessões terminadas com `Declined`
`in_review_count`	int	Sessões atualmente `In Review`
`features`	object	Estado 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 estado da verificação mais recente da empresa: "Not Finished", "Approved", "Declined", "In Review" ou "Resub Requested". Para o estado de cada funcionalidade KYB individual, consulte a decisão da sessão. Use o mapa features como caminho rápido para verificar se uma empresa está totalmente verificada neste momento, sem percorrer todas as sessões.

Carimbos temporais de atividade

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

Metadados

Campo	Tipo	Descrição
`metadata`	object (JSON)	JSON de formato livre, controlado por si
`tags[]`	array	Etiquetas geridas na consola ou pela API

Relações (não armazenadas na linha da empresa)

Relação	Como aceder
Sessões de Verificação de empresas (KYB)	`GET /v3/sessions?vendor_data=<value>`
Utilizadores associados (responsáveis, beneficiários efetivos e administradores)	Apresentados na página de detalhe da empresa na consola; derivados da sessão de Verificação de empresas (KYB) aprovada mais recente
Transações (como requerente ou contraparte)	Filtrar transações pelo `vendor_data` da empresa
Documentos	Através das decisões das sessões de Verificação de empresas (KYB)
Correspondências AML	Através das 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 estado, eliminar.

Histórico KYB

Obter todas as sessões associadas à empresa.

Referência da API

Esquema de GET /v3/businesses//.

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

Visão geral

Preços

Fluxos e verificação

Revisão e operações

Entidades (utilizadores e empresas)

Definições e personalização

Segurança e conformidade

Didit Academy

Recursos

Modelo de dados de empresas: esquema KYB

Campos de identidade

Estado

Campos agregados de sessões

O mapa `features`

Carimbos temporais de atividade

Metadados

Relações (não armazenadas na linha da empresa)

Exemplo de resposta

Próximos passos

Operações

Histórico KYB

Referência da API

​Campos de identidade

​Estado

​Campos agregados de sessões

​O mapa features

​Carimbos temporais de atividade

​Metadados

​Relações (não armazenadas na linha da empresa)

​Exemplo de resposta

​Próximos passos

Operações

Histórico KYB

Referência da API

Campos de identidade

Estado

Campos agregados de sessões

O mapa `features`

Carimbos temporais de atividade

Metadados

Relações (não armazenadas na linha da empresa)

Exemplo de resposta

Próximos passos