Telefones
O serviço de Telefones retorna números de telefone associados à entidade consultada, com informações básicas para identificação e análise.
Quando usar
Descrição
O serviço de Telefones retorna números associados à entidade consultada, incluindo dados sobre a frequência com que esses telefones são encontrados e informações agregadas que facilitam análises e modelagens.
Essas informações ampliam a compreensão sobre os contatos relacionados, auxiliando em investigações e avaliações de risco.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/empresas/telefones
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CNPJ da empresa, com ou sem máscara. |
{
"document": "00.000.000/0000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
TotalPhones |
número |
TotalActivePhones |
número |
TotalWorkPhones |
número |
TotalPersonalPhones |
número |
TotalUniquePhones |
número |
TotalPhonePassages |
número |
TotalBadPhonePassages |
número |
TotalLast3MonthsPassages |
número |
TotalLast6MonthsPassages |
número |
TotalLast12MonthsPassages |
número |
TotalLast18MonthsPassages |
número |
OldestPhonePassageDate |
data |
NewestPhonePassageDate |
data |
Phones[].Number |
texto |
Phones[].AreaCode |
texto |
Phones[].CountryCode |
texto |
Phones[].Complement |
texto |
Phones[].Type |
texto |
Phones[].PhoneCurrentlyInRFSite |
booleano |
Phones[].PhoneEntityAge |
número |
Phones[].PhoneEntityTotalPassages |
número |
Phones[].PhoneEntityBadPassages |
número |
Phones[].PhoneEntityCrawlingPassages |
número |
Phones[].PhoneEntityValidationPassages |
número |
Phones[].PhoneEntityQueryPassages |
número |
Phones[].PhoneEntityMonthAveragePassages |
número |
Phones[].PhoneGlobalAge |
número |
Phones[].PhoneGlobalTotalPassages |
número |
Phones[].PhoneGlobalBadPassages |
número |
Phones[].PhoneGlobalCrawlingPassages |
número |
Phones[].PhoneGlobalValidationPassages |
número |
Phones[].PhoneGlobalQueryPassages |
número |
Phones[].PhoneGlobalMonthAveragePassages |
número |
Phones[].Last3MonthsPassages |
número |
Phones[].Last6MonthsPassages |
número |
Phones[].Last12MonthsPassages |
número |
Phones[].Last18MonthsPassages |
número |
Phones[].PhoneNumberOfEntities |
número |
Phones[].PhoneNumberOfFamilyRelatedEntities |
número |
Phones[].PhoneNumberOfRelatedEntities |
número |
Phones[].Priority |
número |
Phones[].IsMainForEntity |
booleano |
Phones[].IsRecentForEntity |
booleano |
Phones[].IsMainForOtherEntity |
booleano |
Phones[].IsRecentForOtherEntity |
booleano |
Phones[].IsActive |
booleano |
Phones[].IsLikelyFromAccountant |
booleano |
Phones[].IsInDoNotCallList |
booleano |
Phones[].CurrentCarrier |
texto |
Phones[].PlanType |
texto |
Phones[].LastValidationDate |
data |
Phones[].EntityFirstPassageDate |
data |
Phones[].EntityLastPassageDate |
data |
Phones[].GlobalFirstPassageDate |
data |
Phones[].GlobalLastPassageDate |
data |
Phones[].CreationDate |
data |
Phones[].LastUpdateDate |
data |
Phones[].HasOptIn |
booleano |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Telefones",
"query_slug": "telefones",
"data": {
"TotalPhones": 0,
"TotalActivePhones": 0,
"TotalWorkPhones": 0,
"TotalPersonalPhones": 0,
"TotalUniquePhones": 0,
"TotalPhonePassages": 0,
"TotalBadPhonePassages": 0,
"TotalLast3MonthsPassages": 0,
"TotalLast6MonthsPassages": 0,
"TotalLast12MonthsPassages": 0,
"TotalLast18MonthsPassages": 0,
"OldestPhonePassageDate": "2026-01-01",
"NewestPhonePassageDate": "2026-01-01",
"Phones": [
{
"Number": "texto",
"AreaCode": "texto",
"CountryCode": "texto",
"Complement": "texto",
"Type": "texto",
"PhoneCurrentlyInRFSite": false,
"PhoneEntityAge": 0,
"PhoneEntityTotalPassages": 0,
"PhoneEntityBadPassages": 0,
"PhoneEntityCrawlingPassages": 0,
"PhoneEntityValidationPassages": 0,
"PhoneEntityQueryPassages": 0,
"PhoneEntityMonthAveragePassages": 0,
"PhoneGlobalAge": 0,
"PhoneGlobalTotalPassages": 0,
"PhoneGlobalBadPassages": 0,
"PhoneGlobalCrawlingPassages": 0,
"PhoneGlobalValidationPassages": 0,
"PhoneGlobalQueryPassages": 0,
"PhoneGlobalMonthAveragePassages": 0,
"Last3MonthsPassages": 0,
"Last6MonthsPassages": 0,
"Last12MonthsPassages": 0,
"Last18MonthsPassages": 0,
"PhoneNumberOfEntities": 0,
"PhoneNumberOfFamilyRelatedEntities": 0,
"PhoneNumberOfRelatedEntities": 0,
"Priority": 0,
"IsMainForEntity": false,
"IsRecentForEntity": false,
"IsMainForOtherEntity": false,
"IsRecentForOtherEntity": false,
"IsActive": false,
"IsLikelyFromAccountant": false,
"IsInDoNotCallList": false,
"CurrentCarrier": "texto",
"PlanType": "texto",
"LastValidationDate": "2026-01-01",
"EntityFirstPassageDate": "2026-01-01",
"EntityLastPassageDate": "2026-01-01",
"GlobalFirstPassageDate": "2026-01-01",
"GlobalLastPassageDate": "2026-01-01",
"CreationDate": "2026-01-01",
"LastUpdateDate": "2026-01-01",
"PortabilityHistory": [
],
"HasOptIn": false
}
]
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.100"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido