Descrição
Dataset que retorna endereços associados ao indivíduo consultado, incluindo atributos de classificação, recência, prioridade e validação, além de informações agregadas que facilitam análises de contato, segmentação e decisões automatizadas.
Para mais informações sobre contexto de negócio, aplicações e casos de uso, consulte a documentação de Contatos.
Tabela de preços
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10.000 | R$ 0,050 |
| 10.001 - 50.000 | R$ 0,048 |
| 50.001 - 100.000 | R$ 0,046 |
| 100.001 - 500.000 | R$ 0,044 |
| 500.001 - 1.000.000 | R$ 0,042 |
| 1.000.001 - 5.000.000 | R$ 34.000,00 (preço fixo) |
| 5.000.001 e acima | Entre em contato |
Chaves opcionais relevantes
As chaves abaixo representam algumas das chaves opcionais aceitas neste dataset, permitindo aumentar a qualidade da consulta, controlar a deduplicação de endereços e habilitar mecanismos de comparação entre endereços informados e os encontrados nas bases.
| Chave | Descrição | Valores Possíveis |
|---|---|---|
| zipcode | Esse campo pode ser usado em conjunto com o "addressnumber" para permitir ao sistema montar o código do edifício, aumentando significativamente a qualidade do resultado da consulta | CEP do endereço |
| addressnumber | Esse campo pode ser usado em conjunto com o "zipcode" para permitir ao sistema montar o código do edifício, aumentando significativamente a qualidade do resultado da consulta. | Número do endereço |
| address | Permite informar um endereço durante a chamada. Esse campo pode ser usado com o "withmatchrate{true}" para serem realizadas as comparações entre o endereço informado e os endereços encontrados em nossas bases de dados relacionados ao indivíduo. Não devem ser inseridas as informações de número do endereço ou CEP neste campo. | Tipologia e núcleo do endereço |
| returnonlydifferentaddresses | Permite que somente sejam retornados endereços diferentes do que foi especificado através dos campos "zipcode" e "addressnumber", mas que sejam associados ao mesmo titular. O parâmetro quando passado como "true" é habilitado e quando não especificado assume como padrão o valor "false". Este parâmetro permite o controle sobre o retorno da sua chamada, evitando a cobrança caso não existam informações adicionais de outros endereços além do que foi passado na busca. | true, false |
| withmatchrate | Este campo permite que seja realizada uma comparação entre os endereços retornados e o informado através dos parâmetros "zipcode", "addressnumber" e "address". Ao habilitar este campo, passando o valor "true", será aplicado um algorítmo de distância de palavras para definir a semelhança do endereço informado com cada um dos endereços retornados na lista. O resultado da operação será atribuido ao campo "MatchRate". Um "MatchRate" de 100 indica que os endereços são idênticos, valores menores indicam menor similaridade. O valor padrão para esse campo é "false". | true, false |
Para conhecer todas as chaves disponíveis e entender como combiná-las, consulte a seção Parâmetros de Consulta.
Filtros
Os filtros abaixo permitem refinar os resultados retornados por este dataset conforme características do endereço, como tipo, status, recência, prioridade, localização e natureza da associação.
| Campo | Descrição do filtro | Tipo do filtro | Valores Possíveis do Filtro |
|---|---|---|---|
| Type | Tipo de endereço | Igual | work, home |
| isratified | Se está ratificado | Igual | true, false |
| isactive | Se esta ativo | Igual | true, false |
| isrecent | Se é recente | Igual | true, false |
| ismain | Se é principal | Igual | true, false |
| isindirect | Se a associação é indireta | Igual | true, false |
| state | Sigla do estado | Igual | RJ, SP, MG, ES, ... |
| zipcode | Número do CEP | Começa com | Qualquer CEP completo ou primeiros x digitos |
Para entender como aplicar filtros, ordenações e personalizar o retorno dos dados, consulte a seção Personalizar Retorno.