Oodrive Sign (Preview)

Reference

Connect and consume Oodrive sign's service through your workflows.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Oodrive Sign
URL	https://www.oodrive.com/products/oodrive-sign/
Email	support-sign@oodrive.com

Connector Metadata
Publisher	Oodrive Sign
Website	https://www.oodrive.com/products/oodrive-sign/
Privacy policy	https://www.oodrive.com/privacy-policy/
Categories	IT Operations;Productivity

Oodrive Sign's connector allows you to automate task and easily manage your processes about the electronic signature ecosystem. Automated workflow can be design to, for example, create new contract by a template, add recipients automatically and send the contract for signature. You can also manage all your bundles, recipients, key parameters and more. It offers to the customers the possibility to reduce time used to make manual actions after all the process of signature. All the feature available in the web application can be reproduce in Power Automate using the connector.

Prerequisites

You need an account with a paid plan on Oodrive Sign's service.

How to get credentials

You also need to get your API token, that can be ask to the support service or it can be retrieved in your welcoming e-mail which has been sent to your mailbox when you applied to Sign's service.

Note: If you are a employee, you can get the token by contacting your IT service.

Get started with your connector

To start using the connector, first you need to open Power Automate with your Power Platform account.

Note: you'll need to be premium on Power Automate in order to use the connector.

Follow this steps to create a new workflow and use our connector:

In your Power Automate environment, click on the "create" tab.
Choose "Automated cloud Flow" or "Instant cloud flow", as you need.
Give a name to your new workflow, and select a trigger that fit your needs. You can use one of Oodrive Sign's.
Start using the connector by adding an action from it, simply by searching for "Oodrive Sign" in the catalog.
The first time that you add an action or a trigger from our connector, Power Automate will ask you to connect to your environment : this is there that you'll use the API Token provided by us.
Then, click on connect : everything is done, you can use as many actions from the connector that you want.

Known issues and limitations

For issues with Oodrive Sign, please contact the support service.

Common errors and remedies

HTTP ERROR 404

Generally, when you receive an error 404 with Oodrive Sign's, it says you that the ressource you're trying to find doesn't exist on your environment. Typically, it can be an error in the ID provided for a specific contract or a specific recipient, that doesn't exist. To resolve the issue, try to use your action with a known ID of the ressource you're trying to get.

HTTP ERROR 501

The HTTP error 501 indicates that Oodrive Sign's service didn't recognize well your demand, or that you passed a wrong type of data to the service. Try to investigate, by reading Sign's documentation, on the data you pass to your action or trigger.

FAQ

1. How can I upload a document to a specific contract ?

Using the action "Upload a document and attach it to a contract", you can easily upload a pdf file that is remotely saved.

The first step requires to get the content of the file that you want to upload. You can get it by using many connectors. For example, file content can be retrieved by using "Get file content" action of the SharePoint connector.

Get the content of the file that you want to upload as document for a specific contract. In this example, we use the action "Get file content" of the SharePoint Online connector.
Then, add a new "compose" action. Use the output body of the action "Get file content" as input for the compose one.
Add the action called "Upload a document and add it to a contract" from the Oodrive Sign connector.
- In the input "Contract ID", specify the ID of the contract for which you want your document to be attached.
- In the input "Files", insert the output of the previous "Compose" action
- In the input "Files (file name)", insert a name for the document that will be uploaded.
You're done uploading the document !

2. Can I see all the contracts inside my environment ?

If your token is an "administrator" token, yes. Otherwise, you'll only view contract that you've access normally.

3. I have a suggestion for the connector. Where can I submit it ?

