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.
Consulte o CPF
GET /localize/v3/cpf com
idFinalidade=1 (Confirmação de identidade).
Guarde o protocolo
Armazene o protocolo retornado no cabecalho.
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.
-
Consulte
GET /localize/v3/cpf(idFinalidade=2, Ciclo de crédito) e guarde oprotocolo. -
Chame
GET /localize/v3/pessoas-de-referenciacom o mesmocpfeprotocolopara obter mãe, filhos, irmãos e sócios que possam confirmar a identidade. -
Opcionalmente, chame
GET /localize-api/v1/base-cadastral/conexoescomtipo=CPF,documento,idFinalidadeetelefones=truepara 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 separapessoaFisicaepessoaJuridicavinculadas. -
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
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.
-
Consulte
GET /localize/v3/cnpj(informeidFinalidade) e guarde oprotocolo. -
Chame
GET /localize/v3/possiveis-decisorescom ocnpje oprotocolopara obter possíveis decisores. -
Opcionalmente, use
GET /localize-api/v1/base-cadastral/conexoescomtipo=CNPJpara mapear sócios, decisores e empresas com participação.
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.