Pular para o conteúdo principal
PATCH
curl

Visão geral

Atualiza os campos mutáveis de uma entidade empresarial. Os campos preenchidos a partir de consultas ao registro (legal_name, registration_number, country_code) passam a ser somente leitura após a primeira sessão de Verificação de empresas (KYB) aprovada.

Quando usar

  • Renomear: defina um display_name melhor para as visualizações internas.
  • Atualizar metadados: mova uma empresa entre categorias internas, registre uma nota interna, altere tags.
  • Substituir dados do registro (com cautela): as substituições são aceitas, mas sinalizadas no registro de auditoria.

Observações

  • O vendor_data na URL não pode ser alterado por meio deste endpoint.
  • Emite um webhook business.data.updated com um array changed_fields.
  • Toda edição é registrada na Activity da empresa no Business Console. Uma alteração de status é registrada com o reason opcional (até 1000 caracteres), e uma alteração em display_name, legal_name, registration_number, country_code ou metadata é registrada como atualização do perfil. O webhook business.status.updated não inclui o reason.

Permissões

O segredo principal e as chaves de API com acesso total sempre podem chamar este endpoint. Uma chave com acesso personalizado precisa de permissão de escrita em Empresas (businesses). Uma chave limitada a alguns fluxos ou a sessões aprovadas não consegue acessar este endpoint. As funções e permissões do Console determinam o que um membro da equipe pode fazer no Console. Elas não são avaliadas em requisições feitas com chave de API.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

vendor_data
string
obrigatório

Seu identificador exclusivo da empresa (string livre, NÃO um UUID).

Corpo

application/json

Corpo de atualização parcial. Informe apenas os campos que deseja alterar.

display_name
string | null

Nome de exibição amigável mostrado no console (tem prioridade sobre legal_name na exibição da interface).

Razão social oficial obtida do registro de empresas ou inserida manualmente.

registration_number
string | null

Número de registro ou de constituição da empresa.

country_code
string | null

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

status
enum<string>

Status do ciclo de vida da empresa. Definir BLOCKED adiciona automaticamente o vendor_data à lista de bloqueio do sistema; mudar de BLOCKED para outro status remove essa entrada da lista de bloqueio.

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

Objeto JSON arbitrário que você anexa à empresa. Substitui totalmente os metadados existentes na atualização — faça a mesclagem no lado do cliente se quiser apenas adicionar chaves.

reason
string | null

Por que o status mudou. Registrado na entrada de mudança de status em Activity da empresa no Business Console, apenas quando o status realmente muda. Os webhooks não o incluem.

Maximum string length: 1000

Resposta

Empresa atualizada. Retorna o registro completo e atualizado da empresa.

Detalhes completos da empresa. Estende BusinessListItem com metadata e updated_at.

didit_internal_id
string<uuid>

UUID interno estável da Didit para esta empresa.

vendor_data
string | null

Seu identificador exclusivo desta empresa (passado ao criar sessões). Pode ser nulo quando nenhum identificador do fornecedor foi informado.

display_name
string | null

Nome de exibição personalizado definido por você

Razão social oficial obtida do registro de empresas ou inserida manualmente

registration_number
string | null

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

country_code
string | null

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

effective_name
string | null

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

status
enum<string>

Status do ciclo de vida do registro da empresa (NÃO é um status de sessão). ACTIVE é o padrão, FLAGGED o marca para atenção manual e 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 desta 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 revisão

features
object

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

features_list
object[]

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

last_session_at
string<date-time> | null

Data e hora da sessão mais recente

first_session_at
string<date-time> | null

Data e hora da primeira sessão

last_activity_at
string<date-time> | null

Data e hora da atividade mais recente (mudança de status, atualização da sessão etc.)

tags
object[]

Tags atribuídas a esta empresa

created_at
string<date-time>
metadata
object

JSON de metadados personalizados que você anexou a esta empresa. O padrão é {}.

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