> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Modelo de dados de empresa: esquema KYB

> Modelo de entidade de empresa da Didit: dados de registro, UBOs, administradores, status AML, documentos, sessões KYB e transações vinculadas.

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](https://docs.didit.me/pt-br/entities/vendor-data-linking.md). |
| `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. |

> [!NOTE]
>
> `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](https://docs.didit.me/pt-br/entities/lifecycle.md). |

## 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`

```json theme={null}
{
  "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

```json theme={null}
{
  "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

> [card] [Operações](https://docs.didit.me/pt-br/entities/businesses/operations.md)
>
> Criar, atualizar, alterar o status, excluir.

> [card] [Histórico de KYB](https://docs.didit.me/pt-br/entities/businesses/kyb-history.md)
>
> Recupere todas as sessões vinculadas à empresa.

> [card] [Referência da API](https://docs.didit.me/pt-br/management-api/businesses/get.md)
>
> Esquema de GET /v3/businesses/{vendor_data}/.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.