Analisar modelo de contrato
/v1/contract-templates/analyzeLê o .docx e devolve as tags encontradas, sem criar nada. Útil para conferir o arquivo antes do envio.
existingTemplateIdaponta o modelo do merchant com o mesmo conteúdo, quando houver.- Arquivo inválido → 422
CONTRACT.FILE_INVALID. - Sem
contracts:templates:write→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth contracts:templates:writeAuthorizationBearer <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:templates:write
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}$Arquivo .docx.
multipart/form-data- body
file*file.docx com tags {{tag}}.
binaryname?stringlength <= 255description?stringlength <= 1000Análise do arquivo.
application/json- response
fileName*stringsizeBytes*integersha256*stringtags*array<string>existingTemplateId*string|nullcurl -X POST 'https://api.sandbox.kodano.com.br/v1/contract-templates/analyze' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010' \ -F 'file=string'{ "fileName": "locacao.docx", "sizeBytes": 48210, "sha256": "9f2c6a0e1b4d7c3a8e5f2b1d0c9a8b7e6f5d4c3b2a1908f7e6d5c4b3a2918f7e", "tags": [ "imovel", "inicio", "fim", "valor" ], "existingTemplateId": null}