You can submit any suggestions about the connector by contacting the support service. We will be really thankful to your contribution !

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add a contract to a bundle	Add an existing contract to an existing Bundle.
Add a recipient to a contract	Attach an existing recipient to the contract.
Create a Bundle	Create a new Bundle with at least one existing contract.
Create a contract	Create a new contract in the environment.
Create contract and send it for signature	All in one operation. Create contract, add recipients, documents, and send it for signature to recipients.
Delete a recipient for contract	Delete a recipient from a contract, by his recipient for contract ID. More information in the documentation.
Download a contract's proof file	Download the proof file of the contract.
Download a contract's signed document	Retrieve a pdf file from the contract's signed document.
Download the contract's documents	Retrieve a PDF file that contains all the documents from a contract.
Get a contract's status	Check a specific contract's status.
Get a list of all contracts	Retrieve all contracts from the associated license.
Get a specific contract	Retrieve metadata of a specific contract.
Get a specific recipient	Retrieve a specific recipient in the saved list of recipients of the current environment.
Get signatures of a contract	List all the signatures informations from a specific contract.
List a bundle's contracts	Retrieve all contracts from a specific bundle.
List a contract's recipients	Retrieve all recipients for a specific contract.
List all perimeters	Retrieve all perimeters associated to the connected environment.
List all recipients	Retrieve all the recipients associated to the current license.
List contract's documents	Retrieve all documents bound to a contract.
Resend notification email to a recipient	Send a notification email to a specific recipient for contract.
Resend the notification email to all recipients	Send a notification email to all the recipients of a specific contract.
Send a bundle for signature	Send a bundle for signature.
Send a contract to be signed	Send a specific contract and all his documents to be signed by recipients.
Stop a bundle transaction	Stop a bundle transaction.
Stop a contract's transaction	Stop the contract's transaction so you can modify contract documents and/or signatories.
Upload a document and attach it to a contract	Upload a document to the environment and attach it to a specific contract.
Upload an attachment and add it to a contract	Upload a new attachment to the environment and attach it to a specific contract.
Validate a contract	Validate (countersign) a contract.
Validate contracts in a bundle	Counter-sign (validate) all contract in a bundle.
Withdraw a bundle	Withdraw all contract in a bundle.
Withdraw a contract	Set the status of the contract to ABANDONED, even if the contract was sent for signature.

Add a contract to a bundle

Operation ID:: AddContractToBundle

Add an existing contract to an existing Bundle.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the Bundle to add contract.
Contract ID	contract_id		integer	ID of the contract to add to the bundle.

Returns

Body: BundleResponse

Add a recipient to a contract

Operation ID:: AddRecipientToContract

Attach an existing recipient to the contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to attach recipient.
Recipient ID	recipient_id		integer	ID of the recipient to attach to the contract.
Signature mode	signature_mode		integer	Mode of signature. See documentation for further informations.
Message title	message_title		string	Title of the message to send by e-mail if there will be one.
Message content	message_body		string	Body of the message to send by e-mail if there will be one.
Rank	rank		integer	Place of the recipient in the signature process. Rank and Smartrole are mutually exclusive. Choose only one of them or not at all.
Smart role name	smartrole		string	Smart role to give to the recipient. See documentation for further informations.
Transport mode	transport_mode		integer	Transport mode of the signature. See documentation for further informations.

Returns

response: array of ContractRecipient

Create a Bundle

Operation ID:: CreateNewBundle

Create a new Bundle with at least one existing contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	contract_id		integer	The bundle first contract's ID.
Same signatories	same_signatories		boolean	Set to false if contracts in the bundle do not have the same set of signatories.

Returns

Body: BundleResponse

Create a contract

Operation ID:: CreateNewContract

Create a new contract in the environment.

Parameters

