Operações de empresas: CRUD de KYB de fornecedores

Todas as operações de gestão de entidades empresariais são feitas através de seis endpoints públicos em /v3/businesses/. Esta página apresenta o percurso conceptual: consulte a referência da API para os esquemas completos de pedidos e respostas.

Listar empresas

GET /v3/businesses/ Lista paginada das empresas da sua aplicação, com filtros por estado, pesquisa, 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}/ Obtenha uma única empresa pelo 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 previamente uma empresa antes de qualquer sessão de Verificação de empresas (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" }
  }'

Devolve 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 de perfil editáveis. Os campos obtidos a partir de consultas ao registo (legal_name, registration_number, country_code) ficam só de leitura após a verificação, mas podem ser substituídos; as substituições são sinalizadas no registo de auditoria. Campos editáveis: display_name, metadata, tags. Só de leitura após a verificação: todos os campos derivados do registo, os 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 estado

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) passou para `In Review`, deteção na monitorização AML contínua, regra de transação
`ACTIVE` → `BLOCKED`	Entidade sancionada confirmada, entrada manual na lista de bloqueio
`FLAGGED` → `ACTIVE`	Revisão dada como resolvida pelo analista
`BLOCKED` → `ACTIVE`	Desbloqueio manual após remediação

Emite business.status.updated.

Eliminar empresas (em lote)

POST /v3/businesses/delete/ Elimine uma ou mais empresas. Os registos das empresas são removidos de forma permanente. As respetivas sessões de verificação não são abrangidas por este endpoint e mantêm-se, com a ligação à empresa removida; elimine-as com Eliminar sessão. As transações também não são abrangidas; elimine-as na Consola.

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: eliminar uma empresa já eliminada não tem efeito.

Modelo de permissões

Todos os endpoints /v3/businesses/* estão limitados 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 disparados 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 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

Operações de empresas: CRUD de KYB de fornecedores

Listar empresas

Obter uma empresa

Criar uma empresa

Atualizar uma empresa

Alterar o estado

Eliminar empresas (em lote)

Modelo de permissões

Webhooks disparados 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 estado

​Eliminar empresas (em lote)

​Modelo de permissões

​Webhooks disparados 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 estado

Eliminar empresas (em lote)

Modelo de permissões

Webhooks disparados por estas operações

Próximos passos