# Oksign

Sign online contracts, purchase orders, forms, you name it. Simple and legal.

- **Category:** signatures
- **Auth:** API_KEY
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `OKSIGN`
- **Version:** 00000000_00

## Tools

### Remove Briefcase

**Slug:** `OKSIGN_BRIEFCASE_REMOVE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `docid` | string | Yes | The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Briefcase Information

**Slug:** `OKSIGN_BRIEFCASE_RETRIEVE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `docid` | string | Yes | The briefcase token received when creating a briefcase via the Briefcase.create service. This uniquely identifies the briefcase to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Contacts

**Slug:** `OKSIGN_CONTACTS_REMOVE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | List of contact objects to remove. Each contact must have a name and email field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Contacts

**Slug:** `OKSIGN_CONTACTS_RETRIEVE`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Contacts

**Slug:** `OKSIGN_CONTACTS_UPLOAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Account Credits

**Slug:** `OKSIGN_CREDITS_RETRIEVE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Document Exists

**Slug:** `OKSIGN_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc_id` | string | Yes | The document ID to check if it exists on OKSign platform. Example: '670816-483B7F54-8591-DDF9-FA77-9042AED3E8FD' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Document

**Slug:** `OKSIGN_DOCUMENT_REMOVE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc_id` | string | Yes | The document identifier received from Document.upload. This is the unique identifier for the document to be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Document

**Slug:** `OKSIGN_DOCUMENT_UPLOAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document` | object | Yes | Document file to upload (PDF or Word). FileUploadable object where 'name' is the filename to use in OKSign, e.g., 'contract.pdf' or 'agreement.docx'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Editor Express Session

**Slug:** `OKSIGN_EDITOREXPRESS_CREATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list` | array | Yes | Array of document IDs to load in the editor for modification. Each ID should be a valid OKSign document identifier. |
| `show_me_signer` | boolean | No | Show current user as a signer option in the editor. Set to true to include yourself as a signer. |
| `show_teammembers` | boolean | No | Display team members in the editor interface. Set to true to show team members as options. |
| `show_signing_options` | boolean | No | Display signing method options in the editor. Set to true to show available signing methods. |
| `show_anonymous_signers` | boolean | No | Display anonymous signers as options in the editor. Set to true to enable anonymous signer selection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Form Descriptor

**Slug:** `OKSIGN_FORMDESC_UPLOAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `logo` | string | No | URL of logo displayed during signing |
| `docid` | string | Yes | Document ID from Document.upload service (passed in x-oksign-docid header) |
| `fields` | array | Yes | Array of field objects defining form inputs and signature fields |
| `assignto` | string | No | Email of assigned user in account |
| `filename` | string | No | Document filename (supports non-ASCII characters) |
| `reusable` | boolean | Yes | Whether multiple copies of this document can be signed |
| `signersinfo` | array | Yes | Array of signer information objects |
| `sendtomeonly` | boolean | No | Send signed document only to account's email |
| `notifications` | object | No | Email and SMS notification configuration. |
| `sendtomeemail` | string | No | Alternative email for signed document |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Active Documents

**Slug:** `OKSIGN_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Linked Document List

**Slug:** `OKSIGN_LINKED_LIST_RETRIEVE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `doc_id` | string | Yes | The document ID to retrieve linked document IDs for (source or signed document). Example: '504054-8D73D624-8EC5-EA1C-B932-8ACB7EF25585' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Notifications

**Slug:** `OKSIGN_NOTIFICATIONS_UPLOAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signersinfo` | array | No | List of signers receiving notifications; if omitted, all signers receive them. |
| `notifications` | object | Yes | Notification configurations containing smtp and/or sms properties. At least one must be provided. |
| `x-oksign-docid` | string | Yes | Document or briefcase token from Document.upload or Briefcase.create. This will be sent as a header. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Organization Token Info

**Slug:** `OKSIGN_ORG_TOKEN_INFO_UPDATE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `returnurl` | string | No | Return URL to be linked to the organizational token. Users will be redirected to this URL after completing actions. |
| `webhookurl` | string | No | Webhook URL to be linked to the organizational token. This URL will receive webhook notifications. |
| `callbackurl` | string | No | Callback URL to be linked to the organizational token. This URL will be called when specific events occur. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove SignExpress Token

**Slug:** `OKSIGN_SIGNEXPRESS_REMOVE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x-oksign-token` | string | Yes | Valid token received from SignExpress.create endpoint. Format: 123456-12345678-1234-1234-1234-123456789012 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Users

**Slug:** `OKSIGN_USERS_RETRIEVE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
