Signhost (Preview)

Signhost the workflow signing service by Entrust is a digital signing and identification solution, empowering all types of businesses with seamless and secure online transactions.

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	Signhost Customer Success Team
URL	https://intercom.help/signhost/en/
Email	support@signhost.com

Connector Metadata
Publisher	Signhost
Website	https://www.signhost.com
Privacy policy	https://www.evidos.com/privacy
Categories	Content and Files;Productivity

SignHost

Signhost the workflow signing service by Entrust is a digital signing and identification solution, empowering all types of businesses with seamless and secure online transactions.

Publisher

Entrust Netherlands B.V.

Prerequisites

You will need a SignHost subscription in order to use this connector. You can generate an APIKey from the Signhost portal

Supported Operations

Get transaction details

Returns current transaction details. Please do not use this action for active polling.

Delete transaction

Delete a transaction by a transaction id. When a transaction is not in an end-state (such as fully signed) the transaction will be cancelled and cleaned. A cancelled transaction can be told to send an e-mail notification to the awaiting signers that the transaction was cancelled. The status of the transaction will be set to cancelled. When a transaction is in an end-state the transaction the transaction will be cleaned. The status of the transaction will remain the same but we will clean any uploaded documents and sensitive data as soon as possible.

Download PDF

Returns the (signed) document(s).

Download receipt

Returns the receipt when the transaction is successfully signed.

Create transaction

Creates a new transaction.

Add file

Add a file to the transaction.

Start transaction

Starts a transaction with the same {transactionId}.

Obtaining Credentials

You can generate a usertoken on the settings page in the SignHost portal. Please make sure to use the 'APIKey ' prefix in front of your usertoken.

Known Issues and Limitations

Currently not all of the features are supported. We welcome you to reach out to us with any requests or inquiries.

Deployment Instructions

Please follow the instructions in Create a custom connector from an OpenAPI definition.

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
Authorization	securestring	Provide your APIKey.	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add file	Add a file to the transaction or overwrite an existing file with the same {fileId}.
Create transaction	Creates a new transaction
Delete transaction	Delete a transaction by a transaction id
Download pdf	Returns the (signed) document(s).
Download receipt	Returns the receipt when the transaction is successfully signed (Status=30)
Get transaction details	Returns current transaction details
Start transaction	Starts a transaction with the same {transactionId}

Add file

Operation ID:

Addfile

Add a file to the transaction or overwrite an existing file with the same {fileId}.

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of an existing -- not yet started -- transaction
File Id	fileId	True	string	A unique identifier provided by you for the file.
File binary	body	True	binary	File upload

Create transaction

Operation ID:

Create

Creates a new transaction

Parameters

Name	Key	Required	Type	Description
Files	Files		object	A map of files attached to this transaction.
Language	Language		string	Language, only de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL and nl-NL are allowed.
Seal	Seal		boolean	Seal the document before sending to the signers.
Id	Id		string	The id of the signer, must be unique within a transaction.
Email	Email	True	string	The e-mail address of the signer
IntroText	IntroText		string	An intro text to show to the user during the sign process.
Type	Type	True	string	Type of the authentication object.
Number	Number		string	Phone number: This field is mandatory when the authentication method PhoneNumber is chosen
Bsn	Bsn		number	This field is mandatory when the authentication method BSN is chosen
Type	Type	True	string	Type of the verification object.
SendSignRequest	SendSignRequest		boolean	Send a sign invitation to the signer his e-mail address.
SignUrl	SignUrl		string	A unique URL per signer that provides the signing flow for the signer.
SignRequestSubject	SignRequestSubject		string	The subject of the sign request email in plain text.
SignRequestMessage	SignRequestMessage		string	The message of the sign request in plain text.
SendSignConfirmation	SendSignConfirmation		boolean	Send the sign confirmation to the signer his e-mail address.
Language	Language		string	Language, only de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL and nl-NL are allowed.
ScribbleName	ScribbleName		string	The name of the signer, this will be pre filled in the scribble form.
DaysToRemind	DaysToRemind		integer	Amount of days before reminding the signers. -1 to disable reminders.
Expires	Expires		date-time	When set the signer is no longer allowed to sign the transaction after this date.
Reference	Reference		string	The reference of the signer.
RejectReason	RejectReason		string	The rejection reason that was given by the signer when the transaction was rejected.
ReturnUrl	ReturnUrl		string	The url to redirect the user to after signing, rejecting or cancelling.
Context	Context		object	Any valid json object which we will return back.
Id	Id		string
Code	Code		integer	Consult api documentation
Info	Info		string	May contain additional information belonging to this activity
CreatedDateTime	CreatedDateTime		date-time
Name	Name	True	string	The name of the receiver.
Email	Email	True	string	The e-mail address of the receiver.
Language	Language		string	Language, only de-DE, en-US, es-ES, fr-FR, it-IT and nl-NL allowed.
Subject	Subject		string	The subject of the receiver email in plain text.
Message	Message	True	string	The email message towards the receiver in plain text.
Reference	Reference		string	The reference of the receiver.
Context	Context		object	Any valid json object which we will return back.
Reference	Reference		string	The reference of the transaction.
PostbackUrl	PostbackUrl		string	The absolute url to postback the status updates.
SignRequestMode	SignRequestMode		integer	Set to 1 for sending at once, to 2 for sequential.
DaysToExpire	DaysToExpire		integer	Amount of days before expiration. Max 90 days.

