Developers

Casos de uso

Como combinar as consultas do Localize em fluxos práticos. Os fluxos abaixo usam apenas comportamentos descritos na documentação da API.

1. Confirmação de identidade a partir de um CPF

Objetivo: validar os dados cadastrais de uma pessoa e obter contatos.

1

Consulte o CPF

GET /localize/v3/cpf com idFinalidade=1 (Confirmação de identidade).

2

Guarde o protocolo

Armazene o protocolo retornado no cabecalho.

3

Amplie os contatos

GET /localize/v3/mais-telefones com tipo=CPF, documento e o protocolo.

mais-telefones exige que uma consulta de CPF (ou CNPJ) com o mesmo documento tenha sido feita antes — por isso o protocolo é obrigatório.

2. Enriquecimento de contatos antes de uma cobrança

Objetivo: reunir telefones e pessoas de referência para localizar um devedor.

  1. Consulte GET /localize/v3/cpf (idFinalidade=2, Ciclo de crédito) e guarde o protocolo.
  2. Chame GET /localize/v3/pessoas-de-referencia com o mesmo cpf e protocolo para obter mãe, filhos, irmãos e sócios que possam confirmar a identidade.
  3. Opcionalmente, chame GET /localize-api/v1/base-cadastral/conexoes com tipo=CPF, documento, idFinalidade e telefones=true para trazer o principal telefone de cada pessoa conectada.

3. Descoberta a partir de um contato (e-mail ou telefone)

Objetivo: identificar quem está por trás de um e-mail ou telefone.

  • Se você tem um e-mail, chame GET /localize/v3/email — a resposta separa pessoaFisica e pessoaJuridica vinculadas.
  • Se você tem um telefone, chame GET /localize/v3/telefone — a resposta também separa pessoas físicas e jurídicas relacionadas.

Exemplo — consulta por e-mail

GET /localize/v3/email
curl -X GET \
  "https://api.assertivasolucoes.com.br/localize/v3/email?email=usuario@exemplo.com.br&idFinalidade=1" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"
const accessToken = process.env.ASSERTIVA_ACCESS_TOKEN;

const url = new URL("https://api.assertivasolucoes.com.br/localize/v3/email");
url.searchParams.set("email", "usuario@exemplo.com.br");
url.searchParams.set("idFinalidade", "1");

const resposta = await fetch(url, {
  headers: { Authorization: `Bearer ${accessToken}` }
});
const dados = await resposta.json();
console.log(dados.resposta.pessoaFisica, dados.resposta.pessoaJuridica);
import os
import requests

access_token = os.environ["ASSERTIVA_ACCESS_TOKEN"]

resposta = requests.get(
    "https://api.assertivasolucoes.com.br/localize/v3/email",
    headers={"Authorization": f"Bearer {access_token}"},
    params={"email": "usuario@exemplo.com.br", "idFinalidade": 1},
)
resposta.raise_for_status()
dados = resposta.json()["resposta"]
print(dados["pessoaFisica"], dados["pessoaJuridica"])

4. Prospecção B2B a partir de um CNPJ

Objetivo: entender uma empresa e chegar aos tomadores de decisão.

  1. Consulte GET /localize/v3/cnpj (informe idFinalidade) e guarde o protocolo.
  2. Chame GET /localize/v3/possiveis-decisores com o cnpj e o protocolo para obter possíveis decisores.
  3. Opcionalmente, use GET /localize-api/v1/base-cadastral/conexoes com tipo=CNPJ para mapear sócios, decisores e empresas com participação.
Recomendações

Boas práticas

Reaproveite o protocolo

Várias consultas secundárias dependem de uma consulta principal anterior sobre o mesmo documento.

Escolha a finalidade correta

Defina a idFinalidade adequada para cada operação (LGPD).

Respeite restrições de contato

Campos como naoPerturbe indicam restrições que devem ser respeitadas.

Renove o token

Ao receber 401, gere um novo token e refaça a chamada.

Referência técnica

Respostas e esquemas completos

Veja a Referência de Localize com todos os parâmetros, exemplos de requisição e os esquemas de resposta completos de cada endpoint.

Abrir a Referência técnica