Telefones

Telefones vinculados a um CPF, com tipo, operadora e indicação de qual é o principal.

Entrada: CPFAssíncrona (requestId)

Quando usar

Localização de devedor

Encontre canais de contato para uma cobrança existente.

Atualização cadastral

Complete ou corrija os contatos da sua base.

Como funciona

Fluxo assíncrono

Seu sistemaAPI
  1. 1POSTCriar consulta

    Envia o documento e recebe o requestId na hora.

  2. 2GETAcompanhar

    Repete a chamada com o requestId enquanto o status for pending.

  3. 3GETBuscar resultado

    Com status done, o resultado completo vem em data.

Como acompanhar o resultado

Repita o GET a cada 2 ou 3 segundos até o status ser done ou error. A maioria das consultas termina em poucos segundos.

Passo 1

Criar consulta

POST/api/partner/v2/people/phones

Criar consulta de telefones (CPF).

Corpo da requisição

  • documentstringobrigatório

    CPF com 11 dígitos (apenas números)

Respostas

  • 200Solicitação criada com sucesso
curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/people/phones" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{"document":"12345678901"}'
Resposta · 200
{
  "requestId": "cm8p1q2r30004ab12cdef5678",
  "message": "Solicitação realizada com sucesso"
}

Passo 2

Buscar resultado

GET/api/partner/v2/people/phones/{requestId}

Consultar resultado de telefones (CPF).

Parâmetros do caminho

  • requestIdstringno caminhoobrigatório

Respostas

  • 200Resultado da solicitação
curl -X GET "https://consultadeprocessos.com.br/api/partner/v2/people/phones/cm8p1q2r30004ab12cdef5678" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"
Resposta · 200
{
  "data": {
    "document": "12345678901",
    "totalPhones": 3,
    "totalWorkPhones": 1,
    "totalActivePhones": 1,
    "totalUniquePhones": 3,
    "totalPersonalPhones": 2,
    "phones": [
      {
        "id": null,
        "type": "MOBILE",
        "number": "987654321",
        "areaCode": "11",
        "countryCode": "55",
        "isActive": true,
        "priority": 1,
        "complement": null,
        "creationDate": "2015-04-10T00:00:00.000Z",
        "lastUpdateDate": "2025-08-21T00:00:00.000Z",
        "currentCarrier": "VIVO",
        "isMainForEntity": true,
        "isInDoNotCallList": false,
        "isRecentForEntity": true,
        "isMainForOtherEntity": false,
        "phoneNumberOfEntities": 1,
        "isRecentForOtherEntity": false
      },
      {
        "id": null,
        "type": "HOME",
        "number": "34567890",
        "areaCode": "11",
        "countryCode": "55",
        "isActive": false,
        "priority": 2,
        "complement": null,
        "creationDate": "2012-02-03T00:00:00.000Z",
        "lastUpdateDate": "2020-11-15T00:00:00.000Z",
        "currentCarrier": "OI",
        "isMainForEntity": false,
        "isInDoNotCallList": false,
        "isRecentForEntity": false,
        "isMainForOtherEntity": false,
        "phoneNumberOfEntities": 2,
        "isRecentForOtherEntity": false
      },
      {
        "id": null,
        "type": "WORK",
        "number": "33221100",
        "areaCode": "21",
        "countryCode": "55",
        "isActive": false,
        "priority": 3,
        "complement": null,
        "creationDate": "2019-06-01T00:00:00.000Z",
        "lastUpdateDate": "2024-03-12T00:00:00.000Z",
        "currentCarrier": "CLARO",
        "isMainForEntity": false,
        "isInDoNotCallList": true,
        "isRecentForEntity": false,
        "isMainForOtherEntity": false,
        "phoneNumberOfEntities": 1,
        "isRecentForOtherEntity": false
      }
    ],
    "createdAt": "2026-09-30T14:22:10.000Z",
    "updatedAt": "2026-09-30T14:22:10.000Z"
  },
  "status": "done"
}

O que a resposta traz

Resumo

  • Total de telefones e quantos estão ativos
    totalPhones · totalActivePhones
  • Telefones pessoais e de trabalho
    totalPersonalPhones · totalWorkPhones
  • Números distintos
    totalUniquePhones
  • Consulta por CNPJSó no painel

Em cada telefone

  • Número
    countryCode · areaCode · number

    DDI, DDD e número em campos separados.

  • Tipo
    type

    Celular (MOBILE), residencial (HOME) ou comercial (WORK).

  • Operadora atual
    currentCarrier
  • Ativo
    isActive
  • Lista Não Perturbe
    isInDoNotCallList

    Indica que o número pediu para não receber ligações de telemarketing.

  • Prioridade
    priority

    Ordem de relevância do número para o titular. 1 é o mais relevante.

  • Principal e recente do titular
    isMainForEntity · isRecentForEntity
  • Uso por outras pessoas
    phoneNumberOfEntities

    Quantas pessoas usam o número. isMainForOtherEntity e isRecentForOtherEntity indicam se é principal ou recente para elas.

  • Data de criação e última atualização
    creationDate · lastUpdateDate
  • Complemento
    complement

    Ramal ou observação, quando houver.

Valores por plano

Plano mensalValor da consulta

Sob demanda

R$ 2,00

O valor é cobrado por consulta, na criação da consulta. Ler o resultado de novo pelo mesmo requestId não gera nova cobrança.

Sem plano, a conta usa o valor Sob demanda e paga só o que consumir.

Comparar planos

Próximos passos