Listar matrículas sem contrato de um cliente

GET

/v2/queries/clients/{clientId}/registry-analysis/without-contract

Lista as matrículas analisadas do cliente que ainda não estão vinculadas a um contrato e não foram removidas, da mais recente para a mais antiga. Cada item traz _id, registryNumber (número da matrícula), city (município), address (endereço), onus (verdadeiro quando há ônus registrado) e onusValue (o texto do ônus). Os campos de texto vêm vazios quando a análise não os trouxe, e onus é falso quando onusValue está vazio ou começa com "Nenhum" (sem diferenciar maiúsculas). total é a quantidade de matrículas que atendem à busca, sem a paginação. offset e limit paginam (offset a partir de 0, padrão 0; limit de 1 a 100, padrão 20). search filtra pelo número da matrícula: se tem algum dígito, só os dígitos contam e basta o número da matrícula conter essa sequência; se não tem dígito, procura o texto no número da matrícula, sem diferenciar maiúsculas. Requer autenticação via Bearer JWT ou header x-api-key e a permissão de ver matrículas de clientes. Usuário inativo devolve 404 (Usuário não encontrado); usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada).

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 de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Matrículas sem contrato do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver matrículas

🟠403Acesso negado

🟠422Parâmetros de consulta inválidos

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v2/queries/clients/CLIENT_ID/registry-analysis/without-contract?search=12345&offset=0&limit=20' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "a3bb189e-8bf9-4388-9912-ace4e6543002",
            "registryNumber": "12.345",
            "city": "Cuiabá",
            "address": "Rua Exemplo, nº 100, Centro",
            "onus": false,
            "onusValue": "Nenhum"
        },
        {
            "_id": "d41f6c8a-9e27-4b05-a3d1-8c5e7f0b2a96",
            "registryNumber": "67.890",
            "city": "Rondonópolis",
            "address": "Fazenda Exemplo, Zona Rural",
            "onus": true,
            "onusValue": "Alienação fiduciária em favor de Banco Exemplo S.A."
        }
    ],
    "total": 2
}

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

Página anterior

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

Próxima página

Visualizar análise de matrícula