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.
Nome técnico do dataset: addresses_extended.
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 complementares relevantes
As chaves abaixo representam algumas das chaves complementares 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 | CEP do endereço consultado. Pode ser utilizado em conjunto com addressnumber para melhorar a precisão da identificação do imóvel. | CEP do endereço |
| addressnumber | Número do endereço consultado. Pode ser utilizado em conjunto com zipcode para melhorar a precisão da identificação do imóvel. | Número do endereço |
| address | Endereço consultado (logradouro e complemento, sem número ou CEP). Pode ser utilizado com withmatchrate{true} para comparação com endereços associados ao indivíduo. | Tipologia e núcleo do endereço |
| returnonlydifferentaddresses | Retorna apenas endereços diferentes dos informados (zipcode e addressnumber), desde que associados ao mesmo titular. | true, false (Padrão: false) |
| withmatchrate | Indica se deve ser calculada a similaridade entre o endereço informado (zipcode + addressnumber + address) e os endereços retornados. O resultado é apresentado no campo MatchRate, onde 100 indica correspondência exata. | true, false (Padrão: 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 |
Limite
Este dataset permite limitar a quantidade de registros retornados utilizando o modificador .limit(x) no campo Datasets.
Para entender como aplicar filtros, limitar a quantidade de resultados, fazer paginação e personalizar o retorno dos dados, consulte a seção Personalizar Retorno.