Documents

Send document for signing

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

Request

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

Path parameters

idstring required

Request body

suppressNotificationsboolean

Suppress all email notifications for this document (signing invitations and completion emails)

expiresInDaysnumber

Expire this document if unsigned after N days from send. Overrides the organization's default. Omit to use the org default (or never expire).

Example request

{
  "electronicDisclosure": {
    "id": "acme-electronic-signing-terms",
    "version": "2026-09-01",
    "title": "Electronic signature disclosure"
  },
  "expiresInDays": 14
}

Response

collectionIdsstring[]

Collection memberships; omitted on lists unless includeCollections=true.

idstring required
namestring required
status'draft' | 'pending' | 'completing' | 'completed' | 'failed' | 'voided' | 'expired' required
originalFileUrlstring required
signedFileUrlstring nullable
certificateFileUrlstring nullable
expiresAtstring date-time nullable
completedAtstring date-time nullable
sandboxboolean required

Whether this is a sandbox (test) document

suppressNotificationsboolean required

Whether email notifications are suppressed

formFieldsDetectednumber nullable

How many interactive form fields the uploaded PDF ships with, counted when the upload was confirmed. 0 for a flat PDF, null when the file was never scanned (e.g. generated from a template).

autoImportFormFieldsboolean required

Whether those embedded fields are placed automatically for the first signer added to this document.

catalogFormSlugstring nullable

Standard Forms catalog slug this document was generated from, e.g. "irs-w9" (null for non-catalog documents)

catalogFormTitlestring nullable

Catalog form title, e.g. "IRS Form W-9 …"

catalogRevisionstring nullable

Catalog form revision, e.g. "Rev. March 2024"

catalogVersionIdstring nullable

ID of the catalog form version this document is based on

templateIdstring uuid nullable

The workspace template this document was created from

templateNamestring nullable

That template's current name, on the document detail only (null if the template was deleted)

signerNamesstring[]

Names of the people signing, in signing order. On document lists only.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "formFieldsDetected": 23
}

Changes

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