Signing Packets

Create a multi-document signing packet

post/api/v1/signing-packets

Request

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

Request body

sandboxboolean

Dashboard mode. API keys always use their authenticated mode.

sourceCollectionIdstring uuid
namestring required
externalIdstring
accessMode'email_verification' | 'link'
redirectUrlstring
expiresAtstring date-time

Example request

{
  "name": "Series A closing documents",
  "recipient": {
    "name": "Alex Manager",
    "email": "alex@example.com"
  },
  "items": [
    {
      "fieldValues": [
        {
          "value": "250000.00"
        }
      ]
    }
  ]
}

Response

sourceCollectionIdstring uuid nullable
idstring uuid required
publicIdstring uuid required
namestring required
externalIdstring nullable
sandboxboolean required
expiresAtstring date-time nullable
senderNamestring required
senderOrganizationNamestring nullable
status'draft' | 'sent' | 'viewed' | 'processing' | 'partially_completed' | 'recipient_completed' | 'voided' | 'expired' required
accessMode'email_verification' | 'link' required
signingUrlstring
certificateUrlstring nullable
auditReportUrlstring nullable

Deprecated alias for certificateUrl

redirectUrlstring nullable
deliveryStatus'not_requested' | 'sent' | 'failed'

Example response

{
  "brand": {
    "primaryColor": "#2563EB"
  },
  "items": [
    {
      "fields": [
        {
          "inputMask": "###-##-####",
          "fontSize": 9,
          "textColor": "#000080",
          "fontFamily": "Helvetica-Bold"
        }
      ]
    }
  ]
}

Changes

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