Consultar contrato
/v1/contracts/{id}Devolve o contrato com os signatários.
signUrlficanullpara quem já assinou ou recusou e quando o contrato está encerrado.- Inexistente, malformado ou de outro merchant → 404
CONTRACT.NOT_FOUND. - Sem
contracts:contracts:read→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth contracts:contracts:readAuthorizationBearer <token>Token obtido no Zitadel do ambiente (POST /oauth/v2/token), fora do host da API, e enviado em Authorization: Bearer <access_token>.
- Sandbox:
https://kodano-uat-p55zt6.us1.zitadel.cloud/oauth/v2/token - Produção:
https://kodano-prod-qe8hbt.us1.zitadel.cloud/oauth/v2/token
Use sempre o tokenUrl devolvido na emissão da credencial. Duas variantes: private_key_jwt (preferida; grant urn:ietf:params:oauth:grant-type:jwt-bearer com assertion RS256 assinada pela chave da credencial, iss = sub = userId, aud = authority do Zitadel, kid = keyId) e client_secret (grant client_credentials). O OpenAPI só modela a segunda.
O parâmetro scope do token é OIDC, não os escopos da API: openid urn:zitadel:iam:org:project:id:<projectId da API>:aud urn:zitadel:iam:user:resourceowner. Sem o :aud a API responde 401 AUTH.TOKEN_INVALID; sem resourceowner, 403 AUTH.TENANT_MISMATCH.
Os 28 escopos abaixo são os entitlements concedidos à credencial pelos produtos de integração (produto:recurso:ação; write não implica read), avaliados a cada requisição; não são pedidos no token. O tenant vem da organização do token; o merchant, de X-Merchant-Id. Revogar a credencial nega os tokens já emitidos em até 60 s.
Scope: contracts:contracts:read
id*stringId do contrato, ctr_ + 32 hexadecimais. Inexistente, malformado ou de outro merchant → 404 CONTRACT.NOT_FOUND.
X-Merchant-Id*stringMerchant da operação (mrc_ + Guid sem hífens, minúsculo). Obrigatório com credencial de organização (ausente → 400 MERCHANT.HEADER_REQUIRED); com credencial de merchant é opcional (ausente = o próprio merchant). Malformado, repetido, inexistente ou de outro tenant → 403 MERCHANT.FORBIDDEN (nunca 404). Vazio = ausente.
^mrc_[0-9a-f]{32}$X-Correlation-Id?stringOpcional, sempre ecoado na resposta e repetido em correlationId do Problem. Ausente ou inválido → o serviço gera UUID v7.
^[A-Za-z0-9._-]{1,64}$Contrato.
application/json- response
id*stringctr_ + 32 hexadecimais.
status*ContractStatusdraft só existe durante a emissão; signed, refused, expired e canceled são finais.
"draft""pending_signature""viewed""partially_signed""signed""refused""expired""canceled"name*stringdescription*string|nullcontractTemplateId*string|nullcontractFileId*string|nullsignersExpected*integersignersSigned*integerrequiredSignersExpected*integerrequiredSignersSigned*integerallowRefusal*booleanadvancedAuth*booleanrefusedReason*string|nullexpiresAt*|date-timeeffectiveAt*|date-timesignedAt*|date-timecanceledAt*|date-timehasSignedFile*booleantagValues*array<>signers*array<>createdAt*stringdate-timeupdatedAt*stringdate-timecurl -X GET 'https://api.sandbox.kodano.com.br/v1/contracts/ctr_0192f3b0c4d17e8a9b2f5c6d7e8f9a0b' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010'{ "id": "ctr_0192f3c1a7b84e2d9f0a1b2c3d4e5f60", "status": "pending_signature", "name": "Locação Villa Trancoso 21–28/11", "description": null, "contractTemplateId": "ctt_0192f3a0b1c24d3e8f9a0b1c2d3e4f50", "contractFileId": null, "signersExpected": 1, "signersSigned": 0, "requiredSignersExpected": 1, "requiredSignersSigned": 0, "allowRefusal": true, "advancedAuth": false, "refusedReason": null, "expiresAt": "2026-11-27T15:00:00Z", "effectiveAt": null, "signedAt": null, "canceledAt": null, "hasSignedFile": false, "tagValues": [ { "tag": "imovel", "value": "Villa Trancoso" }, { "tag": "inicio", "value": "21/11/2026" } ], "signers": [ { "id": "sgn_0192f3c1b2c34d5e6f7a8b9c0d1e2f30", "sequence": 1, "role": "payer", "isRequired": true, "name": "Ana Souza", "email": "ana@exemplo.com", "status": "new", "timesViewed": 0, "lastViewedAt": null, "signedAt": null, "refusedAt": null, "signUrl": "https://api.kodano.com.br/merchant/v1/public/contracts/r/q8Zt3mW1xY7pK2vB9nL4cR6hD0sF5gJ" } ], "createdAt": "2026-10-28T15:00:00Z", "updatedAt": "2026-10-28T15:00:00Z"}