For the complete documentation index, see llms.txt. This page is also available as Markdown.

Busca de empresa via API

1. Configurar um modelo de consulta

Acesse a Trust Platform e depois Modelos de Consulta. Selecione o Modelo de Consulta desejado e prossiga para criar o fluxo de trabalho.

2. Obter o ID da empresa

O contexto global é dinâmico e diferentes países usam diferentes formas de identificar empresas. Por esse motivo, você precisa localizar o identificador da empresa à qual deseja enviar o fluxo de trabalho.

Usando a Core API e o recurso Services , faça uma solicitação pedindo o kybCompanySearch serviço e fornecendo as informações da empresa conhecida. Você pode encontrar mais detalhes sobre como fazer essa solicitação em Referência da API > Core API > Recursos Disponíveis > Services.

Em resposta, são esperados dois identificadores: creditReportId e businessIdentityId.

Observação: nem todos os identificadores estarão sempre disponíveis. Há casos em que apenas uma ou nenhuma bureau é compatível com as informações de origem.

3. Iniciar uma transação

Depois de ter pelo menos um identificador, você pode iniciar uma transação no fluxo configurado no recurso 1. Configurar um modelo de consulta etapa.

Usando a Core API e o recurso Orchestrations , faça uma solicitação para criar uma transação. No corpo da solicitação, insira pelo menos um dos identificadores obtidos na 2. Obter o ID da empresa etapa. Você pode encontrar mais detalhes sobre como fazer essa solicitação em Referência da API > Core API > Detalhes da Transação.

Observação: mantenha o mesmo nome de atributo.

, se for bem-sucedido, o ID da transação recém-criada estará disponível no corpo da resposta, em um atributo chamado id.

4. Verificar resultados

Por fim, depois de ter o ID da transação, você pode recuperar as informações solicitadas de acordo com a configuração do Fluxo de Trabalho criada na 1. Configurar um modelo de consulta etapa.

Observação: você deve aguardar o processamento da transação antes que os dados estejam totalmente disponíveis.

Alternativa: aguarde uma atualização por webhook e obtenha as informações somente quando a transação tiver uma atualização. Veja mais detalhes aqui.

Atualizado