Partilhar via


Annature (Independent Publisher) (Preview)

Annature is the leading Australian-owned eSigning solution with an integrated digital signature provider. This connector helps businesses to create envelopes and integrate annature document signing workflow using Annature API (v1).

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 Dr Adrian Colquhoun (Strategik)
URL https://www.linkedin.com/in/adriancolquhoun/
Email adrian@strategik.com.au
Connector Metadata
Publisher Dr Adrian Colquhoun (Strategik)
Website https://annature.com.au
Privacy policy https://www.annature.com.au/privacy-policy
Categories Productivity

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
Annature Id string Annature Id True
Annature Key securestring Annature Key True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create Envelope

Create Envelope

Create Envelope From Template

Use Template

Delete Envelope

Delete Envelope

Get Accounts

List All Accounts

Get all attachments for a field

Get Field Attachments

Get Documents

List All Documents for a envelope

Get Envelope

Get Envelope

Get Envelopes

List All Envelopes

Get Field

Get Field

Get Fields

List All Fields

Get Organisation

Get Organisation

Get Recipient

Get a single recipient created for an envelope using the id property that was returned in the create an envelope response body

Get Template

Get Template

Get Templates

List All Templates

Send Envelope

Send Envelope

Void Envelope

Send Envelope

Create Envelope

Create Envelope

Parameters

Name Key Required Type Description
Name
name True string

The name of the envelope, displayed in the subject of emails sent to recipients and when viewing the envelope

Message
message string

Message

Shared
shared boolean

Shared

Is Draft
draft boolean

Is Draft

Account ID
account_id True string

Account ID

Group Id
group_id string

Group Id

Group Id
id string

Group Id

Name
name string

Name

Type
type string

Type

File Content
base byte

File Content

Name
name string

Name

Email Id
email string

Email Id

Mobile
mobile string

Mobile

Recipient Type
type string

The recipient type, defaults to signer when not supplied

Message
message string

Message

password
password string
Muted?
muted boolean

This will stop Annature from sending any correspondence to the recipient

Signing Order
order integer

Signing Order

Session Completed
session_completed string

Destination endpoint after the recipient has completed the envelope

Session Declined
session_declined string

Destination endpoint after the recipient has declined to sign the envelope

id
id string
recipient_id
recipient_id string
type
type string

The field type

page
page integer
x_coordinate
x_coordinate integer
y_coordinate
y_coordinate integer
Required
required boolean

Required

Read only
read_only boolean

Read only

Collaborative
collaborative boolean

Collaborative

width
width integer
font_size
font_size integer
font_type
font_type string

Possible values are courier and helvetica

created
created string

Returns

Name Path Type Description
id
id string

Id

name
name string

Name

message
message string

Message

status
status string

Status

Shared
shared boolean

Shared

Created On
created string

Created On

Sent On
sent string

Sent On

voided
voided
declined
declined
completed
completed
Account Id
account_id string

Account_id

Group Id
group_id string

Group Id

recipients
recipients array of object
id
recipients.id string
name
recipients.name string
email
recipients.email string
mobile
recipients.mobile string
type
recipients.type string
status
recipients.status string
message
recipients.message string
Password
recipients.password

Password

Muted
recipients.muted boolean

Muted

order
recipients.order integer
declined_reason
recipients.declined_reason
created
recipients.created string
sent
recipients.sent string
declined
recipients.declined
completed
recipients.completed
session_completed
recipients.redirects.session_completed string
session_declined
recipients.redirects.session_declined string

Create Envelope From Template

Use Template

Parameters

Name Key Required Type Description
Template ID
id True string

Template ID

Name
name string

The name of the envelope, displayed in the subject of emails sent to recipients and when viewing the envelope

Is Draft
draft boolean

Is Draft

Message
message string

Message

Shared
shared boolean

Shared

Account ID
account_id True string

Account ID

Group Id
group_id string

Group Id

Group Id
id string

Group Id

Name
name string

Name

Group Id
type string

Group Id

File Content
base byte

File Content

Role Id
role_id string

Role Id

Name
name string

Name

Email Id
email string

Email Id

Mobile
mobile string

Mobile

SMS Auth
sms_auth string

SMS Auth

Recipient Type
type string

The recipient type, defaults to signer when not supplied

Message
message string

Message

