Xodo Sign

With Xodo Sign modules in Boost.space Integrator, you can manage the documents and templates in your Xodo Sign account.

To use the Xodo Sign modules, you must have a Xodo Sign account. You can create an account at eversign.com.

Refer to the Xodo Sign API documentation for a list of available endpoints.

Connect Xodo Sign to Boost.space Integrator

To establish the connection, you must:

Obtain your API key in Xodo Sign.
Establish the connection in Boost.space Integrator.

Obtain your API key in Xodo Sign

To obtain your API key from your Xodo Sign account:

Log in to your Xodo Sign account.
Click on your business name in the top-left corner and select the Developer option from the menu.
In the API Usage & Access section, copy the API Access Key value shown.

You will use this value in the API Key field in Boost.space Integrator.

Establish the connection with Xodo Sign in Boost.space Integrator

To establish the connection in Boost.space Integrator:

Log in to your Boost.space Integrator account, add a Xodo Sign module to your scenario, and click Create a connection.
Optional: In the Connection name field, enter a name for the connection.
In the API Key field, enter the API key copied above.
Click Save.
If prompted, authenticate your account and confirm access.

You have successfully established the connection. You can now edit your scenario and add more Xodo Sign modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.

Documents

Watch New Documents

Retrieves document details when a document requires your action, is waiting for others, is completed, cancelled or draft has been created.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to monitor documents for.
Type	Select the document’s status to filter your results by.
Limit	Set the maximum number of documents Boost.space Integrator will return during one execution cycle.

List Documents

Retrieves a list of documents in your account.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to retrieve documents for.
Type	Select the document’s status to filter your results by.
Limit	Set the maximum number of documents Boost.space Integrator will return during one execution cycle.

Get a Document

Retrieves document details.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to retrieve the document for.
Document ID	Enter (map) the ID of the document you want to retrieve details about.

Download a Final Document

Downloads a final PDF version of a document.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to download the documents for.
Document ID	Enter (map) the ID of the document you want to download.

Download an Original Document

Downloads an original PDF version of a document.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to download the document for.
Document ID	Enter (map) the ID of the document you want to download.

Create a Document

Creates a new document.

Connection

Establish a connection to your eversign account.

Business

Select the business you want to create the document for.

Title

Enter a document title.

Message

Enter a document message.

Files

Add the document files you want to upload or add (existing file) to the document.

File name

Enter the name for the file you want to upload.

Specify file by

Select how you want to provide the file.

File ID

Enter the ID of the file that has been already uploaded to your eversign account.

File URL

Enter the URL of the file you want to upload.

File upload

Map the file data from the previous module or enter the data manually.

Fields

Specify the fields that should be placed on the document.

