IDs públicos

Todos os recursos da API Aberta são identificados por IDs públicos encriptados — strings como "epz7Z..." ou "eyJpdi..." — em vez de números sequenciais.

Regras de ouro

  • Use sempre o id retornado pela própria API para buscar detalhes (GET /recurso/{id}) ou filtrar recursos relacionados (proprietarioId, imovelId, contaId...).
  • Não tente adivinhar ou construir IDs — eles não seguem sequência numérica.
  • Os códigos numéricos (codigo, codigoInterno) servem para busca e conferência visual, mas não substituem o id nas rotas de detalhe.
📘

Usar o codigo numérico no lugar do ID público em uma rota /{id} retorna 404 Não encontrado.

Exemplo prático

O retorno de GET /imoveis traz os proprietários com seus IDs públicos:

{
  "proprietarios": [
    { "pessoaId": "oJ94MO1O8q" }
  ]
}

Esse pessoaId pode ser usado direto em GET /pessoas/oJ94MO1O8q para obter nome, documento e contatos.


Did this page help you?