Sdílet prostřednictvím

SignatureAPI (Preview)

  • Reference

Send documents for signing, track progress, and get work done faster with our electronic signature platform built for high volume and ease of integration. https://signatureapi.com/docs/integrations/power-automate/getting-started

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 Signature API, Inc.
URL https://signatureapi.com
Email support@signatureapi.com
Connector Metadata
Publisher SignatureAPI
Website https://signatureapi.com/power-automate
Privacy policy https://signatureapi.com/privacy
Categories Collaboration;Productivity

SignatureAPI Connector

SignatureAPI is an electronic signature platform that empowers your workflows with customizable, secure, and cost-effective e-signatures.

Prerequisites

To use this connector, you need a SignatureAPI account. Sign up for a free account at SignatureAPI.

How to get credentials

After signing up, navigate to the API Key section within your dashboard to access your free test API key for workflow development.

Get started with your connector

Step 1: Create an envelope

Begin by using the Create an envelope action to make a new, empty envelope. This is where you'll later add your documents and recipients.

Step 2: Add documents to your envelope

For every document or template you need to include, use the Add a document action. Ensure that you have added signature places to your documents or templates. You can add up to 10 documents to each envelope.

Step 3: Add recipients to your envelope

Next, specify who needs to sign by using the Add a recipient action. You can add up to 10 recipients per envelope.

Step 4: Start the signing process

Once your envelope is fully prepared, initiate the signing process with the Start an envelope action.

Step 5: Wait for the envelope is completed

Pause your workflow with the Wait for envelope action. This holds until every recipient has signed, and the envelope is complete, producing a signed document.

Step 6: Get the signed document

Finally, retrieve the signed document through the Get a deliverable action, using the deliverable ID provided by the 'Wait for envelope' action.

Known issues and limitations

  • Create test envelopes using a test API key or by setting the Envelope Modes parameter to test in the 'Create an envelope' action. Test envelopes are not billed and won't send real emails, but can be reviewed in the Email section of the dashboard.

  • The 'Wait for envelope' action times out after 30 days.

Common errors and remedies

  • Ensure the Get a deliverable action is called after the Wait for envelope action, as deliverables are only generated once all recipients have completed their part of the process.

FAQ

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 your SignatureAPI account. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add a document

Adds a document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document
Add a recipient

Adds a recipient to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient
Add a template

Adds a template to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template
Add data to template

Adds data to a template. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data
Create an envelope

Creates a new envelope to which you can add recipients and documents. When ready, use the 'Start an envelope' action to initiate the signing process. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope
Get a deliverable

Retrieves a deliverable using its ID. Use it to download a signed copy of the envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable
Get an envelope

Retrieves the details of an envelope using its ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope
Start an envelope

Initiates the signing process for an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope
Wait for envelope

Waits for an envelope to reach a completed state or another final status. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Add a document

Operation ID:
AddDocument

Adds a document to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-document

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Document Title
 title string

The title of the document, which will be shown to the recipients.
File Content
 file_content True byte

The content of the document file.
File Format
 format string

The format of the document file.

Returns

Body
Document

Add a recipient

Operation ID:
AddRecipient

Adds a recipient to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-recipient

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Recipient Type
 type True string

The type of the recipient.
Recipient Name
 name True string

The name of the recipient.
Recipient Email
 email True string

The email address of the recipient.
Recipient Key
 key string

An identifier for this recipient, used in signing locations within documents.

Returns

Body
Recipient

Add a template

Operation ID:
AddTemplate

Adds a template to an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/add-template

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.
Document Title
 title string

The title of the document, which will be shown to the recipients.
File Content
 file_content True byte

The content of the template file.
File Format
 format string

The format of the template file.

Returns

Body
Template

Add data to template

Operation ID:
AddTemplateData

Adds data to a template. https://signatureapi.com/docs/integrations/power-automate/actions/add-template-data

Parameters

Name Key Required Type Description
Template ID
 documentId True string

The ID of the template.
Field Name
 field_name True string

The name of the field in the template.
Value
 value True string

The value for the field in the template.

Create an envelope

Operation ID:
CreateEnvelope

Creates a new envelope to which you can add recipients and documents. When ready, use the 'Start an envelope' action to initiate the signing process. https://signatureapi.com/docs/integrations/power-automate/actions/create-envelope

Parameters

Name Key Required Type Description
Envelope Title
 title True string

The title of this envelope, which will be shown to the recipients.
Envelope Message
 message string

A message that will be sent to the recipients.
Name
 name string

The name of the sender.
Email
 email string

The email address of the sender.
Envelope Mode
 mode string

Test mode envelopes are non-binding and not billed.
Time Zone
 timezone string

