Preparar envio de evidências
/v1/deposits/{id}/evidence-uploadsDevolve URLs temporárias para enviar as fotos do dano por PUT antes da captura.
- Até 20 arquivos por chamada,
image/png,image/jpeg,image/heicouimage/heif. - Envie cada arquivo com
PUTnauploadUrl, com o mesmoContent-Type, antes deexpiresAt, e use osobjectKeyemPOST /deposits/{id}/capture. - Sem
payments:deposits:write→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth payments:deposits: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: payments:deposits:write
id*stringId da caução, dpst_ + 27 letras e dígitos. Inexistente, malformado ou de outro merchant → 404 DEPOSIT.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}$application/json- body
files*array<>1 <= items <= 20URLs de envio.
application/json- response
uploads*array<>curl -X POST 'https://api.sandbox.kodano.com.br/v1/deposits/dpst_7Hq2LmX9vB4nR8sT1wK6yZ3cP0a/evidence-uploads' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'X-Correlation-Id: erp-7f3a-0010' \ -H 'Content-Type: application/json' \ -d '{ "files": [ { "fileName": "sala.jpg", "contentType": "image/jpeg" } ]}'{ "uploads": [ { "fileName": "sala.jpg", "uploadUrl": "https://kodano-deposits.s3.amazonaws.com/…", "objectKey": "deposits/dpst_7Hq2LmX9vB4nR8sT1wK6yZ3cP0a/evidence/7c1e-sala.jpg", "expiresAt": "2026-12-05T13:15:00Z" } ]}