Name	Key	Type	Description
Name of the contract	name	string	Name of the newly created contract (Required).
Contract Definition ID	contract_definition_id	integer	ID of the contract definition. Refer to your licence's API variable. Default to PDF AdHoc template.
Vendor email	vendor_email	string	Email of the licence owner.
Date of creation	date	integer	Date of the contract. Default to Date.Now(). Must be in milliseconds.
Message title	message_title	string	Object of the email sent. Leave empty for a default title.
Message body	message_body	string	Body of the email sent. Leave empty for a default message.
Keep on move	keep_on_move	boolean	Activate or not off-line signature on mobile device
Auto close	auto_close	integer	Specify if countersignature is performed without human intervention.
Sequential	sequential	boolean	Specify if sequential or not.
Customer number	customer_number	string	For legacy mobile applications compatibility only.
List of perimeter	perimeters	array of string
Element definition ID	element_definition_id	integer	Definition ID of the element.
Value	value	string	Value of the element option.
Property ID	id	integer	ID of the custom property.
Property Key	key	string	Key of the custom property.
Property Placeholder	placeholder	string	Label shown to the recipient when invited to fill in the property.
Property Value	value	string	Value of the custom property.
Property Contract ID	contract_id	integer	ID of the contract associated to this custom property.
Property Is Required	to_fill_by_user	boolean	Specify if user need to fill property or not.
Property Type	field_type	string	Specify the type of the custom property. More informations in the documentation.
Property Choices	input_filter	string	List of possible choice for the property.
Property Is Used By Contract	used_by_contract	boolean	Set to true if the information must appear on the contract document.
Property Is Required	required	boolean	Specify if property is required or not.

Returns

Body: Contract

Create contract and send it for signature

Operation ID:: AllInOneCreateContract

All in one operation. Create contract, add recipients, documents, and send it for signature to recipients.

Parameters

Name	Key	Required	Type	Description
Contract ID	contract_id		integer	The ID of the contract.
Creation Date	date		integer	Date at which the contract has been created.
Vendor E-mail Address	vendor_email		string	E-mail address of the Oodrive's license owner.
Contract Definition ID	contract_definition_id		integer	ID of the contract definition used for this contract.
Message Subject	message_title		string	E-mail subject when sent for signature.
Message Body	message_body		string	E-mail body when sent for signature.
Contract Name	name	True	string	Contract's main document name.
Offline Signature Activated	keep_on_move		boolean	Determine if the offline signature on mobile device is activated.
Contract Closed Date	closed_date		integer	Date of closure of the contract, if there are any.
Contract Canceled Reason	canceled_reason		string	Reason of the cancel, if there are any.
Auto-close Enabled	auto_close		integer	Specify if the contract will be countersigned automatically or need a human intervention.
Is Deleted	deleted		integer	Specify if the contract has been deleted or not.
Perimeter Key	Perimeters		string	Key of the perimeter.
Option ID	id		integer	ID of the contract's option.
Contract ID	contract_id		integer	ID of the contract bound to this option.
Element Definition ID	element_definition_id		integer	ID of the element definition of the option.
Sync Timer	sync_timer		integer	Timer that is used for synchronization issue.
Option Value	value		string	Value of the option.
Last modification place	last_modification_place		string	Indicates where the last modification took place.
Option Control	control		string	Control field.
Property ID	id		integer	ID of the custom property.
Property Key	key		string	Key of the custom property.
Property Placeholder	placeholder		string	Label shown to the recipient when invited to fill in the property.
Property Value	value		string	Value of the custom property.
Property Contract ID	contract_id		integer	ID of the contract associated to this custom property.
Property Is Required	to_fill_by_user		boolean	Specify if user need to fill property or not.
Property Type	field_type		string	Specify the type of the custom property. More informations in the documentation.
Property Choices	input_filter		string	List of possible choice for the property.
Property Is Used By Contract	used_by_contract		boolean	Set to true if the information must appear on the contract document.
Property Is Required	required		boolean	Specify if property is required or not.
Signature Mode	signature_mode		integer
firstname	firstname		string
lastname	lastname		string
email	email		string
cell_phone	cell_phone		string
pdfparts	pdfparts		string
appendixparts	appendixparts		string

Returns

Name	Path	Type	Description
recipients	recipients	array of Recipient
recipientForcontract	recipientForcontract	array of ContractRecipient
contract	contract	Contract
PDF	pdfparts	array of object	Array of PDF bound to the contract.
PDF ID	pdfparts.id	integer	ID of the PDF.
PDF Rank	pdfparts.rank	integer	Rank of the PDF.
Has SmartFields	pdfparts.has_smart_field	boolean	Specify if there is smart fields in the contract.
PDF Size	pdfparts.size	integer	Size of the document.
File name	pdfparts.filename	string	Name of the pdf.
appendixparts	appendixparts	array of object
id	appendixparts.id	integer

