Consulta de Processos
Entrar

Endereços

Endereços vinculados a um CPF, com CEP, cidade, tipo e indicação de qual é o principal.

Entrada: CPFAssíncrona (requestId)
Gerar chave de APIVer preços

Quando usar

Citação e intimação

Encontre endereços atualizados da parte contrária.

Localização de devedor

Saiba onde enviar uma notificação de cobrança.

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/addresses

Criar consulta de endereços (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/addresses" \
  -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/addresses/{requestId}

Consultar resultado de endereços (CPF).

Parâmetros do caminho

  • requestIdstringno caminhoobrigatório

Respostas

  • 200Resultado da solicitação
curl -X GET "https://consultadeprocessos.com.br/api/partner/v2/people/addresses/cm8p1q2r30004ab12cdef5678" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"
Resposta · 200
{
  "data": {
    "document": "12345678901",
    "totalAddresses": 1,
    "totalActiveAddresses": 1,
    "totalWorkAddresses": 0,
    "totalPersonalAddresses": 1,
    "addresses": [
      {
        "id": "cm8p1q2r30004ab12cdef9999",
        "typology": "RUA",
        "title": "",
        "addressMain": "DAS FLORES",
        "number": "120",
        "complement": "AP 31",
        "neighborhood": "CENTRO",
        "zipCode": "01001000",
        "city": "SAO PAULO",
        "state": "SP",
        "country": "BRASIL",
        "type": "HOME",
        "priority": 1,
        "isMainForEntity": true,
        "isRecentForEntity": true
      }
    ]
  },
  "status": "done"
}

O que a resposta traz

Resumo

  • Totais de endereços, ativos, profissionais e residenciais
    totalAddresses · totalActiveAddresses · totalWorkAddresses · totalPersonalAddresses

Endereços

  • Logradouro, número e complemento
    addresses[].typology · addressMain · number · complement
  • Bairro, CEP, cidade e UF
    neighborhood · zipCode · city · state
  • Tipo e prioridade
    type · priority
  • Principal ou recente para o titular
    isMainForEntity · isRecentForEntity

Valores por plano

Plano mensalValor da consulta

Sob demanda

Indisponível

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

Autenticação

Gere a chave e envie no cabeçalho.

Erros e códigos

Como tratar cada resposta de erro.

Cobrança e reembolso

Quando cobramos e quando o valor volta.

Dados cadastrais CPF

Nome, data de nascimento, filiação e situação cadastral de uma pessoa pelo CPF.

Dados cadastrais CNPJ

Razão social, situação cadastral, CNAE, natureza jurídica e capital social de uma empresa pelo CNPJ.

Telefones

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