Saltar para o conteúdo principal
PATCH
curl

Visão geral

Atualiza os campos editáveis de uma entidade empresarial. Os campos preenchidos a partir de consultas ao registo (legal_name, registration_number, country_code) passam a ser apenas de leitura depois da primeira sessão de Verificação de empresas (KYB) aprovada.

Quando usar

  • Mudar o nome: defina um display_name mais adequado para as vistas internas.
  • Atualizar metadados: mova uma empresa entre níveis internos, registe uma nota interna ou altere etiquetas.
  • Substituir dados do registo (com cuidado): as substituições são aceites, mas ficam sinalizadas no registo de auditoria.

Notas

  • O vendor_data no URL não pode ser alterado através deste endpoint.
  • Emite um webhook business.data.updated com uma matriz changed_fields.
  • Cada edição fica registada em Atividade na Business Console. Uma alteração de status fica registada com o reason opcional (até 1000 caracteres), e uma alteração de display_name, legal_name, registration_number, country_code ou metadata fica registada como uma atualização de perfil. O webhook business.status.updated não inclui reason.

Permissões

O segredo 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 Console determinam o que um membro da equipa pode fazer na Console. 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

Corpo de atualização parcial. Forneça apenas os campos que pretende alterar.

display_name
string | null

Nome de apresentação amigável apresentado na consola (tem precedência sobre legal_name para exibição na IU).

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).

status
enum<string>

Estado do ciclo de vida da empresa. Definir BLOCKED adiciona automaticamente o vendor_data à lista de bloqueio do sistema; alternar para outro valor diferente de BLOCKED remove essa entrada da lista de bloqueio.

Opções disponíveis:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objeto JSON arbitrário que associa à empresa. Substitui totalmente os metadados existentes na atualização — faça a junção no lado do cliente se pretender apenas adicionar chaves.

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

Empresa atualizada. O registo completo atualizado 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