Solicitar análise de matrícula de um imóvel

POST

/v2/queries/property-registry/{clientId}

Registra uma solicitação de análise de matrícula para o cliente, debita o saldo da empresa, registra o faturamento e abre o chamado correspondente no Jira. registry, city e state são obrigatórios; carCode é opcional e vincula a solicitação a um imóvel CAR. A solicitação nasce com status EM_PROGRESSO. 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

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200

application/json

Inferred 200 (from source code)

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404Objeto não encontrado

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/property-registry/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "carCode": "string",
    "registry": "string",
    "city": "string",
    "state": "string"
}'

Response Example

200 - Sucesso

{
    "message": "Solicitação de Matrícula de Imóvel registrada com sucesso."
}

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

Página anterior

Cria análise de registro de um cliente

Próxima página

Listar matrículas sem contrato de um cliente