Documents

Add a signer to the document

post/api/v1/documents/{id}/signers

Request

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

Path parameters

idstring required

Request body

emailstring

Signer email. Required for email notifications.

namestring required
signingOrdernumber
externalIdstring

External identifier for tracking signers in your system

redirectUrlstring

URL to redirect signer after signing. Must be HTTPS (or localhost for development).

Example request

{
  "email": "john@example.com",
  "name": "John Doe",
  "signingOrder": 1,
  "externalId": "user_123",
  "redirectUrl": "https://example.com/done"
}

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.