Built by Metorial, the integration platform for agentic AI.
Launch an embedded OKSign document editor that allows users to interactively add and position signature and form fields on a document. After editing, use the "Get Form Descriptor" tool to retrieve the updated field configuration for use in the standard signing flow.
Retrieve a downloadable PDF audit trail report for a source or signed document. The audit trail provides certified proof of all actions performed on the document — access, review, and signatures — with timestamps and document hash verification.
Retrieve detailed metadata from a signed document, including signature details (who signed, when, authentication method), form field values, and document status. Uses the v2 metadata endpoint for enhanced field information.
Retrieve all contacts from your OKSign account. Returns the full contact list with names, emails, mobile numbers, roles, and groups.
Define signature and form fields on an uploaded document, configure signers, and receive signing URLs. Supports signature boxes, text fields, text areas, select dropdowns, date fields, and checkboxes. Fields can be positioned using coordinates or text markers embedded in the document. Returns a signing URL for each signer.
Look up linked source and signed document ID pairs. Given a document ID, returns the mapping between original (source) and signed document IDs.
Create an embedded "Sign now" signing flow for face-to-face signing scenarios. Generates a time-limited signing URL for a specific signer and set of documents that can be embedded in your application. Default validity is 90 days. Configure each document form first and use a signer ID present in its form descriptor.
Retrieve OKSign account information including credit balance, team members, and email templates. Returns a combined view of account details useful for monitoring usage and managing team access.
Replace the callback URL, return URL, and webhook URL linked to the current organizational token (API key). These URLs control where OKSign sends signature callbacks, browser redirects, and notification delivery error reports.
Retrieve a list of documents that are currently active (pending signatures) on the OKSign platform.
Retrieve configuration and details of an existing EditorExpress session.
Upload a PDF or Word document to OKSign for signing. Word documents (.doc, .docx) are automatically converted to PDF upon upload. Returns a document ID that is used in all subsequent operations (form configuration, notifications, signing).
Prepare a source or signed document as a downloadable PDF. Use get_linked_documents to find the signed document ID when you have its source ID.
Check if a document exists on the OKSign platform and retrieve its basic info including filename and whether it's a reusable template. Provider errors are reported rather than treated as missing documents.
Send email and/or SMS notifications to signers informing them a document is ready for signing. Supports HTML email body, configurable reminders, CC recipients, and sequential signing workflows. Replaces any previously pending notifications for the document.
Remove a contact from your OKSign account by their exact name and email. Call list_contacts to discover both values.
Retrieve configuration and details of an existing briefcase (document bundle).
Delete a SignExpress session from the OKSign platform, invalidating its signing URL.
Calculate an OKSign signer ID from a person's name and email. Signer IDs are required when configuring form fields and sending notifications. The ID follows the format: bt_00000000-0000-0000-0000-0000000-XXXXXXXXXXXX.
List signing events in a time range for documents uploaded through the API. Returns source and signed document IDs, signer details, timestamps, and signature counts. An event may represent a partially signed document.
Retrieve configuration and details of an existing SignExpress session.
Remove a document from the OKSign platform. Documents remain available until explicitly removed. Cannot be undone.
Delete a briefcase (document bundle) from the OKSign platform. This does not delete the individual documents.
Add or update contacts in your OKSign account. Contacts are uniquely identified by the combination of email and name. If a contact with the same email and name already exists, it will be updated; otherwise, a new contact is created.
Delete an EditorExpress session from the OKSign platform.
Bundle multiple documents together so signers can sign all of them using a single signing link. Each document must have its form descriptor configured beforehand, and all documents must use the same signer IDs. Supports custom package names displayed during signing.
Retrieve the form descriptor (field configuration) for a document. Returns all configured fields, signer information, and signing options.