Saltar para o conteúdo principal
PATCH
curl

Visão geral

Move uma entidade empresarial entre ACTIVE, FLAGGED e BLOCKED. Consulte o ciclo de vida da entidade para ver a máquina de estados completa.

Quando usar

  • Bloquear uma empresa sancionada ou confirmada como fraudulenta.
  • Sinalizar uma empresa pendente de revisão manual.
  • Desbloquear após a correção.
  • Propagar sinais externos a partir dos seus próprios sistemas de conformidade.

Notas

  • Valores válidos: ACTIVE, FLAGGED, BLOCKED.
  • Pode enviar um reason opcional (até 1000 caracteres) para registar o motivo da alteração de estado. A Didit guarda-o na entrada de alteração de estado em Atividade da empresa, na Business Console. Só é registado quando o estado muda efetivamente.
  • As empresas BLOCKED têm todas as novas sessões de Verificação de empresas (KYB) recusadas automaticamente, bem como todas as novas transações, incluindo quando aparecem como contraparte.
  • Emite business.status.updated com previous_status e status. O webhook não inclui reason.

Aplicação

Permissões

A chave secreta principal e as chaves de API com acesso total podem sempre chamar este endpoint. Uma chave com acesso personalizado precisa da permissão de escrita em Empresas (businesses). Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue aceder a este endpoint. As funções e permissões da Business Console determinam o que um membro da equipa pode fazer na consola. Não são avaliadas para pedidos feitos com chaves de API.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

vendor_data
string
obrigatório

O seu identificador exclusivo para a empresa (string de formato livre, NÃO um UUID).

Corpo

application/json
status
enum<string>
obrigatório

Novo estado do ciclo de vida. BLOCKED também adiciona o vendor_data à lista de bloqueio do sistema.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
reason
string | null

O motivo da alteração de estado. Registado na entrada de alteração de estado em Activity da empresa na Business Console, apenas quando o estado realmente muda. Os webhooks não o transmitem.

Maximum string length: 1000

Resposta

Estado da empresa atualizado. Registo completo da empresa devolvido.

Detalhe completo da empresa. Estende BusinessListItem com metadados e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para esta empresa.

vendor_data
string | null

O seu identificador exclusivo para esta empresa (transmitido ao criar sessões). Pode ser nulo quando não tiver sido fornecido nenhum identificador de fornecedor.

display_name
string | null

Nome de apresentação personalizado definido por si

Denominação legal oficial proveniente do registo ou introduzida manualmente

registration_number
string | null

Número de registo ou de constituição da empresa

country_code
string | null

País de constituição (ISO 3166-1 alpha-2, por ex., GB, US).

effective_name
string | null

Melhor nome disponível: display_name se definido, caso contrário legal_name

status
enum<string>

Estado do ciclo de vida do registo da empresa (NÃO é um estado da sessão). ACTIVE é o padrão, FLAGGED marca-o para atenção manual, BLOCKED impede novas sessões para este vendor_data.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Número total de sessões de verificação para esta empresa

approved_count
integer

Número de sessões aprovadas

declined_count
integer

Número de sessões recusadas

in_review_count
integer

Número de sessões em análise

features
object

Estado agregado por funcionalidade em todas as sessões de KYB desta empresa. Atualmente, a única chave é KYB (o estado da verificação da empresa no registo). Valores possíveis: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list
object[]

Os mesmos dados que features, como um array ordenado de objetos {feature, status}.

last_session_at
string<date-time> | null

Carimbo de data/hora da sessão mais recente

first_session_at
string<date-time> | null

Carimbo de data/hora da primeira sessão

last_activity_at
string<date-time> | null

Carimbo de data/hora da atividade mais recente (mudança de estado, atualização da sessão, etc.)

tags
object[]

Etiquetas atribuídas a esta empresa

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que associou a esta empresa. O valor predefinido é {}.

updated_at
string<date-time>
Última modificação em 7 de novembro de 2026