Returns

Body

Transaction

Delete transaction

Operation ID:

Delete

Delete a transaction by a transaction id

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of the transaction
SendNotifications	SendNotifications		boolean	Send e-mail notifications to the awaiting signers.
Reason	Reason		string	The reason of cancellation.

Download pdf

Operation ID:

Downloadpdf

Returns the (signed) document(s).

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of the description
Name	fileId	True	string	A unique identifier provided by you for the file.

Returns

Content

binary

Download receipt

Operation ID:

Downloadreceipt

Returns the receipt when the transaction is successfully signed (Status=30)

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of the description

Returns

Content

binary

Get transaction details

Operation ID:

Getdetails

Returns current transaction details

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of the transaction

Returns

Body

Transaction

Start transaction

Operation ID:

Start

Starts a transaction with the same {transactionId}

Parameters

Name	Key	Required	Type	Description
Transaction Id	transactionId	True	string	ID of an existing -- not yet started -- transaction

Definitions

Transaction

Name	Path	Type	Description
Id	Id	string	The id of the transaction.
Files	Files	array of object
Links	Files.Links	array of object
Rel	Files.Links.Rel	string
Type	Files.Links.Type	string
Link	Files.Links.Link	string
DisplayName	Files.DisplayName	string
Language	Language	string	The language, only de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL and nl-NL allowed.
Seal	Seal	boolean	Seal the document before sending to the signers.
Signers	Signers	array of object	The signer information.
Id	Signers.Id	string	The id of the signer, must be unique within a transaction.
Email	Signers.Email	string	The e-mail address of the signer
IntroText	Signers.IntroText	string	An intro text to show to the user during the sign process.
Authentications	Signers.Authentications	array of Authentication	List of authentications that the signer has to authenticate with.
Verifications	Signers.Verifications	array of Verification	List of verifications that the signer has to verify with.
SendSignRequest	Signers.SendSignRequest	boolean	Send a sign invitation to the signer his e-mail address.
SignUrl	Signers.SignUrl	string	A unique URL per signer that provides the signing flow for the signer.
SignRequestSubject	Signers.SignRequestSubject	string	The subject of the sign request email in plain text.
SignRequestMessage	Signers.SignRequestMessage	string	The message of the sign request in plain text.
SendSignConfirmation	Signers.SendSignConfirmation	boolean	Send the sign confirmation to the signer his e-mail address.
Language	Signers.Language	string	Only de-DE, en-US, es-ES, fr-FR, it-IT, pl-PL and nl-NL are allowed.
ScribbleName	Signers.ScribbleName	string	The name of the signer, this will be pre filled in the scribble form.
DaysToRemind	Signers.DaysToRemind	integer	Amount of days before reminding the signers.
Expires	Signers.Expires	date-time	When set the signer is no longer allowed to sign the transaction after this date.
Reference	Signers.Reference	string	The reference of the signer.
RejectReason	Signers.RejectReason	string	The rejection reason that was given by the signer when the transaction was rejected.
ReturnUrl	Signers.ReturnUrl	string	The url to redirect the user to after signing, rejecting or cancelling.
Context	Signers.Context	object	Any valid json object which we will return.
Activities	Signers.Activities	array of object	List of activities attached to this signer.
Id	Signers.Activities.Id	string
Code	Signers.Activities.Code	integer	101 - Invitation sent 102 - Received 103 - Opened 104 - Reminder sent 105 - Document opened, Info property contains the file id of the opened document. 201 - Cancelled 202 - Rejected 203 - Signed 301 - Signed document sent 302 - Signed document opened 303 - Signed document downloaded 401 - Receipt sent 402 - Receipt opened 403 - Receipt downloaded
Info	Signers.Activities.Info	string	May contain additional information belonging to this activity
CreatedDateTime	Signers.Activities.CreatedDateTime	date-time
Receivers	Receivers	array of object
Name	Receivers.Name	string	The name of the receiver.
Email	Receivers.Email	string	The e-mail address of the receiver.
Language	Receivers.Language	string	The language of the receiver, only de-DE, en-US, es-ES, fr-FR, it-IT and nl-NL are allowed.
Subject	Receivers.Subject	string	The subject of the receiver email in plain text.
Message	Receivers.Message	string	The email message towards the receiver in plain text.
Reference	Receivers.Reference	string	The reference of the receiver.
Context	Receivers.Context	object	Any valid json object which we will return back.
Reference	Reference	string	The reference of the transaction. For example "1234"
PostbackUrl	PostbackUrl	string	The absolute url to postback the status updates.
SignRequestMode	SignRequestMode	integer	Set to 1 for sending at once, to 2 for sequential.
DaysToExpire	DaysToExpire	integer	Amount of days before expiration. Max 90 days.
SendEmailNotifications	SendEmailNotifications	boolean	Send e-mail notifications to the sender.
Status	Status	integer	Current transaction status.
CancelationReason	CancelationReason	string	The original cancellation reason given during a DELETE call.
Context	Context	object	Any valid json object which we will return back.

Authentication

Name	Path	Type	Description
Type	Type	string	Type of the authentication object.
Number	Number	string	Phone number: This field is mandatory when the authentication method PhoneNumber is chosen
Bsn	Bsn	number	This field is mandatory when the authentication method BSN is chosen

Verification

Name	Path	Type	Description
Type	Type	string	Type of the verification object.

binary

This is the basic data type 'binary'.