Operações de empresas: CRUD de fornecedores KYB

Todo o gerenciamento da entidade Business acontece por meio de seis endpoints públicos em /v3/businesses/. Esta página apresenta uma visão geral conceitual. Consulte a referência da API para ver os esquemas completos de requisição e resposta.

Listar empresas

GET /v3/businesses/ Lista paginada das empresas da sua aplicação, com filtros por status, busca, país e intervalo de datas.

curl -G https://verification.didit.me/v3/businesses/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "status=ACTIVE" \
  --data-urlencode "country_code=GBR" \
  --data-urlencode "page_size=50"

Obter uma empresa

GET /v3/businesses/{vendor_data}/ Recupere uma empresa por vendor_data.

curl https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY"

Criar uma empresa

POST /v3/businesses/create/ Crie uma empresa antes de executar qualquer sessão de Verificação de empresa (KYB):

curl -X POST https://verification.didit.me/v3/businesses/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "biz-acme",
    "display_name": "Acme Corp",
    "country_code": "GBR",
    "metadata": { "partner": "Acme Holdings" }
  }'

Retorna um erro de conflito se já existir uma empresa com esse vendor_data. Use PATCH para atualizar uma empresa existente.

Atualizar uma empresa

PATCH /v3/businesses/{vendor_data}/ Atualize os campos editáveis do perfil. Os campos obtidos de consultas a registros (legal_name, registration_number, country_code) tornam-se somente leitura após a verificação, mas podem ser sobrescritos. As sobrescritas são sinalizadas no registro de auditoria. Campos editáveis: display_name, metadata, tags. Somente leitura após a verificação: todos os campos obtidos de registros, contadores agregados e o mapa features.

curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "tier": "enterprise" } }'

Emite business.data.updated.

Alterar o status

PATCH /v3/businesses/{vendor_data}/update-status/ Mova uma empresa entre ACTIVE, FLAGGED e BLOCKED.

curl -X PATCH https://verification.didit.me/v3/businesses/biz-acme/update-status/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "BLOCKED",
    "reason": "Sanctioned subsidiary detected in ownership chain"
  }'

De → para	Gatilho comum
`ACTIVE` → `FLAGGED`	Sessão de Verificação de empresas (KYB) movida para `In Review`, ocorrência no monitoramento AML contínuo, regra de transação
`ACTIVE` → `BLOCKED`	Sessão de Verificação de empresas (KYB) `Declined` com bloqueio automático, entidade sancionada confirmada
`FLAGGED` → `ACTIVE`	Analista concluiu a revisão sem pendências
`BLOCKED` → `ACTIVE`	Desbloqueio manual após a correção

Emite business.status.updated.

Excluir empresas (em lote)

POST /v3/businesses/delete/ Exclua uma ou mais empresas. Os registros das empresas são removidos permanentemente. As sessões de verificação delas não são excluídas por este endpoint e continuam existindo, com o vínculo à empresa removido; exclua-as com Delete Session. As transações também não são excluídas por este endpoint; exclua-as pelo Console.

curl -X POST https://verification.didit.me/v3/businesses/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "vendor_data": ["biz-acme", "biz-alpha", "biz-beta"] }'

Idempotente: excluir uma empresa já excluída não tem efeito.

Modelo de permissões

Todos os endpoints /v3/businesses/* são controlados pelo recurso de permissão businesses:

Função	list	get	create	update	update-status	delete
OWNER	✅	✅	✅	✅	✅	✅
ADMIN	✅	✅	✅	✅	✅	✅
COMPLIANCE_OFFICER	✅	✅	❌	✅	✅	❌
DEVELOPER	✅	✅	✅	❌	❌	❌
READER	✅	✅	❌	❌	❌	❌

Consulte Funções e permissões.

Webhooks acionados por estas operações

Operação	Webhook
`create`	`business.data.updated`
`update`	`business.data.updated` com `changed_fields`
`update-status`	`business.status.updated`
`delete`	`business.data.updated` com `deleted_at` definido

Próximos passos

Modelo de dados

Referência completa dos campos.

API de listagem

Esquema de GET /v3/businesses/.

API de criação

Esquema de POST /v3/businesses/create/.

Ú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

Operações de empresas: CRUD de fornecedores KYB

Listar empresas

Obter uma empresa

Criar uma empresa

Atualizar uma empresa

Alterar o status

Excluir empresas (em lote)

Modelo de permissões

Webhooks acionados por estas operações

Próximos passos

Modelo de dados

API de listagem

API de criação

​Listar empresas

​Obter uma empresa

​Criar uma empresa

​Atualizar uma empresa

​Alterar o status

​Excluir empresas (em lote)

​Modelo de permissões

​Webhooks acionados por estas operações

​Próximos passos

Modelo de dados

API de listagem

API de criação

Listar empresas

Obter uma empresa

Criar uma empresa

Atualizar uma empresa

Alterar o status

Excluir empresas (em lote)

Modelo de permissões

Webhooks acionados por estas operações

Próximos passos