password
password string
Muted?
muted boolean

This will stop Annature from sending any correspondence to the recipient

Signing Order
order integer

Signing Order

Field Id (from template)
id True string

Id of the template field

Value
value True string

Value for this field

Destination endpoint after the recipient has completed the envelope
session_completed string

Destination endpoint after the recipient has completed the envelope

Destination endpoint after the recipient has declined to sign the envelope
session_declined string

Destination endpoint after the recipient has declined to sign the envelope

Returns

Name Path Type Description
id
id string

Id

name
name string

Name

message
message string

Message

shared
shared boolean

Is Shared?

draft
draft boolean
account_id
account_id string

Account Id

group_id
group_id string

Group Id

documents
documents array of object
Id
documents.id string

Id

Name
documents.name string

Name

pages
documents.pages integer
Original
documents.original string

Original

Master
documents.master string

Master

Created
documents.created string

Created

recipients
recipients array of object
role_id
recipients.role_id string
name
recipients.name string
email
recipients.email string
mobile
recipients.mobile string
message
recipients.message string
password
recipients.password boolean
muted
recipients.muted boolean
session_completed
recipients.redirects.session_completed string
session_declined
recipients.redirects.session_declined string

Delete Envelope

Delete Envelope

Parameters

Name Key Required Type Description
Envelope ID
id True string

Envelope ID

Get Accounts

List All Accounts

Returns

Name Path Type Description
array of object
id
id string
Name
name string

Name

Email
email string

Email

number
number string
timezone
timezone string
role
role string
active
active boolean
group_id
group_id string
created
created string
verified
verified string

Get all attachments for a field

Get Field Attachments

Parameters

Name Key Required Type Description
Envelope ID
envelope_id True string

Envelope ID

Field Id
id True string

Field Id

Returns

Name Path Type Description
array of object
id
id string
original
original string
name
name string
type
type string
size
size integer
created
created string

Get Documents

List All Documents for a envelope

Parameters

Name Key Required Type Description
Envelope ID
envelope_id True string

Envelope ID

Endpoint Duration
endpoint_duration integer

Sets the number of minutes that the original, and master endpoints will be accessible for. Number can range between 1 and 10080 with the default being 60

Returns

Name Path Type Description
array of object
Id
id string

Id

Name
name string

Name

pages
pages integer
Original
original string

Original

Master
master string

Master

Created
created string

Created

Get Envelope

Get Envelope

Parameters

Name Key Required Type Description
Envelope ID
id True string

Envelope ID

Endpoint Duration
endpoint_duration integer

Sets the number of minutes that the original, and master endpoints will be accessible for. Number can range between 1 and 10080 with the default being 60

Returns

Name Path Type Description
id
id string

Id

name
name string

Name

message
message string

Message

status
status string

Status

shared
shared boolean

Shared

created
created string

Created

sent
sent string

Sent

voided
voided string

Voided

declined
declined string

Declined

completed
completed string

Completed

master
master string

Master

combined
combined string

Combined

certificate
certificate string

Certificate

account_id
account_id string

Account Id

group_id
group_id string

Group Id

Recipients
recipients array of object
Name
recipients.name string

Name

Email Id
recipients.email string

Email Id

Mobile
recipients.mobile string

Mobile

Recipient Type
recipients.type string

The recipient type, defaults to signer when not supplied

Message
recipients.message string

Message

Password
recipients.password
Muted?
recipients.muted boolean

This will stop Annature from sending any correspondence to the recipient

Signing Order
recipients.order integer

Signing Order

Destination endpoint after the recipient has completed the envelope
recipients.redirects.session_completed string

Destination endpoint after the recipient has completed the envelope

Destination endpoint after the recipient has declined to sign the envelope
recipients.redirects.session_declined string

Destination endpoint after the recipient has declined to sign the envelope

fields
recipients.fields array of object
id
recipients.fields.id string
recipient_id
recipients.fields.recipient_id string
type
recipients.fields.type string
page
recipients.fields.page integer
x_coordinate
recipients.fields.x_coordinate integer
y_coordinate
recipients.fields.y_coordinate integer
Required
recipients.fields.required boolean

Required

Read_only
recipients.fields.read_only boolean

Read_only

Collaborative
recipients.fields.collaborative boolean

Collaborative

