Visualizar detalhes de um contrato

Devolve os detalhes de um contrato do cliente: dados básicos, partes, parecer da análise, resumo financeiro, verificações e a conferência das matrículas vinculadas. basicData traz contractNumber, modality, totalAmountDebt, guaranteeValue, ltv (a dívida dividida pela garantia, em percentual com uma casa decimal e vírgula, como "62,5%"; vazio quando a garantia é 0 ou não informada) e signedAt (data de assinatura, em ISO). parties lista as partes com type (o papel), name, taxId (só letras e números) e address (logradouro, bairro, município e UF, ou null quando o contrato não traz endereço). analysisOpinion.comment é o resumo executivo da análise. Em resume, purchaseProperty é o valor principal, fgts e ownResources (a entrada) são null quando o contrato não informa, e credit é o valor principal menos a entrada e o FGTS. validations traz as verificações do checklist da análise e, no fim, LTV acima do recomendado (alert quando o LTV passa de 80% ou não pode ser calculado), Garantia insuficiente (alert quando a garantia é menor que a dívida ou não informada) e Matrículas verificadas (alert quando alguma matrícula vinculada diverge; sem matrículas vinculadas vem positive); polarity é positive, alert ou negative. crossPropertyRegistration.registration traz as matrículas vinculadas, cada uma com a conferência em seis campos booleanos (verdadeiro quando o dado da matrícula confere com o do contrato) e, em consortiumMember, o nome do primeiro proprietário da matrícula; resume conta as que conferem (compliant), as que divergem (divergence) e o total. Contrato inexistente, removido ou que não é do cliente informado devolve 404 (Contrato não encontrado). Requer autenticação via Bearer JWT ou header x-api-key e a permissão de ver contratos de clientes. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e 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).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

curl --location '/v2/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/contracts/3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13/details' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>'

{ "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "createdAt": "2026-10-07T13:45:10.123Z", "basicData": { "contractNumber": "CCB-2026/00123", "modality": "Consórcio imobiliário", "totalAmountDebt": 250000, "guaranteeValue": 400000, "ltv": "62,5%", "signedAt": "2026-09-15" }, "parties": [ { "type": "Devedor fiduciante", "name": "Maria Exemplo da Silva", "taxId": "11144477735", "address": { "address": "Rua Exemplo, nº 100", "neighborhood": "Centro", "municipality": "Cuiabá", "uf": "MT" } }, { "type": "Credor fiduciário", "name": "Administradora Exemplo S.A.", "taxId": "11222333000181", "address": null } ], "analysisOpinion": { "comment": "Contrato com garantia suficiente; uma divergência de FGTS na matrícula vinculada." }, "resume": { "purchaseProperty": 300000, "fgts": 20000, "ownResources": 30000, "credit": 250000 }, "validations": [ { "name": "Documentação completa", "polarity": "positive" }, { "name": "Assinaturas válidas", "polarity": "alert" }, { "name": "LTV acima do recomendado", "polarity": "positive" }, { "name": "Garantia insuficiente", "polarity": "positive" }, { "name": "Matrículas verificadas", "polarity": "alert" } ], "crossPropertyRegistration": { "registration": [ { "_id": "a3bb189e-8bf9-4388-9912-ace4e6543002", "propertyRegistration": "12.345", "consortiumMember": "Maria Exemplo da Silva", "status": "FINALIZADO", "conference": { "contractNumber": true, "registeredProperty": true, "debtorAndOwner": true, "fgts": false, "totalAmountDebt": true, "groupsAndQuotas": true } } ], "resume": { "compliant": 0, "divergence": 1, "total": 1 } } }

Visualizar detalhes de um contrato

Requisição

Respostas