Endpoints
string
https://sandbox-api.databox360.com.br/api/perfil-financeirostring
https://api.databox360.com.br/api/perfil-financeiroA operação utiliza autenticação Bearer Token, seguindo o mesmo padrão das demais APIs da DataBox360.
curl -X POST https://sandbox-api.databox360.com.br/api/perfil-financeiro \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"documento": "00.000.000/0001-00",
"mes": "06",
"ano": "2026"
}'
const response = await fetch(
"https://sandbox-api.databox360.com.br/api/perfil-financeiro",
{
method: "POST",
headers: {
Authorization: "Bearer YOUR_JWT_TOKEN",
"Content-Type": "application/json",
},
body: JSON.stringify({
documento: "00.000.000/0001-00",
mes: "06",
ano: "2026",
}),
}
);
const perfilFinanceiroData = await response.json();
console.log(perfilFinanceiroData);
import requests
url = "https://sandbox-api.databox360.com.br/api/perfil-financeiro"
headers = {
"Authorization": "Bearer YOUR_JWT_TOKEN",
"Content-Type": "application/json"
}
payload = {
"documento": "00.000.000/0001-00",
"mes": "06",
"ano": "2026"
}
response = requests.post(url, json=payload, headers=headers)
perfil_financeiro_data = response.json()
<?php
$url = 'https://sandbox-api.databox360.com.br/api/perfil-financeiro';
$data = [
'documento' => '00.000.000/0001-00',
'mes' => '06',
'ano' => '2026'
];
$options = [
'http' => [
'header' => [
"Authorization: Bearer YOUR_JWT_TOKEN",
"Content-type: application/json"
],
'method' => 'POST',
'content' => json_encode($data)
]
];
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$perfil_financeiro_data = json_decode($result, true);
?>
{
"id": "75cb4884-4165-4a91-9c6d-dbdb402cf2be",
"data": "28/08/2026 22:29:47",
"consulta": {
"tipoDoCliente": "PF",
"documentoTipo": "CPF",
"documento": "00000000191",
"dataRelacionamento": "2005-08",
"databaseConsultada": "2026-07",
"consultadoEm": "2026-08-28T22:29:46.825Z",
"valorContratadoIntervalo": {
"minimo": 3164343.63,
"maximo": 11221552.64
},
"resumo": {
"principalCategoria": "Financiamentos",
"principalCategoriaPercentual": 59.6,
"relacionamentoAnos": 21,
"operacoesQuantidade": 36,
"instituicoesQuantidade": 10
},
"carteiraComposicao": [
{
"categoria": "Empréstimos",
"percentual": 33.07
},
{
"categoria": "Financiamentos",
"percentual": 59.6
},
{
"categoria": "Adiantamentos",
"percentual": 0.14
},
{
"categoria": "Arrendamento",
"percentual": 0
},
{
"categoria": "Garantias",
"percentual": 0
},
{
"categoria": "Outros Créditos",
"percentual": 7.19
}
],
"vencimentoDistribuicao": [
{
"descricao": "Até 90 dias",
"percentual": 29.94
},
{
"descricao": "De 91 a 180 dias",
"percentual": 34.41
},
{
"descricao": "De 181 a 360 dias",
"percentual": 8.13
},
{
"descricao": "De 1 a 3 anos",
"percentual": 26.59
},
{
"descricao": "De 3 a 5 anos",
"percentual": 0.93
},
{
"descricao": "De 5 a 15 anos",
"percentual": 0
},
{
"descricao": "Acima de 15 anos",
"percentual": 0
},
{
"descricao": "Prazo indeterminado",
"percentual": 0
}
],
"carteiraAVencerPorModalidade": [
{
"categoria": "Empréstimos",
"percentual": 45.67
},
{
"categoria": "Financiamentos",
"percentual": 0.73
},
{
"categoria": "Adiantamentos",
"percentual": 0
},
{
"categoria": "Arrendamento",
"percentual": 0
},
{
"categoria": "Garantias",
"percentual": 0
},
{
"categoria": "Outros Créditos",
"percentual": 53.6
}
],
"carteiraVencidaPorModalidade": [
{
"categoria": "Empréstimos",
"percentual": 41.64
},
{
"categoria": "Financiamentos",
"percentual": 58.36
},
{
"categoria": "Adiantamentos",
"percentual": 0
},
{
"categoria": "Arrendamento",
"percentual": 0
},
{
"categoria": "Garantias",
"percentual": 0
},
{
"categoria": "Outros Créditos",
"percentual": 0
}
],
"carteiraPrejuizoPorModalidade": [
{
"categoria": "Empréstimos",
"percentual": 28.06
},
{
"categoria": "Financiamentos",
"percentual": 71.73
},
{
"categoria": "Adiantamentos",
"percentual": 0.21
},
{
"categoria": "Arrendamento",
"percentual": 0
},
{
"categoria": "Garantias",
"percentual": 0
},
{
"categoria": "Outros Créditos",
"percentual": 0
}
],
"insights": {
"carteiraComposicao": "A carteira está concentrada principalmente em financiamentos (59,60%) e empréstimos (33,07%), que juntos somam quase toda a exposição.",
"vencimentoDistribuicao": "34,41% da carteira vence de 91 a 180 dias, caracterizando um perfil de médio prazo.\nA exposição de curtíssimo prazo é moderada (29,94% em até 90 dias).",
"carteiraAVencerPorModalidade": "Outros Créditos representa 53,60% dos compromissos futuros a vencer, seguida por empréstimos (45,67%).",
"carteiraVencidaPorModalidade": "Do total vencido, 58,36% está concentrado em financiamentos, seguido por empréstimos com 41,64%.",
"carteiraPrejuizoPorModalidade": "Do total baixado como prejuízo, 71,73% originou-se de financiamentos, com empréstimos representando 28,06%.\nHistórico de perda concentrado em financiamentos — relevante para análise de risco."
},
"ultimoVencimento": "2030-05"
},
"status": "sucesso",
"url": "https://sandbox-perfil-financeiro.databox360.com.br/75cb4884-4165-4a91-9c6d-dbdb402cf2be",
"versao": "1.0"
}
{
"data": "28/08/2026 22:29:47",
"campo": {
"documento": "Documento inválido"
},
"messagem": "Erro de validação",
"status": "erro",
"versao": "1.0"
}
Requisição
string
required
CPF ou CNPJ do cliente consultado.
string
required
Mês de referência com dois dígitos. Exemplo:
06.string
required
Ano de referência com quatro dígitos. Exemplo:
2026.Resposta
string
required
Identificador único da consulta.
string
required
Data e hora em que a consulta foi realizada.
object
required
Objeto que contém os dados do Perfil Financeiro.
Show consulta properties
Show consulta properties
string
required
Tipo do cliente:
PF para Pessoa Física ou PJ para Pessoa Jurídica.string
required
Tipo do documento consultado:
CPF ou CNPJ.string
required
Documento do cliente consultado.
string
Data de início do relacionamento de crédito no formato
YYYY-MM.string
required
Data-base utilizada na consulta no formato
YYYY-MM.string
required
Data e hora da consulta no formato ISO 8601.
object
object
required
Síntese dos principais indicadores do Perfil Financeiro.
array
required
array
required
array
required
array
required
array
required
object
required
Textos interpretativos gerados a partir dos indicadores da consulta.
string
Data do último vencimento identificado, no formato
YYYY-MM.string
required
Status da requisição:
sucesso ou erro.string
required
URL exclusiva para acesso à visualização completa do Perfil Financeiro.
Utilize o endereço retornado em
url para abrir ou compartilhar a visualização completa da consulta.string
required
Versão da API.
string
Mensagem retornada quando o status da requisição for
erro.object
Detalhes dos campos que apresentaram erro de validação.