Contatos e endereços

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}/pessoas/telefones

CampoObrigatórioDescrição
document sim CPF da pessoa, com ou sem máscara.
{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
Phones[].Type texto
Phones[].Number texto
Phones[].AreaCode texto
Phones[].HasOptIn booleano
Phones[].IsActive booleano
Phones[].PlanType texto
Phones[].Priority número
Phones[].Complement texto
Phones[].CountryCode texto
Phones[].CreationDate data
Phones[].CurrentCarrier texto
Phones[].LastUpdateDate data
Phones[].PhoneEntityAge número
Phones[].PhoneGlobalAge número
Phones[].IsMainForEntity booleano
Phones[].IsInDoNotCallList booleano
Phones[].IsRecentForEntity booleano
Phones[].LastValidationDate data
Phones[].Last3MonthsPassages número
Phones[].Last6MonthsPassages número
Phones[].IsMainForOtherEntity booleano
Phones[].Last12MonthsPassages número
Phones[].Last18MonthsPassages número
Phones[].EntityLastPassageDate data
Phones[].GlobalLastPassageDate data
Phones[].PhoneNumberOfEntities número
Phones[].EntityFirstPassageDate data
Phones[].GlobalFirstPassageDate data
Phones[].IsLikelyFromAccountant booleano
Phones[].IsRecentForOtherEntity booleano
Phones[].PhoneCurrentlyInRFSite booleano
Phones[].PhoneEntityBadPassages número
Phones[].PhoneGlobalBadPassages número
Phones[].PhoneEntityQueryPassages número
Phones[].PhoneEntityTotalPassages número
Phones[].PhoneGlobalQueryPassages número
Phones[].PhoneGlobalTotalPassages número
Phones[].PhoneEntityCrawlingPassages número
Phones[].PhoneGlobalCrawlingPassages número
Phones[].PhoneNumberOfRelatedEntities número
Phones[].PhoneEntityValidationPassages número
Phones[].PhoneGlobalValidationPassages número
Phones[].PhoneEntityMonthAveragePassages número
Phones[].PhoneGlobalMonthAveragePassages número
Phones[].PhoneNumberOfFamilyRelatedEntities número
TotalPhones número
TotalWorkPhones número
TotalActivePhones número
TotalUniquePhones número
TotalPhonePassages número
TotalPersonalPhones número
TotalBadPhonePassages número
NewestPhonePassageDate data
OldestPhonePassageDate data
TotalLast3MonthsPassages número
TotalLast6MonthsPassages número
TotalLast12MonthsPassages número
TotalLast18MonthsPassages número

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": {
    "Phones": [
      {
        "Type": "texto",
        "Number": "texto",
        "AreaCode": "texto",
        "HasOptIn": false,
        "IsActive": false,
        "PlanType": "texto",
        "Priority": 0,
        "Complement": "texto",
        "CountryCode": "texto",
        "CreationDate": "2026-01-01",
        "CurrentCarrier": "texto",
        "LastUpdateDate": "2026-01-01",
        "PhoneEntityAge": 0,
        "PhoneGlobalAge": 0,
        "IsMainForEntity": false,
        "IsInDoNotCallList": false,
        "IsRecentForEntity": false,
        "LastValidationDate": "2026-01-01",
        "PortabilityHistory": [

        ],
        "Last3MonthsPassages": 0,
        "Last6MonthsPassages": 0,
        "IsMainForOtherEntity": false,
        "Last12MonthsPassages": 0,
        "Last18MonthsPassages": 0,
        "EntityLastPassageDate": "2026-01-01",
        "GlobalLastPassageDate": "2026-01-01",
        "PhoneNumberOfEntities": 0,
        "EntityFirstPassageDate": "2026-01-01",
        "GlobalFirstPassageDate": "2026-01-01",
        "IsLikelyFromAccountant": false,
        "IsRecentForOtherEntity": false,
        "PhoneCurrentlyInRFSite": false,
        "PhoneEntityBadPassages": 0,
        "PhoneGlobalBadPassages": 0,
        "PhoneEntityQueryPassages": 0,
        "PhoneEntityTotalPassages": 0,
        "PhoneGlobalQueryPassages": 0,
        "PhoneGlobalTotalPassages": 0,
        "PhoneEntityCrawlingPassages": 0,
        "PhoneGlobalCrawlingPassages": 0,
        "PhoneNumberOfRelatedEntities": 0,
        "PhoneEntityValidationPassages": 0,
        "PhoneGlobalValidationPassages": 0,
        "PhoneEntityMonthAveragePassages": 0,
        "PhoneGlobalMonthAveragePassages": 0,
        "PhoneNumberOfFamilyRelatedEntities": 0
      }
    ],
    "TotalPhones": 0,
    "TotalWorkPhones": 0,
    "TotalActivePhones": 0,
    "TotalUniquePhones": 0,
    "TotalPhonePassages": 0,
    "TotalPersonalPhones": 0,
    "TotalBadPhonePassages": 0,
    "NewestPhonePassageDate": "2026-01-01",
    "OldestPhonePassageDate": "2026-01-01",
    "TotalLast3MonthsPassages": 0,
    "TotalLast6MonthsPassages": 0,
    "TotalLast12MonthsPassages": 0,
    "TotalLast18MonthsPassages": 0
  },
  "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