Signi

The Signi modules allow you to create, update, send, retrieve, list, and delete the contracts in your Signi account.

Getting Started with Signi

Prerequisites

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting Signi to Make

  1. Log in to your Signi account.

  2. Select the workspace for which you want to establish the account and ensure the option Use the API is checked. You can check by navigating to Set Up Workspace > Advanced Settings.

    61f279dfee7f6.gif

    Please Note: You must purchase the API access by writing to sales@signi.com providing the details of the workspace for which you want to enable the API access.

  3. Go to Signi API Page. Enter your account password. In the Key API section, under the workspace for which you want to establish the connection, click Show the API key(s) for 120 seconds.

    61f279e67b1e4.gif
  4. Copy the API key to your clipboard.

    61f279ea8923d.png
  5. Go to Make and open the Signi module's Create a connection dialog.

    61f279ec1d66a.gif
  6. In the Connection name field, enter a name for the connection.

  7. In the API Key field, enter the API key copied in step 4, and click Continue.

The connection has been established.

Actions

Returns details about a contract specified by ID.

Connection

Establish a connection to your Signi account.

Contract ID

Select or map the Contract ID whose details you want to retrieve.

With

Select or map the fields whose details you want to view in the contract information. For example, files.

Deletes a contract specified by ID.

Connection

Establish a connection to your Signi account.

Contract ID

Select or map the Contract ID you want to delete.

Delete Completely including all attachments

Select the checkbox you want to delete all the attachments associated with the contract.

Retrieves a PDF of a contract specified by ID.

Connection

Establish a connection to your Signi account.

Contract ID

Select or map the Contract ID which you want to download as PDF.

Retrieves a PDF with the contract history.

Connection

Establish a connection to your Signi account.

Contract ID

Select or map the Contract ID whose revision history changes you want to retrieve.

Creates a (partly) filled template and returns an HTML preview of the contract.

Connection

Establish a connection to your Signi account.

Template ID

Select or map the Template ID to apply for the contract preview that you want to create.

Parameters

Add the parameter IDs and their values for the contract.You can get a list of the template's parameters and their values using the List Templates module.

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Signi account.

URL

Enter a path relative to https://api.signi.com/api For example: /v1/me

For the list of available endpoints, refer to the Signi API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all the account information from your Signi account:

URL:

/v1/me

Method:

GET

61f279eea12ef.png

Matches of the search can be found in the module's Output under Bundle > Body.

In our example, the current user information is returned:

61f279efeb49c.png

Creates a contract from a template with optional attachments.

Connection

Establish a connection to your Signi account.

Contract Number

Enter (map) the contract number.

Save as Draft

Select the checkbox if you want to save this contract as a draft.

Locale

Select or map the language for the contract. For example, EN for English.

People

Add the people to the contract:

Is Proposer

Select the checkbox if the person is a proposer.

Party order for Signature

Enter (map) a counterparty number for signature. By default, the value is 1.

Email Address

Enter (map) the email address of the person.

Contract Role

Select or map the contract role:

  • Sign

  • Approve

Signature Positions

Add the signature positions:

Page Number

Enter(map) the page number where you want to place the signature position.

X Coordinate

Enter (map) the signature position given in the percentage of the document page width, <0, 100>.

Y Coordinate

Enter (map) the signature position given in the percentage of the document page length, <0, 100>.

Phone Number

Enter (map) the person's phone number.

First Name

Enter (map) the person's first name.

Last Name

Enter (map) the person's last name.

Person Type

Select or map the person type:

  • Citizen

  • Legal

  • Nature

Date of Birth

Enter (map) the person's date of birth in DD/MM/YYYY format.

Street

Enter (map) the person's residence street name.

City

Enter (map) the person's residence city name.

Zip Code

Enter (map) the person's residence area zip code.

Identification Number

Enter (map) the person's identification number.

Tax Registration Number

Enter (map) the person's tax registration number.

Company Name

Enter (map) the person's company name with which he is associated.

ID

Select or map the Template ID you want to apply to the contract.

Parameters

Add the parameters IDs and their value that you want to add to the contract.

Webhooks

Add the webhooks:

State

Select or map the status of the webhook:

  • Completed

  • Expired

  • Rejected

URL

Enter (map) the webhook's URL address.

Attachments

Add the attachments related to the contract:

People

Add the people related to the attachment:

Email

Enter (map) the email address of the person.

Contract_role

Enter (map) the person's role in the contract.

Positions

Add the x, y, and page coordinates to add the people in the contract.

ID

Enter (map) the Template ID to apply for the attachment.

Parameters

Add the IDs and their values for the contract.

Signing Order

Select or map the signing order option for the contract:

  • Proposers before counterparties

  • All at once

  • At a time

Auto sign Proposers

Entertrue for the auto sign, otherwise, enter a location.

Missing Positions

Select or map an option to handle persons without signature positions.

Creates a contract from a document with optional attachments.

Connection

Establish a connection to your Signi account.

Contract

Enter the contract details:

Filename

Enter (map) the contract file name with extension.

Data

Enter (map) the file data.

Signing Order

Select or map the signing order option for the contract:

  • Proposers before counterparties

  • All at once

  • At a time

People

Add the people related to the attachment:

Email

Enter (map) the email address of the person.

Contract_role

Enter (map) the person's role in the contract.

Positions

Add the x, y, and page coordinates to add the people in the contract.

Webhooks

Add the webhooks:

State

Select or map the status of the webhook:

  • Completed

  • Expired

  • Rejected

URL

Enter (map) the webhook's URL address.

Attachments

Add the attachments related to the contract:

Filename

Enter (map) the attachment filename with extension.

Data

Enter (map) the file data.

People

Add the people related to the attachment:

Email Address

Enter (map) the email address of the person.

Is Proposer

Enter (map) the person's role in the contract.

Contract Role

Select or map the contractor role in the attachment:

  • Sign

  • Approve

Signature Position

Add the x, y, and page coordinates to add the person's signature location in the contract.

Searches

Retrieves a list of all contracts for the account or a specified counterparty.

Connection

Establish a connection to your Signi account.

Select which results to return

Select or map the option to list the contract results:

  • Lists all contracts from my account

  • Lists all contracts for a specific counterparty

Counterparty Email

Enter (map) the email address of the counterparty whose contracts you want to list.

Filter result by state

Select or map the contract status you want to list:

  • Draft

  • Expired

  • Pending

  • Rejected

  • Deleted

  • Completed

Number of results to return

Set the maximum number of contracts Make should return during one execution cycle.

Retrieves a list of templates to complete the data and signature.

Connection

Establish a connection to your Signi account.

Number of results to return

Set the maximum number of templates Make should return during one execution cycle.