Pular para o conteúdo principal
POST
Consulta imóveis financiados

Autorizações

x-api-key
string
header
obrigatório

Corpo

application/json
document
string
obrigatório

CPF do titular, com ou sem máscara. Separadores são aceitos e ignorados. O dígito verificador é validado antes da consulta.

Exemplo:

"12345678909"

Resposta

Imóveis financiados do CPF informado. summary traz os totais e a distribuição por UF (da maior contagem para a menor); financings traz um item por financiamento. Valores em reais e totalArea em m². Campos opcionais (totalFundedValue, totalArea, purchaseValue, appraisalValue) não vêm no corpo quando o provedor não informa — appraisalValue só existe quando há um imóvel do titular no mesmo bairro/município/UF do financiamento, e pode ser menor que purchaseValue (fontes diferentes). Titular sem nenhum financiamento vem com os totais zerados e as listas vazias.

The response is of type object.