Skip to main content
Oksign logo
  • Category: signatures
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: OKSIGN
  • Version: 20261101_00

Tools

Slug: OKSIGN_BRIEFCASE_REMOVETool to remove a previously created briefcase from OKSign platform. Use when you need to delete a briefcase that is no longer needed. The briefcase is identified by the token received when it was created.

Input Parameters

string
required
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_BRIEFCASE_RETRIEVETool to retrieve a previously uploaded briefcase tokeninfo for consultation. Use when you need to examine bundled document properties and signer requirements without re-creating the briefcase.

Input Parameters

string
required
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_CONTACTS_REMOVETool to remove specified contacts from the account’s contact list. Use when you need to delete one or more contacts by providing their name and email.

Input Parameters

array
required
List of contact objects to remove. Each contact must have a name and email field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_CONTACTS_RETRIEVETool to retrieve the list of contacts stored in the account. Use when you need to access all contacts with their details including name, email, mobile number, and role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_CONTACTS_UPLOADInsert or update contacts in the account’s contact list. Contacts are identified by the combination of name and email; the upload can include mobile numbers.

Input Parameters

array
required
List of contact objects to insert or update in the account’s contact list. Each contact can have name, email, phone, mobile, address, company, and id fields (all optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_CREDITS_RETRIEVETool to retrieve account credit balance and storage information. Use when you need to check available credits or storage capacity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_DOCUMENT_EXISTSTool to check if a signed or unsigned document still exists on the OKSign platform. Use when you need to verify document availability before performing operations.

Input Parameters

string
required
The document ID to check if it exists on OKSign platform. Example: ‘670816-483B7F54-8591-DDF9-FA77-9042AED3E8FD’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_DOCUMENT_REMOVERemove a signed or unsigned document from OKSign by its document ID. Removal immediately after signing may fail while notifications are still processing, with a message to retry later.

Input Parameters

string
required
The document identifier received from Document.upload. This is the unique identifier for the document to be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_DOCUMENT_UPLOADTool to upload a PDF or Word document to OKSign platform for completion and/or signing. Use when you need to add a new document that requires signatures. Maximum file size is 10 MB. Supported formats: PDF, DOC, DOCX.

Input Parameters

object
required
Document file to upload (PDF or Word).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_EDITOREXPRESS_CREATETool to invoke the OKSign Editor Express for modifying documents and form descriptors. Use when you need to open documents in an interactive editor where users can add signature fields, form fields, and configure signing workflows. The editor URL returned can be embedded or redirected to within your application.

Input Parameters

array
required
Array of document IDs to load in the editor for modification. Each ID should be a valid OKSign document identifier.
boolean
Show current user as a signer option in the editor. Set to true to include yourself as a signer.
boolean
Display team members in the editor interface. Set to true to show team members as options.
boolean
Display signing method options in the editor. Set to true to show available signing methods.
boolean
Display anonymous signers as options in the editor. Set to true to enable anonymous signer selection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_FORMDESC_UPLOADUpload a form descriptor to a document, defining form fields, signature areas, signer information, and optional email or SMS notifications.

Input Parameters

URL of logo displayed during signing
string
required
Document ID from Document.upload service (passed in x-oksign-docid header)
array
required
Array of field objects defining form inputs and signature fields
string
Email of assigned user in account
string
Document filename (supports non-ASCII characters)
boolean
required
Whether multiple copies of this document can be signed
array
required
Array of signer information objects
boolean
Send signed document only to account’s email
object
Email and SMS notification configuration.
string
Alternative email for signed document

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_GET_ACTIVE_DOCUMENTSTool to retrieve all active document IDs and properties from OKsign account. Use when you need to list documents visible in the Active Documents tab. Note: Rate limited to 1 request per 3 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_LINKED_LIST_RETRIEVETool to retrieve the list of linked signed or source document IDs related to a specific document. Use when you need to find linked documents (either the signed version of a source document, or the source of a signed document).

Input Parameters

string
required
The document ID to retrieve linked document IDs for (source or signed document). Example: ‘504054-8D73D624-8EC5-EA1C-B932-8ACB7EF25585’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_NOTIFICATIONS_UPLOADUpload email and/or SMS signing notifications for a document or briefcase. This removes any pending notifications for the referenced document or briefcase.

Input Parameters

array
List of signers receiving notifications; if omitted, all signers receive them.
object
required
Notification configurations containing smtp and/or sms properties. At least one must be provided.
string
required
Document or briefcase token from Document.upload or Briefcase.create. This will be sent as a header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_ORG_TOKEN_INFO_UPDATEUpdate the callback, webhook, and return URLs linked to the organizational token used for authorization. Supply all three values; an empty string clears an unneeded URL.

Input Parameters

string
Return URL to be linked to the organizational token. Users will be redirected to this URL after completing actions.
string
Webhook URL to be linked to the organizational token. This URL will receive webhook notifications.
string
Callback URL to be linked to the organizational token. This URL will be called when specific events occur.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_SIGNEXPRESS_REMOVETool to remove a previously uploaded SignExpress tokeninfo JSONObject from the OKSign platform. Use when you need to clean up or invalidate a SignExpress token that was created for sign button integration.

Input Parameters

string
required
Valid token received from SignExpress.create endpoint. Format: 123456-12345678-1234-1234-1234-123456789012

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OKSIGN_USERS_RETRIEVETool to retrieve the list of users associated with the OkSign account. Use when you need to get all users in an account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not