width
recipients.fields.width integer
font_size
recipients.fields.font_size integer
font_type
recipients.fields.font_type string
created
recipients.fields.created string

Get Envelopes

List All Envelopes

Parameters

Name Key Required Type Description
Envelope Name
name string

An exact-match filter on the list based on the envelope's name property

Envelope Status
status string

An exact-match filter on the list based on the envelope's status

Recipient Name
recipient string

An exact-match filter on the list based on any recipient's name or email property

Created before
created_before date

Returns results where the created date is before the given value

Created After
created_after date

Returns results where the created date is after the given value

Completed before
completed_before date

Returns results where the completed date is before the given value

Completed After
completed_after date

Returns results where the completed date is after the given value

Returns

Name Path Type Description
array of object
id
id string

Id

name
name string

Name

message
message string

Message

status
status string

Status

shared
shared boolean

Shared

created
created string

Created

sent
sent string

Sent

voided
voided string

Voided

declined
declined string

Declined

completed
completed string

Completed

combined
combined string

Combined

master
master string

Master

certificate
certificate string

Certificate

account_id
account_id string

Account Id

group_id
group_id string

Group Id

Recipients
recipients array of object
Name
recipients.name string

Name

Email Id
recipients.email string

Email Id

Mobile
recipients.mobile string

Mobile

Recipient Type
recipients.type string

The recipient type, defaults to signer when not supplied

Message
recipients.message string

Message

Password
recipients.password
Muted?
recipients.muted boolean

This will stop Annature from sending any correspondence to the recipient

Signing Order
recipients.order integer

Signing Order

Destination endpoint after the recipient has completed the envelope
recipients.redirects.session_completed string

Destination endpoint after the recipient has completed the envelope

Destination endpoint after the recipient has declined to sign the envelope
recipients.redirects.session_declined string

Destination endpoint after the recipient has declined to sign the envelope

fields
recipients.fields array of object
id
recipients.fields.id string
recipient_id
recipients.fields.recipient_id string
type
recipients.fields.type string
page
recipients.fields.page integer
x_coordinate
recipients.fields.x_coordinate integer
y_coordinate
recipients.fields.y_coordinate integer
Required
recipients.fields.required boolean

Required

Read_only
recipients.fields.read_only boolean

Read_only

Collaborative
recipients.fields.collaborative boolean

Collaborative

width
recipients.fields.width integer
font_size
recipients.fields.font_size integer
font_type
recipients.fields.font_type string
created
recipients.fields.created string

Get Field

Get Field

Parameters

Name Key Required Type Description
Envelope ID
envelope_id True string

Envelope ID

Field Id
id True string

Field Id

Returns

Name Path Type Description
id
id string

Id

recipient_id
recipient_id string

Recipient Id

type
type string

Type

page
page integer
anchor
anchor string

Anchor

x_coordinate
x_coordinate integer
y_coordinate
y_coordinate integer
Required
required boolean

Required

Read_only
read_only boolean

Read_only

Collaborative
collaborative boolean

Allows other recipients on the envelope to modify the values

value
value string

The field's value

Checked
checked boolean

Checked

height
height integer
width
width integer
options
options
font_size
font_size integer
font_type
font_type string

Possible values are courier and helvetica

date_format
date_format string

Date Format

created
created string

Created

Get Fields

List All Fields

Parameters

Name Key Required Type Description
Envelope ID
envelope_id True string

Envelope ID

Returns

Name Path Type Description
array of object
id
id string
recipient_id
recipient_id string
type
type string
page
page integer
anchor
anchor string
x_coordinate
x_coordinate integer
y_coordinate
y_coordinate integer
Required
required boolean

Required

Read_only
read_only boolean

Read_only

Collaborative
collaborative boolean

Collaborative

value
value string
Checked
checked boolean

Checked

height
height integer
width
width integer
options
options
font_size
font_size integer
font_type
font_type string
date_format
date_format string
created
created string

Get Organisation

Get Organisation

Returns

Name Path Type Description
id
id string

Id

name
name string

Name

business
business string

Business

email
email string

Email

number
number string

Number

address
address string

Address

website
website string

Website

logo
logo string

Logo

colour
colour string

Colour

created
created string

Created

Get Recipient

Get a single recipient created for an envelope using the id property that was returned in the create an envelope response body

