@korala/public-dtos

@korala/public-dtos

TypeScript type definitions for the Korala document signing API.

Installation

npm install @korala/public-dtos

Usage

import {
  DocumentStatus,
  FieldType,
  type DocumentDto,
  type SignerDto,
} from '@korala/public-dtos';

function isComplete(doc: DocumentDto): boolean {
  return doc.status === DocumentStatus.Completed;
}

Note: Most users should use @korala/api-client which re-exports all types from this package. Install this package directly only if you need the types without the API client.

Exported Types

Enums

Enum	Values
DocumentStatus	Draft, Pending, Completed, Voided, Declined
FieldType	Signature, Initials, Date, Text, Checkbox
AuthMethod	Bearer, Hmac
SignerStatus	Pending, Viewed, Signed, Declined

DTOs

Documents, signers, fields, templates, webhooks, signatures, and all request/response types used by the Korala API.

Documentation

Full API documentation at docs.korala.ai.

License

MIT

Collections

Use collections to group documents and templates within your organization and mode. Supply collectionIds when creating a resource. Choose destinations for each generated document; template memberships do not carry over. The public exports include collection, membership, pagination, and query types. See the collections guide for limits and the full workflow.