Adicionar signatário
/v1/contracts/{id}/signersAcrescenta um signatário a um contrato ainda não encerrado e devolve o signatário com signUrl.
- No máximo 10 signatários; contrato encerrado → 409
CONTRACT.NOT_EDITABLE. - Sem
contracts:contracts:write→ 403AUTH.ENTITLEMENT_MISSING.
kodanoOAuth contracts:contracts: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:contracts:write
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}$Idempotency-Key*stringUUID, retido por 24 h a partir da primeira chamada. Escopo: (tenant, merchant, rota-template, chave). Mesma chave e mesmo corpo → resposta original (2xx ou 4xx) com X-Idempotent-Replay: true; corpo ou path concreto diferente → 409 IDEMPOTENCY.CONFLICT; em execução ou desfecho desconhecido → 409 IDEMPOTENCY.IN_PROGRESS com resourceId e Retry-After: 2. Ausente ou não-UUID → 422 IDEMPOTENCY.KEY_REQUIRED.
uuidX-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
name*string1 <= length <= 255email*stringemaillength <= 255phone*cpf?stringObrigatório com authentication.advancedCpf.
^[0-9]{11}$role?string"payer""merchant""witness""guarantor""other"authentication?Exigências de autenticação na assinatura. Sem o objeto, vale a assinatura na tela.
Signatário adicionado.
application/json- response
id*stringsequence*integerrole*ContractSignerRole"payer""merchant""witness""guarantor""other"isRequired*booleanname*stringemail*stringstatus*string"new""viewed""signed""refused"timesViewed*integerlastViewedAt*|date-timesignedAt*|date-timerefusedAt*|date-timesignUrl*|Link da Kodano para assinar; null depois de assinar ou recusar e com o contrato encerrado.
uricurl -X POST 'https://api.sandbox.kodano.com.br/v1/contracts/ctr_0192f3b0c4d17e8a9b2f5c6d7e8f9a0b/signers' \ -H 'X-Merchant-Id: mrc_0f8fad5bd9cb469fa16570867728950e' \ -H 'Idempotency-Key: 4b2e8c1a-9d7f-4e3b-a6c5-0f1e2d3c4b5a' \ -H 'X-Correlation-Id: erp-7f3a-0010' \ -H 'Content-Type: application/json' \ -d '{ "name": "Bruno Lima", "email": "bruno@exemplo.com", "phone": { "areaCode": "71", "number": "988880000" }, "role": "guarantor"}'{ "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"}