Baixar certidão do CAR

GET

/v2/queries/clients/cars/download/{carId}

Devolve a certidão do imóvel CAR identificado em carId: o conteúdo do arquivo em file e a extensão em fileExtension. O carId é o identificador do imóvel CAR já cadastrado em uma consulta (o _id de cada imóvel nas listagens de imóveis CAR de uma consulta), não o código do CAR. A certidão é buscada no serviço de consulta de CAR a partir do código do imóvel. Imóvel não encontrado, ou sem código do CAR, devolve 404. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Certidão do CAR

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404CAR não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/cars/download/c4a7e1b2-6d3f-4a85-b9e0-1f2d3c4b5a69' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "file": "conteudo-do-arquivo",
    "fileExtension": "pdf"
}

Modificado em 2026-10-13 09:47:06

Página anterior

Atualizar imóvel CAR

Próxima página

Cadastrar geometria NDVI de um imóvel CAR