Visualizar análise de matrícula

GET

/v2/queries/clients/{clientId}/registry-analysis/{id}

Visualiza uma análise de matrícula pelo id: o arquivo enviado, o status do processamento e o conteúdo extraído da matrícula — dados do imóvel, proprietários, histórico de registros e o parecer. O município vem no formato CIDADE/UF. 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

Harvested 200

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/CLIENT_ID/registry-analysis/REGISTRY_ID' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "_id": "string",
    "clientId": "string",
    "companyId": "string",
    "queryId": "string",
    "fileUrl": "string",
    "fileName": "string",
    "status": "string",
    "registry": {
        "property": {
            "registry": "string",
            "startDate": "1998-04-03",
            "area": 0,
            "areaUnity": "ha",
            "address": "string",
            "city": "string",
            "improvements": "string",
            "incraNum": "000.000.000.000-0",
            "nirfCib": "0.000.000-0",
            "onus": "string"
        },
        "owners": [
            {
                "name": "string",
                "taxId": "00000000000",
                "civilStatus": "string",
                "nationality": "string",
                "profession": "string",
                "spouse": "string"
            }
        ],
        "registryHistory": [
            {
                "title": "stringR-3",
                "content": "string"
            }
        ],
        "opinion": "string"
    },
    "createdAt": "2026-09-01T13:30:06.595Z",
    "updatedAt": "2026-09-01T13:31:03.739Z",
    "errors": [
        "string"
    ]
}

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

Página anterior

Listar matrículas sem contrato de um cliente

Próxima página

Remover análise de matrícula