Skip to main content
A integração com o Perfil Financeiro utiliza o mesmo padrão de autenticação das demais APIs da DataBox360. Caso sua aplicação já esteja integrada à consulta SCR, não será necessário implementar um novo fluxo de autenticação. A mesma chave de API pode ser utilizada para acessar o Perfil Financeiro.

​
Autenticação

Após realizar a autenticação, envie o token no cabeçalho Authorization de cada requisição:
O token deve ser enviado no formato Bearer. Consulte a página de Autenticação API para verificar o fluxo completo de geração do token.

​
Ambientes e Endpoints

A API do Perfil Financeiro está disponível nos ambientes Sandbox e Produção.
Utilize o endpoint correspondente ao ambiente configurado para sua integração.

​
Método HTTP

A consulta é realizada por meio do método POST:

​
Cabeçalhos

Envie os seguintes cabeçalhos na requisição:

​
Data-Base da Consulta

A data-base determina o mês de referência das informações utilizadas na geração do Perfil Financeiro. Como as informações são atualizadas mensalmente, a DataBox360 aplica uma regra para definir a data-base mais recente disponível com segurança:

​
Exemplo

Os campos mes e ano devem respeitar a data-base disponível no momento da requisição.
Na resposta, o período efetivamente consultado é informado no campo consulta.databaseConsultada, no formato AAAA-MM:

​
Corpo da Requisição

A requisição utiliza os mesmos campos da consulta SCR:
​
string
required
CPF ou CNPJ da pessoa consultada. Exemplo de CNPJ: 00.000.000/0001-00.
​
string
required
Mês de referência da consulta, informado com dois dígitos. Exemplo: 06.
​
string
required
Ano de referência da consulta, informado com quatro dígitos. Exemplo: 2026.

​
Exemplo Simplificado

​
Retorno da Consulta

Quando a consulta for concluída com sucesso, a API retornará:
  • o identificador da consulta no campo id;
  • os indicadores estruturados no objeto consulta;
  • o status da operação;
  • uma url exclusiva para visualização do Perfil Financeiro;
  • a versão da API.
O campo url permanece na raiz da resposta e direciona para a visualização exclusiva da consulta realizada.

Consultar Referência da API

Consulte os exemplos completos de requisição, resposta e documentação dos campos.