The time zone to be used for timestamps in deliverables. If not specified, the account's default timezone offset is used. https://signatureapi.com/docs/localization/timezone
Timestamp Format
 timestamp_format string

The date and time format to be used in timestamps for deliverables. If not specified, the account's default timestamp format is used. https://signatureapi.com/docs/localization/timestamp_format
Language
 language string

The default language to be used in the signing ceremony and deliverables. If not specified, the account's default language is used. https://signatureapi.com/docs/localization/language

Returns

Body
CreatedEnvelope

Get a deliverable

Operation ID:
GetDeliverable

Retrieves a deliverable using its ID. Use it to download a signed copy of the envelope. https://signatureapi.com/docs/integrations/power-automate/actions/get-deliverable

Parameters

Name Key Required Type Description
Deliverable ID
 deliverableId True string

The ID of the deliverable.

Returns

Body
Deliverable

Get an envelope

Operation ID:
GetEnvelope

Retrieves the details of an envelope using its ID. https://signatureapi.com/docs/integrations/power-automate/actions/get-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
Envelope

Start an envelope

Operation ID:
StartEnvelope

Initiates the signing process for an envelope. https://signatureapi.com/docs/integrations/power-automate/actions/start-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
StartedEnvelope

Wait for envelope

Operation ID:
WaitEnvelope

Waits for an envelope to reach a completed state or another final status. https://signatureapi.com/docs/integrations/power-automate/actions/wait-envelope

Parameters

Name Key Required Type Description
Envelope ID
 envelopeId True string

The ID of the envelope.

Returns

Body
Envelope

Definitions

EnvelopeId

The ID of the envelope.

The ID of the envelope.

Envelope ID
string

EnvelopeTitle

The title of this envelope, which will be shown to the recipients.

The title of this envelope, which will be shown to the recipients.

Envelope Title
string

EnvelopeMessage

A message that will be sent to the recipients.

A message that will be sent to the recipients.

Envelope Message
string

EnvelopeSender

Name Path Type Description
Sender Name
 name string

The name of the sender.
Sender Email
 email string

The email address of the sender.

EnvelopeStatus

The status of the envelope.

The status of the envelope.

Envelope Status
string

EnvelopeMode

Test mode envelopes are non-binding and not billed.

Test mode envelopes are non-binding and not billed.

Envelope Mode
string

EnvelopeDeliverable

Name Path Type Description
Deliverable ID
 id string

The ID of the deliverable. Use this to download a signed copy of the envelope.

EnvelopeCompletedAt

Time when all the recipients completed the envelope.

Time when all the recipients completed the envelope.

Envelope Completed At
date-time

CreatedEnvelope

Name Path Type Description
Envelope ID
 id EnvelopeId

The ID of the envelope.
Envelope Title
 title EnvelopeTitle

The title of this envelope, which will be shown to the recipients.
Envelope Message
 message EnvelopeMessage

A message that will be sent to the recipients.
sender
 sender EnvelopeSender
Envelope Mode
 mode EnvelopeMode

Test mode envelopes are non-binding and not billed.

StartedEnvelope

Name Path Type Description
Envelope ID
 id EnvelopeId

The ID of the envelope.
Envelope Status
 status EnvelopeStatus

The status of the envelope.

Envelope

Name Path Type Description
Envelope ID
 id EnvelopeId

The ID of the envelope.
Envelope Title
 title EnvelopeTitle

The title of this envelope, which will be shown to the recipients.
Envelope Message
 message EnvelopeMessage

A message that will be sent to the recipients.
sender
 sender EnvelopeSender
Envelope Status
 status EnvelopeStatus

The status of the envelope.
deliverable
 deliverable EnvelopeDeliverable
Envelope Completed At
 completed_at EnvelopeCompletedAt

Time when all the recipients completed the envelope.
Envelope Mode
 mode EnvelopeMode

Test mode envelopes are non-binding and not billed.

Document

Name Path Type Description
Document Id
 id string

The ID of the document.

Template

Name Path Type Description
Template Id
 id string

The ID of the template.

Recipient

Name Path Type Description
Recipient Id
 id string

The ID of the recipient.
Recipient Key
 key string

An identifier for this recipient, used in signing locations within documents.
Recipient Email
 email string

The email address of the recipient.
Recipient Name
 name string

The name of the recipient.
Recipient Status
 status string

The status of the recipient.
Recipient Completed At
 completed_at date-time

Time when the recipient completed the envelope.

Deliverable

Name Path Type Description
Deliverable Id
 id string

The ID of the deliverable.
Deliverable Type
 type string

The type of the deliverable.
Deliverable Status
 status string

The status of the deliverable.
File Content
 file_content byte

The file content of the deliverable. Use it to save a signed copy of the envelope.