Delete a recipient for contract

Operation ID:: DeleteRecipientForContract

Delete a recipient from a contract, by his recipient for contract ID. More information in the documentation.

Parameters

Name	Key	Required	Type	Description
Recipient for contract ID	cfc_id	True	string	ID of the recipient for contract object to delete.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Specify if it was removed successfully.

Download a contract's proof file

Operation ID:: DownloadProofFileContract

Download the proof file of the contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to download the proof file.
Output file name	filename		string	Name of the file which will be downloaded.

Returns

response: file

Download a contract's signed document

Operation ID:: DownloadContractSignedDocument

Retrieve a pdf file from the contract's signed document.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	integer	ID of the contract which contains documents.
File name	filename		string	The name that you want to give to the downloaded document.

Returns

Binary content of the pdf file.

Document Binary: file

Download the contract's documents

Operation ID:: DownloadContractDocuments

Retrieve a PDF file that contains all the documents from a contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to retrieve the pdf file.
Output file name	filename		string	Name of the file which will be downloaded.

Returns

PDF Document Binary: file

Get a contract's status

Operation ID:: GetContractStatus

Check a specific contract's status.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	integer	ID of the contract to retrieve status.

Returns

Body: Transaction

Get a list of all contracts

Operation ID:: ListAllContracts

Retrieve all contracts from the associated license.

Parameters

Name	Key	Type	Description
Size of the returned array	size	integer	The maximum size of the returned array of contract.
Skip first n contracts	offset	integer	The sequence number of contract that will be skipped.
Show contract properties	get_properties	boolean	If true, contract properties will be listed in the response.
Show contract perimeters	get_perimeters	boolean	If true, contract perimeters will be listed in the response.
Created before	before	integer	Will list contract created before the given date.
Created after	after	integer	Will list contract created after the given date.
Only with perimeter	perimeter	string	List contracts only in a given perimeter.
Only with status	status	array	Retrieve contract only with specified status.

Returns

Items: ArrayOfContract

Get a specific contract

Operation ID:: GetSpecificContract

Retrieve metadata of a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	The contract ID to retrieve.

Returns

Body: Contract

Get a specific recipient

Operation ID:: GetRecipient

Retrieve a specific recipient in the saved list of recipients of the current environment.

Parameters

Name	Key	Required	Type	Description
Recipient ID	id	True	string	ID of the recipient to retrieve.

Returns

Body: Recipient

Get signatures of a contract

Operation ID:: ListSignatureStatus

List all the signatures informations from a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to list all signatures.

Returns

response: array of RecipientForContractWithRefusal

List a bundle's contracts

Operation ID:: ListBundleContracts

Retrieve all contracts from a specific bundle.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the bundle to retrieve contracts from.

Returns

response: array of ContractInBundle

List a contract's recipients

Operation ID:: ListContractRecipients

Retrieve all recipients for a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to retrieve all recipients.

Returns

response: array of ContractRecipient

List all perimeters

Operation ID:: ListAllPerimeters

Retrieve all perimeters associated to the connected environment.

Returns

response: array of Perimeter

List all recipients

Operation ID:: ListAllRecipients

Retrieve all the recipients associated to the current license.

Parameters

Name	Key	Type	Description
Size	size	integer	Maximum size of the returned array.
Offset	offset	integer	Sequence number of the first recipient listed.
Perimeter	perimeter	string	Search only in the given perimeter.
Get Custom Props	get_custom_props	boolean	List recipients custom properties (increases response time).
Get Perimeters	get_perimeters	boolean	List recipient's perimeters in the responses (increases response time).
Filter lastname (contains)	name	string	Filter on the lastname.
Filter email (contains)	email	string	Filter on the email.

Returns

Recipients: array of Recipient

List contract's documents

Operation ID:: ListContractDocuments

Retrieve all documents bound to a contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to retrieve documents.

