Saltar para o conteúdo principal
POST
curl

Visão geral

Cria explicitamente uma entidade empresarial antes de ser executada qualquer sessão de Verificação de empresas (KYB).

Quando usar

  • Pré-preencher metadados (parceiro, nível, identificadores internos) antes da primeira sessão de Verificação de empresas (KYB).
  • Migrar a partir de outro fornecedor de KYB com uma lista existente de empresas.
  • Registo apenas de transações — submeter transações de uma empresa que foi verificada por um processo offline.

Notas

  • vendor_data é obrigatório e único por aplicação. Os duplicados resultam num erro de conflito — utilize PATCH /v3/businesses/{vendor_data}/ para atualizar.
  • Os campos derivados do registo (legal_name, registration_number, country_code) podem ser pré-preenchidos, mas serão substituídos pelos dados do registo da primeira sessão de Verificação de empresas (KYB) aprovada.
  • Se country_code corresponder à lista de países perigosos da sua aplicação, a empresa é criada com o estado BLOCKED.
  • Emite business.data.updated.

Permissões

A função tem de conceder create:businesses.

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.

Corpo

application/json
vendor_data
string | null

O seu identificador exclusivo para esta empresa (string de formato livre, NÃO um UUID). Opcional, mas fortemente recomendado. Quando fornecido, deve ser exclusivo entre as empresas não eliminadas da aplicação; correspondido exatamente como enviado.

display_name
string | null

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

Maximum string length: 255

Denominação legal oficial da empresa.

Maximum string length: 255
registration_number
string | null

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

Maximum string length: 100
country_code
string | null

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

Maximum string length: 10
status
enum<string>
padrão:ACTIVE

Estado inicial do ciclo de vida. O padrão é ACTIVE.

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

Objeto JSON arbitrário que anexa à empresa. O valor predefinido é {}.

Resposta

Empresa criada. Registo completo da empresa devolvido (mesmo formato que Obter empresa).

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