Gera Leads UF / MUNICIPIO

A API Gera Leads UF / MUNICÍPIO permite identificar potenciais leads com base em critérios geográficos como Unidade Federativa ou município. Ela retorna dados anonimizados de pessoas físicas e jurídicas, incluindo identificador, nome ou razão social mascarados, documento mascarado e tipo de pessoa. Essa solução é voltada para estratégias de prospecção regional, inteligência de mercado e campanhas comerciais segmentadas.

TABELA DE CAMPOS PARA REQUISIÇÃO

CampoDescriçãoFormatoObrigatório (Sim / Não)
IdConsulta346integerSim
UFUF do EstadostringSim
MunicipioMunicipiostringNão
TipoPessoaPFstringSim

TABELA DE CAMPOS DE RETORNO

CampoDescriçãoFormato
CONSULTABloco com metadados da consulta.object
CODIGORESPOSTACódigo de identificação da consulta.string
DATAHORAData e hora da consulta.string
LOGONCódigo do usuário autenticado.string
IDCONSULTAIdentificador da consulta.string
RESPOSTABloco principal de dados retornados.object
CODIGOCódigo de status da resposta.string
GERALEADSBloco com os dados dos leads gerados.object
TOTALGERALQuantidade total de leads encontrados.string
TOTALPFQuantidade total de pessoas físicas encontradas.string
TOTALPJQuantidade total de pessoas jurídicas encontradas.string
IDIdentificador interno do lead.string
NOMERAZAONome ou razão social (parcialmente mascarado).string
DOCUMENTOCPF ou CNPJ do lead (parcialmente mascarado).string
TIPOPESSOATipo da pessoa (PF ou PJ).string
Language
Credentials
Header
Click Try It! to start a request and see the response here!