Returns

response: array of DocumentAdded

Resend notification email to a recipient

Operation ID:: ResendNotificationRecipient

Send a notification email to a specific recipient for contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to resend notification.
Recipient for Contract ID	cfc_id	True	string	ID of the recipient for contract object to send a notification.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Specify if the notification was successfully resend.

Resend the notification email to all recipients

Operation ID:: ResendNotificationAllRecipients

Send a notification email to all the recipients of a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to resend notification.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Specify if the notification was successfully resend.

Send a bundle for signature

Operation ID:: SendBundleForSignature

Send a bundle for signature.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the bundle to send for signature.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Says if transaction has been sent or not.

Send a contract to be signed

Operation ID:: SendContractToBeSigned

Send a specific contract and all his documents to be signed by recipients.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to send for signature.

Returns

Body: Transaction

Stop a bundle transaction

Operation ID:: StopBundleTransaction

Stop a bundle transaction.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the Bundle to stop transaction.
Force close	force		boolean	Force transaction close, even if signatories have already signed.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Says bundle was successfully stopped.

Stop a contract's transaction

Operation ID:: StopContract

Stop the contract's transaction so you can modify contract documents and/or signatories.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to stop.
Force	force		boolean	Force transaction close even if signatories have already signed.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Specify if the contract has been cancelled.

Upload a document and attach it to a contract

Operation ID:: UploadDocumentAndAttachToContract

Upload a document to the environment and attach it to a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to attach a new document to.
File	file		file	File binary to upload.

Returns

response: array of DocumentAdded

Upload an attachment and add it to a contract

Operation ID:: UploadAttachmentAndAddToContract

Upload a new attachment to the environment and attach it to a specific contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to add an attachment.
Contract definition ID	contract_definition_id		integer	Contract definition ID defined in your environment. Default is pdfadhoc.
Option definition name	option_definition_name		string	Definition name.
Files	file		array	Files to add as attachments

Returns

Body: AppendixAdded

Validate a contract

Operation ID:: ValidateAContract

Validate (countersign) a contract.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to validate.
Force	force		boolean	Specify if the contract validation must be forced, even if some signatories have not signed yet.

Returns

Name	Path	Type	Description
Validation Date	date	string	Date of validation.
Transaction ID	id	string	The certification authority's transaction ID.

Validate contracts in a bundle

Operation ID:: ValidateContractsInBundle

Counter-sign (validate) all contract in a bundle.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the bundle to validate all contract.
Force validation	force		boolean	Force the contracts validation if some signatories have not signed yet (or have refused to sign).

Returns

Name	Path	Type	Description
		array of object
date	date	string	Date of close state.
Contract ID	id	string	ID of the contract stopped.

Withdraw a bundle

Operation ID:: WithdrawBundle

Withdraw all contract in a bundle.

Parameters

Name	Key	Required	Type	Description
Bundle ID	id	True	string	ID of the bundle to withdraw all contract.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Says if bundle was withdrawn.

Withdraw a contract

Operation ID:: WithdrawContract

Set the status of the contract to ABANDONED, even if the contract was sent for signature.

Parameters

Name	Key	Required	Type	Description
Contract ID	id	True	string	ID of the contract to withdraw.
Reason	reason		string	The reason of the withdraw.

Returns

Name	Path	Type	Description
succeed	succeed	boolean	Specify if the contract has been cancelled.

Triggers

When a contract's status change

This operation is triggered whenever a contract's status has changed.

When a contract's status change

Operation ID:: WhenContractStatusChanged

This operation is triggered whenever a contract's status has changed.

Parameters

Name	Key	Type	Description
description	description	string	description
events	events	array of string	events
contractDefinition	contractDefinition	array of integer	contractDefinition
perimeter	perimeter	array of integer	perimeter
concernedUserEmail	concernedUserEmail	string	concernedUserEmail

Returns

Name	Path	Type	Description
type	type	string	type
contractId	contractId	integer	contractId
timestamp	timestamp	integer	timestamp
contractStatus	contractStatus	string	contractStatus