Parameters

Name Key Required Type Description
Recipient
id True string

Recipient Id

Returns

Name Path Type Description
Id
id string

Id

name
name string

Name

email
email string

Email

mobile
mobile string

Mobile

type
type string

Type

status
status string

Status

message
message string

Message

Password
password

Password

Muted
muted boolean

Muted

order
order integer
declined_reason
declined_reason string

Declined_reason

created
created string

Created

sent
sent string

Sent

declined
declined string

Declined

completed
completed string

Completed

session_completed
redirects.session_completed string

Session_completed

session_declined
redirects.session_declined string

Session_declined

Get Template

Get Template

Parameters

Name Key Required Type Description
Template ID
id True string

Template ID

Returns

Name Path Type Description
id
id string
name
name string
Shared
shared boolean

Shared

envelope_name
envelope_name string
envelope_message
envelope_message string
Envelope_shared
envelope_shared boolean

Envelope_shared

created
created string
account_id
account_id string
group_id
group_id string
documents
documents array of object
Id
documents.id string

Id

Name
documents.name string

Name

pages
documents.pages integer
Original
documents.original string

Original

Master
documents.master string

Master

Created
documents.created string

Created

roles
roles array of object
Id
roles.id string

Id

Name
roles.name string

Name

Recipient Name
roles.recipient_name string

Recipient Name

Recipient Email
roles.recipient_email string

Recipient Email

Recipient Mobile
roles.recipient_mobile string

Recipient Mobile

Recipient Type
roles.recipient_type string

The recipient type, defaults to signer when not supplied

Password
roles.recipient_password string

Password

Signing Order
roles.order integer

Signing Order

Destination endpoint after the recipient has completed the envelope
roles.recipient_redirects.session_completed string

Destination endpoint after the recipient has completed the envelope

Destination endpoint after the recipient has declined to sign the envelope
roles.recipient_redirects.session_declined string

Destination endpoint after the recipient has declined to sign the envelope

Get Templates

List All Templates

Parameters

Name Key Required Type Description
Name
name string

An exact-match filter on the list based on the templates

Created before
created_before date

Returns results where the created date is before the given value

Created After
created_after date

Returns results where the created date is after the given value

Returns

Name Path Type Description
array of object
id
id string
name
name string
Shared
shared boolean

Shared

envelope_name
envelope_name string
envelope_message
envelope_message string
Envelope_shared
envelope_shared boolean

Envelope_shared

created
created string
account_id
account_id string
group_id
group_id string
documents
documents array of object
Id
documents.id string

Id

Name
documents.name string

Name

pages
documents.pages integer
Original
documents.original string

Original

Master
documents.master string

Master

Created
documents.created string

Created

roles
roles array of object
Id
roles.id string

Id

Name
roles.name string

Name

Recipient Name
roles.recipient_name string

Recipient Name

Recipient Email
roles.recipient_email string

Recipient Email

Recipient Mobile
roles.recipient_mobile string

Recipient Mobile

Recipient Type
roles.recipient_type string

The recipient type, defaults to signer when not supplied

Password
roles.recipient_password string

Password

Signing Order
roles.order integer

Signing Order

Destination endpoint after the recipient has completed the envelope
roles.recipient_redirects.session_completed string

Destination endpoint after the recipient has completed the envelope

Destination endpoint after the recipient has declined to sign the envelope
roles.recipient_redirects.session_declined string

Destination endpoint after the recipient has declined to sign the envelope

Send Envelope

Send Envelope

Parameters

Name Key Required Type Description
Envelope ID
id True string

Envelope ID

Void Envelope

Send Envelope

Parameters

Name Key Required Type Description
Envelope ID
id True string

Envelope ID

Triggers

Event Trigger - Envelope and Recipient

Triggers when an event occurs when envelopes completed or recipient views

Event Trigger - Envelope and Recipient

Triggers when an event occurs when envelopes completed or recipient views

Returns

Definitions

WebhookEventContent

Name Path Type Description
event
event string
envelope_id
envelope_id string
voided
voided string
completed
completed string
master
master string
certificate
certificate string
sent
sent string
method
method string
recipient_id
recipient_id string
viewed
viewed string
declined
declined string
declined_reason
declined_reason string
failed
failed string
diagnosis
diagnosis string