- Category: signatures
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 17
- Triggers: 0
- Slug:
OKSIGN - Version: 20261101_00
Tools
Remove Briefcase
Remove Briefcase
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
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to be removed.
Output
Retrieve Briefcase Information
Retrieve Briefcase Information
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
The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to retrieve.
Output
Remove Contacts
Remove Contacts
Retrieve Contacts
Retrieve Contacts
Upload Contacts
Upload Contacts
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
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
Retrieve Account Credits
Retrieve Account Credits
Check Document Exists
Check Document Exists
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
The document ID to check if it exists on OKSign platform. Example: ‘670816-483B7F54-8591-DDF9-FA77-9042AED3E8FD’
Output
Remove Document
Remove Document
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
The document identifier received from Document.upload. This is the unique identifier for the document to be removed.
Output
Upload Document
Upload Document
Create Editor Express Session
Create Editor Express Session
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 of document IDs to load in the editor for modification. Each ID should be a valid OKSign document identifier.
Show current user as a signer option in the editor. Set to true to include yourself as a signer.
Display anonymous signers as options in the editor. Set to true to enable anonymous signer selection.
Output
Upload Form Descriptor
Upload Form Descriptor
Get Active Documents
Get Active Documents
Retrieve Linked Document List
Retrieve Linked Document List
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
The document ID to retrieve linked document IDs for (source or signed document). Example: ‘504054-8D73D624-8EC5-EA1C-B932-8ACB7EF25585’
Output
Upload Notifications
Upload Notifications
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
Notification configurations containing smtp and/or sms properties. At least one must be provided.
Document or briefcase token from Document.upload or Briefcase.create. This will be sent as a header.
Output
Update Organization Token Info
Update Organization Token Info
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
Return URL to be linked to the organizational token. Users will be redirected to this URL after completing actions.
Webhook URL to be linked to the organizational token. This URL will receive webhook notifications.
Callback URL to be linked to the organizational token. This URL will be called when specific events occur.
Output
Remove SignExpress Token
Remove SignExpress Token
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
Valid token received from SignExpress.create endpoint. Format: 123456-12345678-1234-1234-1234-123456789012