Definitions

ArrayOfContract

Name	Path	Type	Description
Items		Contract

Contract

Name	Path	Type	Description
Contract ID	contract_id	integer	The ID of the contract.
Creation Date	date	integer	Date at which the contract has been created.
Document Token	document_token	string	Token of the contract's main document.
Vendor E-mail Address	vendor_email	string	E-mail address of the Oodrive's license owner.
Is Closed	closed	boolean	Specify if the contract is closed or not.
Contract Status	status	string	Contract's current status.
Contract Definition ID	contract_definition_id	integer	ID of the contract definition used for this contract.
Message Subject	message_title	string	E-mail subject when sent for signature.
Message Body	message_body	string	E-mail body when sent for signature.
Contract Name	name	string	Contract's main document name.
Offline Signature Activated	keep_on_move	boolean	Determine if the offline signature on mobile device is activated.
Contract Closed Date	closed_date	integer	Date of closure of the contract, if there are any.
Contract Canceled Reason	canceled_reason	string	Reason of the cancel, if there are any.
Contract Version Number	version_number	integer	Version number of the contract.
Contract Size	size	integer	Full size of the contract.
Auto-close Enabled	auto_close	integer	Specify if the contract will be countersigned automatically or need a human intervention.
Is Deleted	deleted	integer	Specify if the contract has been deleted or not.
Perimeters	perimeters	array of ContractPerimeterKey	List of all perimeters of the contract (if queried).
Options	options	array of ContractOption	List of all specific options of the contract (if queried).
Custom properties	contract_properties	array of ContractProperty	List of all optional contract properties (if queried).

ContractOption

Name	Path	Type	Description
Option ID	id	integer	ID of the contract's option.
Contract ID	contract_id	integer	ID of the contract bound to this option.
Element Definition ID	element_definition_id	integer	ID of the element definition of the option.
Sync Timer	sync_timer	integer	Timer that is used for synchronization issue.
Option Value	value	string	Value of the option.
Last modification place	last_modification_place	string	Indicates where the last modification took place.
Option Control	control	string	Control field.

ContractProperty

Name	Path	Type	Description
Property ID	id	integer	ID of the custom property.
Property Key	key	string	Key of the custom property.
Property Placeholder	placeholder	string	Label shown to the recipient when invited to fill in the property.
Property Value	value	string	Value of the custom property.
Property Contract ID	contract_id	integer	ID of the contract associated to this custom property.
Property Is Required	to_fill_by_user	boolean	Specify if user need to fill property or not.
Property Type	field_type	string	Specify the type of the custom property. More informations in the documentation.
Property Choices	input_filter	string	List of possible choice for the property.
Property Is Used By Contract	used_by_contract	boolean	Set to true if the information must appear on the contract document.
Property Is Required	required	boolean	Specify if property is required or not.

ContractPerimeterKey

Key of the perimeter.

Perimeter Key: string

ContractRecipient

Name	Path	Type	Description
Recipient for contract ID	recipient_for_contract_id	integer	Unique identifier of the couple contract and recipient.
Recipient ID	recipient_id	integer	ID of the recipient.
Contract ID	contract_id	integer	ID of the contract.
Signature status	signature_status	string	Status of the sign mark.
Signature date	signature_date	integer	Timestamp of the date of the sign mark.
Signature mode	signature_mode	integer	Sign mark mode.
Message title	message_title	string	Title of the message.
Message content	message_body	string	Body of the message.
Rank	rank	integer	Rank in the sign process.
Smart role	smartrole	string	Smart Role associated to the recipient.
Transport mode	transport_mode	integer	Transport mode.
Signature ID	signature_id	string	ID of the signature from the recipient.

DocumentAdded

Name	Path	Type	Description
Document ID	id	integer	ID of the document.
Rank	rank	integer	Place in the list of document.
Has SmartField	has_smart_field	boolean	Specify if the document has SmartFields.
Document Size	size	integer	Size of the document in bytes.
Document Name	filename	string	Name of the document.

Transaction

