Oksign

These are the Oksign actions available to the apps you build with Snow. Connecting an account does not make Snow run these on its own.

• Check Document Exists

  Tool 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.

• Create Editor Express Session

  Tool 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.

• Get Active Documents

  Tool 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.

• Remove Briefcase

  Tool 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.

• Remove Contacts

  Tool 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.

• Remove Document

  Tool to remove a signed or unsigned document from the OKSign platform. Use when you need to delete a document and its signed copies from storage. Note: If document is removed immediately after signing while platform processes notifications, service may return FAILED status with retry message.

• Retrieve Account Credits

  Tool to retrieve account credit balance and storage information. Use when you need to check available credits or storage capacity.

• Retrieve Briefcase Information

  Tool 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.

• Retrieve Contacts

  Tool 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.

• Retrieve Users

  Tool to retrieve the list of users associated with the OkSign account. Use when you need to get all users in an account.

• Upload Contacts

  Tool to insert or update contact information in the account's contact list. Use when you need to add new contacts or update existing ones with details like name, email, phone, mobile, address, company, or identifier.

• Upload Document

  Tool 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.

• Upload Form Descriptor

  Tool to upload form descriptor defining signature fields and other field types to a document. Use when you need to add form fields, signature areas, and configure signing workflows for a document.

• Upload Notifications

  Tool to upload notifications defining email(s) and/or SMS(es) to be sent to signer(s) with signing links. Use when you need to send notification emails or SMS messages to document signers.

• Remove SignExpress Token

  Tool 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.

• Retrieve Linked Document List

  Tool 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).

• Update Organization Token Info

  Tool to update organizational token information and settings for the account. Use when you need to configure or modify callback URL, webhook URL, or return URL for the organization's token.