Documents

Rename a signer or change their signing order (draft only)

patch/api/v1/documents/{id}/signers/{signerId}

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/documents/{id}/signers/{signerId}
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required
signerIdstring required

Request body

namestring
signingOrdernumber

Signers with the same order sign at the same time; a higher order waits for every lower one.

Example request

{
  "name": "John Doe",
  "signingOrder": 2
}

Response

idstring required
documentIdstring required
emailstring nullable
namestring required
externalIdstring nullable
role'signer' | 'approver' | 'cc' required
signingOrdernumber required
status'pending' | 'viewed' | 'signed' | 'declined' required
authMethod'email_link' | 'access_link' | 'wallet_signature' required
signedAtstring date-time nullable
accessTokenstring required
redirectUrlstring nullable

URL to redirect signer after signing

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.