Name	Path	Type	Description
Contract Transaction ID	transaction_id	string	Specify the transaction ID bound to the contract.
Is Closed	is_closed	boolean	Specify if the contract is closed.
Contract Name	contract_name	string	Name of the contract.
Contract Status	status	string	Specify the status of the contract.

Perimeter

Name	Path	Type	Description
Perimeter ID	id	integer	ID of the perimeter.
Perimeter key	key	string	Key of the perimeter (used by contracts).
description	description	string	Description of the perimeter.

RecipientForContractWithRefusal

Name	Path	Type	Description
Recipient for contract ID	recipient_for_contract_id	integer	ID of the object that bound the contract and the recipient.
Recipient ID	recipient_id	integer	ID of the signature's recipient.
Signature Status	signature_status	string	Status of the signature.
Signature date	signature_date	integer	Date of the last changes of the signature.
Signature mode	signature_mode	integer	Mode of the signature.
Message title	message_title	string	Title of the message bound to the contract's signature.
Message content	message_body	string	Body of the message bound to the contract's signature.
Rank	rank	integer	Rank of the signature's recipient in the contract process.
Smart role name	smartrole	string	Role of the signature's recipient in the contract.
Transport mode	transport_mode	integer	Transport mode of the contract bound to the signature.
Signature ID	signature_id	string	ID of the signature.
Has Refusal	has_refusal	boolean	Specify if the recipient did refuse the contract.
Last refusal date	last_refusal_date	integer	Specify the date of refusal.
Last refusal message	last_refusal_message	string	Specify the refusal message.

ContractInBundle

Name	Path	Type	Description
Contract ID	id	integer	ID of the contract.
Contract Name	name	string	Name of the contract.
Contract definition type	contract_definition_type	string	Type of definition of the contract.
Contract definition ID	contract_definition_id	integer	ID of the contract's definition.
Company name	company_name	string	Name of the company bound to the contract.

Recipient

Name	Path	Type	Description
Recipient ID	id	integer	ID of the recipient.
Civility	civility	string	Civility of the recipient
First Name	firstname	string	Firstname of the recipient.
Last Name	lastname	string	Lastname of the recipient.
Main address	address_1	string	Main postal address of the recipient.
Postal Code	postal_code	string	Postal code of the recipient.
City	city	string	City of the recipient.
Mobile Phone number	cell_phone	string	Mobile Phone number of the recipient.
Mail address	email	string	Mail address of the recipient.
Country	country	string	Country of the recipient.
Secondary Address	address_2	string	Secondary postal address of the recipient.
Company Name	company_name	string	Company name of the recipient.
Phone number	phone	string	Phone number of the recipient.
Job Title	job_title	string	Job title of the recipient.
Birthdate	birthdate	integer	Birth date (timestamp) of the recipient.
Birth place	birthplace	string	Birth place of the recipient.
custom_properties	custom_properties	array of RecipientProperty
perimeters	perimeters	array of string

RecipientProperty

Name	Path	Type	Description
Property ID	id	integer	ID of the property.
Property key	key	string	Key of the property.
Property value	value	string	Value of the property.
Contractor ID	contractor_id	integer	ID of the contractor.
Synchronization timer	sync_timer	integer	Timer of the last synchronization.
Last modification place	last_modification_place	string	Location of the last modification.

AppendixAdded

Name	Path	Type	Description
Appendix ID	id	integer	ID of the Appendix.
Appendix Name	filename	string	Name of the Appendix.
Appendix option ID	option_id	integer	Option ID for the Appendix
Appendix Content-Type	content_type	string	Content-Type of the Appendix (image/jpeg for example).

BundleResponse

Name	Path	Type	Description
Bundle ID	id	integer	ID of the Bundle.
Author ID	actor_id	integer	ID of the creator of the Bundle.
First Contract ID	contract_id	integer	ID of the first contract of the created Bundle.
Bundle Status	status	integer	Status of the bundle.
Bundle Master	master	integer	Master of the bundle.

file

This is the basic data type 'file'.