Primeira requisição

Este passo a passo leva você até a primeira consulta bem-sucedida no Análise 360, usando o Score de crédito de pessoa física (uma consulta direta do módulo Restritivo) como exemplo.

Pré-requisitos

Credenciais

Ter suas credenciais de aplicação (Client ID e Secret).

Token de acesso

Ter gerado um token de acesso — veja Autenticação.

Monte a consulta de Score de crédito PF

GET /score/v3/pf/credito/{cpf} — propensão de uma pessoa física em honrar seus compromissos

Parâmetros:

Parâmetro	Localização	Obrigatório	Descrição
`cpf`	Path	sim	CPF consultado.
`idFinalidade`	Query	sim	Finalidade de uso LGPD (`2` ou `4`).
`acoes`	Query	não	Define se o cálculo deve considerar ações judiciais.
`positivo`	Query	não	Define se o cálculo deve considerar o Cadastro Positivo.
`protocolo`	Query	não	Protocolo de uma consulta anterior, quando aplicável.

Os valores abaixo são fictícios, apenas para ilustração. Use dados reais só em produção e conforme a finalidade declarada.

Faça a chamada

GET /score/v3/pf/credito/{cpf}

curl -X GET \
  "https://api.assertivasolucoes.com.br/score/v3/pf/credito/12345678901?acoes=false&positivo=true&idFinalidade=2" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

// Node 18+ possui fetch nativo.
const accessToken = process.env.ASSERTIVA_ACCESS_TOKEN;

const url = new URL("https://api.assertivasolucoes.com.br/score/v3/pf/credito/12345678901");
url.searchParams.set("acoes", "false");
url.searchParams.set("positivo", "true");
url.searchParams.set("idFinalidade", "2");

const resposta = await fetch(url, {
  headers: { Authorization: `Bearer ${accessToken}` }
});
if (!resposta.ok) throw new Error(`Consulta falhou: ${resposta.status}`);
const dados = await resposta.json();
console.log(dados);

import os
import requests

access_token = os.environ["ASSERTIVA_ACCESS_TOKEN"]

resposta = requests.get(
    "https://api.assertivasolucoes.com.br/score/v3/pf/credito/12345678901",
    headers={"Authorization": f"Bearer {access_token}"},
    params={"acoes": "false", "positivo": "true", "idFinalidade": 2},
)
resposta.raise_for_status()
print(resposta.json())

Entenda a resposta

A resposta de sucesso (200) do Score de crédito PF pode apresentar, entre outros:

Classe de risco e faixa de risco;
Pontuação (score);
Informações de Cadastro Positivo;
Comprometimento de renda e relacionamento com cartão de crédito;
Atrasos recentes, protestos, registros de débitos, ações judiciais e cheques;
Renda presumida.

Algumas consultas podem retornar 202 quando o processamento ainda está em andamento ou não há dados exibíveis no momento. Nesse caso, consulte o status ou refaça a consulta conforme a regra do endpoint.

Códigos de erro dos módulos

Além dos códigos HTTP, cada módulo pode retornar a propriedade idError. O tratamento deve ser feito por módulo: uma falha em um módulo não significa que os demais falharam.

`idError`	Descrição
`1`	Informações não encontradas.
`2`	Saldo insuficiente para a consulta.
`3`	Documento não localizado.
`4`	Informações bloqueadas conforme as diretrizes da LGPD.
`8`	Score não pôde ser calculado.
`9`	Informações insuficientes.

Principais respostas de erro (HTTP)

Código	Significado	Tratamento recomendado
`400`	Documento ou parâmetros inválidos.	Validar CPF, CNPJ e parâmetros enviados.
`401`	Falha de autenticação.	Gerar ou enviar um token válido.
`403`	Usuário sem permissão.	Confirmar as permissões do produto e da operação.
`422`	Dados válidos, mas incompatíveis com as regras de negócio.	Conferir os parâmetros e as condições da consulta.
`429`	Já existe uma consulta semelhante em andamento para o mesmo documento.	Aguardar e evitar o reenvio imediato.
`500` / `503` / `504`	Erro interno, instabilidade de fornecedor ou tempo limite excedido.	Aguardar e repetir a consulta; acionar o suporte se persistir.

Próximo passo

Veja como encadear as consultas do módulo Restritivo e usar o módulo Comportamental (assíncrono) nos casos de uso.