(reference: https://eversign.com/api/documentation/methods#create-document)

Name	Description
type	The type of field to be placed. You can view a list of all available field types by clicking here.
x	The field’s horizontal margin from the left side of the document in pixels.
y	The field’s vertical margin from the top of the document in pixels.
width	The field’s width in pixels.
height	The field’s height in pixels.
page	The number of the document page where the field should be placed.
signer	The unique ID of the signer this field should be assigned to. If this field should become a No Signer field, please set this parameter to `OWNER`.
name	The field’s field label.
identifier	The field’s field identifier.
required	Set to `1` in order to make this field a required field.
readonly	Set to `1` in order to make this field a read-only field.
validation_type	Enable field validation for this field. Available validation types are `email_address`, `letters_only` and `numbers_only`.
text_style	The letters `B` for bold, `U` for underlined and `I` for italic, in the order of your choice. Example: `BUI`
text_font	Set the font identifier to your preferred font, e.g. `arial`. Jump to section field style to learn about supported fonts.
text_size	Set to your preferred font size number (string or integer), e.g. `16`.
text_color	Set to your preferred HEX color code, e.g. `#FF0000`
value	Set to `1` to mark `checkbox` or `radio` fields checked; or specify text content for `note` or `text` fields. For `dropdown` fields, set this parameter to an option value in order to pre-select it.
options	This parameter must contain a simple JSON array containing all available options of a `dropdown` field. In order to pre-select an option, simply set the `value` parameter to the option value.
group	This parameter is used to identify radio button groups. `radio` fields belonging to the same group must carry the same group parameter. Please note that this parameter must be numeric.

Signers

Add signers of the document.

(reference: https://eversign.com/api/documentation/methods#create-document)

Name	Description
Name	This parameter is used to specify the full name of the current signer.
Email	This parameter is used to specify the email address of the current signer.
Signer ID	A unique identification number (integer) for this signer. We recommend numbering your signers from 1 to X.
Order	If the `use_signer_order` parameter is set to `1`, set this parameter to the signer order number of the current signer.
PIN	This parameter is used to specify a signer PIN for the current signer.
Message	This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overridden by this parameter.
Deliver email	This parameter is only applicable if `embedded_signing_enabled` is set to `1`. By default, signers of embedded documents are not notified (default: `deliver_email: 0`) about a new document to be signed. Set `deliver_email` to `1` to send a notification email to this signer anyway.
Language	This parameter is used to specify the language in which signing notifications (emails), the document status page and the signature process will appear for this signer.

Cancel a Document

Cancels a document.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to cancel the document for.
Document ID	Enter (map) the ID of the document you want to cancel.

Delete a Document

Deletes a document.

Only cancelled documents and draft documents or templates can be deleted.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to delete the document for.
Document ID	Enter (map) the ID of the document you want to delete.

Templates

Watch New Templates

Retrieves template details when a template in the specified status is created.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to monitor templates for.
Type	Select the template’s status to filter your results by.
Limit	Set the maximum number of templates Boost.space Integrator will return during one execution cycle.

List Templates

Retrieves a list of documents in your account.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to retrieve documents for.
Type	Select the document’s status to filter your results by.
Limit	Set the maximum number of templates Boost.space Integrator will return during one execution cycle.

Get a Template

Retrieves template details.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to retrieve the document for.
Document ID	Enter (map) the ID of the template you want to retrieve details about.

Create a Template

Creates a template.

Connection

Establish a connection to your eversign account.

Business

Select the business you want to create the document for.

Title

Enter a document title.

Message

Enter a document message.

Files

Add the document files you want to upload or add (existing file) to the document.

File name

Enter the name for the file you want to upload.

Specify file by

Select how you want to provide the file.

File ID

Enter the ID of the file that has been already uploaded to your eversign account.

File URL

Enter the URL of the file you want to upload.

File upload

Map the file data from the previous module or enter the data manually.

Fields

Specify the fields that should be placed on the document.

(reference: https://eversign.com/api/documentation/methods#create-document)

Name	Description
type	The type of field to be placed. You can view a list of all available field types by clicking here.
x	The field’s horizontal margin from the left side of the document in pixels.
y	The field’s vertical margin from the top of the document in pixels.
width	The field’s width in pixels.
height	The field’s height in pixels.
page	The number of the document page where the field should be placed.
signer	The unique ID of the signer this field should be assigned to. If this field should become a No Signer field, please set this parameter to `OWNER`.
name	The field’s field label.
identifier	The field’s field identifier.
required	Set to `1` in order to make this field a required field.
readonly	Set to `1` in order to make this field a read-only field.
validation_type	Enable field validation for this field. Available validation types are `email_address`, `letters_only` and `numbers_only`.
text_style	The letters `B` for bold, `U` for underlined and `I` for italic, in an order of your choice. Example: `BUI`
text_font	Set the font identifier to your preferred font, e.g. `arial`. Jump to section field style to learn about supported fonts.
text_size	Set to your preferred font size number (string or integer), e.g. `16`.
text_color	Set to your preferred HEX color code, e.g. `#FF0000`
value	Set to `1` to mark `checkbox` or `radio` fields checked; or specify text content for `note` or `text` fields. For `dropdown` fields, set this parameter to an option value in order to pre-select it.
options	This parameter must contain a simple JSON array containing all available options of a `dropdown` field. In order to pre-select an option, simply set the `value` parameter to the option value.
group	This parameter is used to identify radio button groups. `radio` fields belonging to the same group must carry the same group parameter. Please note that this parameter must be numeric.

File name

Enter the name for the file you want to upload.

Specify file by

Select how you want to provide the file.

File ID

Enter the ID of the file that has been already uploaded to your eversign account.

File URL

Enter the URL of the file you want to upload.

File upload

Map the file data from the previous module or enter the data manually.

Fields

Specify the fields that should be placed on the document.

(reference: https://eversign.com/api/documentation/methods#create-document)

Name	Description
type	The type of field to be placed. You can view a list of all available field types by clicking here.
x	The field’s horizontal margin from the left side of the document in pixels.
y	The field’s vertical margin from the top of the document in pixels.
width	The field’s width in pixels.
height	The field’s height in pixels.
page	The number of the document page where the field should be placed.
signer	The unique ID of the signer this field should be assigned to. If this field should become a No Signer field, please set this parameter to `OWNER`.
name	The field’s field label.
identifier	The field’s field identifier.
required	Set to `1` in order to make this field a required field.
readonly	Set to `1` in order to make this field a read-only field.
validation_type	Enable field validation for this field. Available validation types are `email_address`, `letters_only` and `numbers_only`.
text_style	The letters `B` for bold, `U` for underlined and `I` for italic, in an order of your choice. Example: `BUI`
text_font	Set the font identifier to your preferred font, e.g. `arial`. Jump to section field style to learn about supported fonts.
text_size	Set to your preferred font size number (string or integer), e.g. `16`.
text_color	Set to your preferred HEX color code, e.g. `#FF0000`
value	Set to `1` to mark `checkbox` or `radio` fields checked; or specify text content for `note` or `text` fields. For `dropdown` fields, set this parameter to an option value in order to pre-select it.
options	This parameter must contain a simple JSON array containing all available options of a `dropdown` field. In order to pre-select an option, simply set the `value` parameter to the option value.
group	This parameter is used to identify radio button groups. `radio` fields belonging to the same group must carry the same group parameter. Please note that this parameter must be numeric.

Signers

Add signers of the document.

(reference: https://eversign.com/api/documentation/methods#create-document)

Name	Description
Role	This parameter is used to specify a name for this signer role (e.g. “Client”).
Required	If the `required` parameter is enabled, this signer role will require a name and email address that the template is used.
Signer ID	A unique identification number (integer) for this signer. We recommend numbering your signers from 1 to X.
Name	This parameter is used to pre-fill a full name for this signer role.
Email	This parameter is used to pre-fill an email address for this signer role.
Order	If the `use_signer_order` parameter is set to `1`, set this parameter to the signer order number of the current signer role.
PIN	This parameter is used to specify a signer PIN for the current signer.
Message	This parameter can be used to specify a custom message (upon document delivery) for the current signer role. Please note that for the current signer role the general template message will be overridden by this parameter.
Language	This parameter is used to pre-fill the language in which signing notifications (emails), the document status page, and the signature process will appear for this signer role.

Use a Template

Creates a document using a selected template.

Connection

Establish a connection to your eversign account.

Business

Select the business you want to create a document template for.

Template

Select the template you want to use for the new document.

Signers

Add signers for the new document.

Name	Description
Role	Select the name of this signing role.
Name	This parameter is used to specify the full name of the current signer.
Email	This parameter is used to specify the email address of the current signer.
PIN	This parameter is used to specify a signer PIN for the current signer.
Message	This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overridden by this parameter.
Deliver email	This parameter is only applicable if `embedded_signing_enabled` is set to `1`. By default, signers of embedded documents are not notified (default: `deliver_email: 0`) about a new document to be signed. Set `deliver_email` to `1` to send a notification email for this role anyway.
Language	This parameter is used to specify the language in which signing notification emails, the document status page and the signature process will appear for this signer. Click here for a list of supported languages.

Fields

Specify the fields for the document.

Name	Description
Identifier	The field’s field identifier.
Value	Enter the field’s value. click here to see a list of allowed field values per field.

Title

Enter a document title.

Message

Enter a document message.

Other

List Businesses

Retrieves existing businesses in your eversign account.

Connection	Establish a connection to your eversign account.
Limit	Set the maximum number of businesses Boost.space Integrator will return during one execution cycle.

Upload a File

Uploads a file to your account.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to upload a file for.
Source File	Map the file you want to upload from the previous module (e.g. HTTP > Get a File or Google Drive > Download a File), or enter the file name and file data manually.

Send a Reminder

Sends a reminder to an individual signer.

Connection	Establish a connection to your eversign account.
Business	Select the business you want to retrieve the document for.
Document ID	Enter (map) the ID of the template you want to retrieve details about.
Signer ID	Enter the ID of the signer you want to send a reminder to.

Make an API Call

Allows you to perform a custom API call.

Connection	Establish a connection to your eversign account.
URL	Enter a path relative to `https://api.eversign.com/api/`. For example `/business` For the list of available endpoints, refer to the eversign Developer Documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POSTto 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.

Example of Use – List Documents

The following API call returns the first 10 documents of all types for the specified business in your eversign account:

URL: /document

Method: GET

Query String: Key: type Value: all

Key: business_id Value: {{the ID of the business you want to retrieve documents for}}

Key: limit Value: 10

The result can be found in the module’s Output under Bundle > Body. In our example, 10 documents were returned: