Verified

  • Reference

Connector for the Verified API to enable the creation of custom document signing processes.

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 Verified
URL https://verified.eu/en/#about-us
Email support@verified.eu
Connector Metadata
Publisher CRM Konsulterna i Sverige AB
Website https://verified.eu/
Privacy policy https://verified.eu/trust-center
Categories Content and Files;Productivity

Verified is a Software as a Service provider of electronic identification and digital signing. This connector makes it possible to integrate to the API of Verified and create simple and intuitive signing processes within your application.

Publisher: CRM-Konsulterna i Sverige AB

The publisher for this connector is CRM-Konsulterna i Sverige AB on behalf of Verified.

Prerequisites

You will need the following to proceed:

How to get credentials

This connector uses Basic Authentication. The user has to present username, password and company Id when creating a connection. Username and password are the same you use to login to the Verified portal. To get the company Id you have to log in to the Verified portal, select the correct company if you have several and copy the company Id from the URL.

Get started

A common use case is to start and manage a signing process, i.e. setting up automation for sending documents to be signed to Verified and getting signed documents back on a regular basis. Common actions that are used to start a Verified signing process include Create envelope - descriptor or Create envelope - default, Add document to envelope, Add file to document, Add recipient to envelope and Update publish status for envelope. Common actions that are used in order to check the Verified status for documents include Get envelope by id, Get all documents by envelope id, Get files by document id, Get file URL by id. Note that action Generate security token is always used as a first step in order to obtain a security token to be used in the following steps.

Known Issues and Limitations

The following limitations are currently known.

  • In the beginning of every flow one has to create an authentication token to be reused in every following step.
  • To add a document one has to send an HTTP request to a certain url.

FAQ

How do I upload a document to Verified?

To Upload an actual document you have to create a file in the Verified API and upload the document hash to the blob URL responded from the Verified API.

How do I get hold of the envelope after using the get envelope id action?

The steps that create an envelope respond with an uid, which is a complete path to the envelope (example: "/envelopes/ABCDE"). For other steps one does only need the last part of the uid (which is the actual envelope id, in our example "ABCDE").

Here is an example on how to do that

substring(outputs('Create_new_default_envelope')?['body/uid'],11)

How do I get hold of the document id after using the Add document to envelope action?

The steps that create a document respond with the Location of the new document in the header. The Location is the complete path to the document (example: "/api/envelopes/ABCDE/documents/FGHIJ"). Only the document id (in our case: FGHIJ) is needed for following steps.

Here is an example on how to do that

substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))

How do I get hold of the Flow Id from an envelope?

When one loads information about an envelope the related flow will be part of the response (example: "/flow/default"). In the response it is called the id of a flow, however one needs only the last part when another step (like Get flow status) is asking for the flow id.

Here is an example on how to do that

substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)

How do I use a different company than defined in the connection?

Actions where the company is needed have an additional field, Company Id. When a value is presented it is used otherwise the default from the connection is used. The format should be:

/companies/<your company Id>

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
username securestring The username for this api True
password securestring The password for this api True
Company ID string Company id is provided by Verified. Can be found in the URL by logging in to app.verified.eu True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add document to envelope

Adds a new document to an existing envelope.
Add file to document

Adds a file to an existing document.
Add recipient to envelope

Adds a recipient to a given envelope.
Create envelope - default

Creates a new envelope using the default descriptor.
Create envelope - descriptor

Creates an envelope based on a specific descriptor.
Create signature link

Creates a signature link. Implementation is flow specific and may be missing for your specific flow.
Delete document by id

Deletes a given document.
Delete envelope by id

Deletes a given envelope.
Generate Document from Template

Generates a document from a preconfigured template.
Generate security token

Gets the authentication token from the Verified API.
Get all descriptors

Gets a list of all descriptors present in the current company. The list could be filtered.
Get all documents by envelope id

Gets all documents related to a given envelope.
Get all envelope recipients

Gets all recipients of a given envelope.
Get company by id

Gets information of a given company.
Get default descriptor

Gets the default descriptor for envelopes.
Get descriptor by id

Gets information of a given descriptor.
Get document by id

Gets information of a given document.
Get envelope by id

Gets details of a given envelope.
Get file by id

Gets information about a given file.
Get file URL by id

Gets the url to a given file.
Get files by document id

Gets all files connected to a given document.
Get flow state by envelope id

Gets the current flow state of a given envelope.
Get specific recipient for an envelope

Gets a specific recipient for a given envelope.
Get user information

Gets information of the currently logged in user.
Get user settings

Gets the settings of a given user.
Query all envelopes

Queries all envelopes matching a given filter.
Send notification

Sends a notification to recepients of a given envelope.
Set document abort status

Sets the status of a given document to aborted.
Set envelope abort status

Sets the status of a given envelope to aborted.
Set envelope trash status

Sets the status of a given envelope to trashed.
Update envelope settings

Updates Settings of a given envelope.
Update publish status for envelope

Updates the publish status of a given envelope.
Update recipient by id

Updates a recipient.

Add document to envelope

Operation ID:
PostEnvelopesEnvelopeIdDocuments

Adds a new document to an existing envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Hash
 hash integer
Name
 name True string
Source
 source string

Returns

Add file to document

Operation ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Adds a file to an existing document.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question
Name
 name True string
FileType
 fileType True string
Hash
 hash string

Returns

File
File

Add recipient to envelope

Operation ID:
PostEnvelopesEnvelopeIdRecipients

Adds a recipient to a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
First Name
 givenName True string
Last Name
 familyName True string
Language
 language True string
Signing Method
 signingMethod True string
Notification Method
 notificationMethod string
E-Mail
 email True string
Telephone
 telephone string

Format should be +
Order
 order integer
Action
 action True string

Verified's name of the action a recipient should execute.
Label
 label True string

Label for the role/action of a recipient
Name
 name True string

Verified name of the role of a recipient
Secure
 secure boolean
SMS
 sms boolean
SSN
 ssn string
Bank
 bank string

Returns

Create envelope - default

Operation ID:
PostEnvelopeDescriptorsDefaultEnvelopes

Creates a new envelope using the default descriptor.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Email
 email string
First Name
 givenName string
Last Name
 familyName string
Automatic Reminders
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Returns

Name Path Type Description
uid
 uid string

Create envelope - descriptor

Operation ID:
PostEnvelopeDescriptorsEnvelopeDescriptorIdEnvelopes

Creates an envelope based on a specific descriptor.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Descriptor Id
 envelope-descriptor-id True string

Id of the Envelope Descriptor
Email
 email string
First Name
 givenName string
Last Name
 familyName string
Automatic Reminders
 automaticReminders number
Expiration
 expiration string
Hash
 hash string

Returns

Name Path Type Description
uid
 uid string
Operation ID:
PostEnvelopesEnvelopeIdJobsGetSignLink

Creates a signature link. Implementation is flow specific and may be missing for your specific flow.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Id
 id string
Redirect To
 redirectTo uri

Full URL to redirect the user to after sign.

Returns

Name Path Type Description
URL
 getSignLink.recipient.{recipient-id}.url string

Delete document by id

Operation ID:
DeleteEnvelopesEnvelopeIdDocumentsDocumentId

Deletes a given document.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question

Delete envelope by id

Operation ID:
DeleteEnvelopesEnvelopeId

Deletes a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question

Generate Document from Template

Operation ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdTemplatesTemplateIdUserData

Generates a document from a preconfigured template.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question
Template Id
 template-id True string

The Id of the template which should be used
object

Generate security token

Operation ID:
PostAuthenticate

Gets the authentication token from the Verified API.

Returns

Name Path Type Description
Token
 token string

Access token

Get all descriptors

Operation ID:
GetEnvelopeDescriptors

Gets a list of all descriptors present in the current company. The list could be filtered.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Filters
 filters string

Filter query to select subamount

Returns

response
array of Descriptor

Get all documents by envelope id

Operation ID:
GetEnvelopesEnvelopeIdDocuments

Gets all documents related to a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question

Returns

response
array of Document

Get all envelope recipients

Operation ID:
GetEnvelopesEnvelopeIdRecipients

Gets all recipients of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question

Returns

response
array of Recipient

Get company by id

Operation ID:
GetCompaniesCompanyId

Gets information of a given company.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company Id
 company-id True string

The ID of the company in question

Returns

Company
Company

Get default descriptor

Operation ID:
GetEnvelopeDescriptorsDefault

Gets the default descriptor for envelopes.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Filters
 filters string

Filter query to select subamount

Returns

Descriptor
Descriptor

Get descriptor by id

Operation ID:
GetEnvelopeDescriptorsEnvelopeDescriptorId

Gets information of a given descriptor.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Descriptor Id
 envelope-descriptor-id True string

Id of the Envelope Descriptor

Returns

Descriptor
Descriptor

Get document by id

Operation ID:
GetEnvelopesEnvelopeIdDocumentsDocumentId

Gets information of a given document.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question

Returns

Document
Document

Get envelope by id

Operation ID:
GetEnvelopesEnvelopeId

Gets details of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question

Returns

Envelope
Envelope

Get file by id

Operation ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileId

Gets information about a given file.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question
File Id
 file-id True string

The ID of the File in question

Returns

File
File

Get file URL by id

Operation ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFilesFileIdUrl

Gets the url to a given file.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question
File Id
 file-id True string

The ID of the File in question
As Object
 asObject boolean

Defines whether the response is an Object

Returns

Name Path Type Description
URL
 url string

File URL

Get files by document id

Operation ID:
GetEnvelopesEnvelopeIdDocumentsDocumentIdFiles

Gets all files connected to a given document.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question

Returns

response
array of File

Get flow state by envelope id

Operation ID:
GetFlowsFlowIdJobsEnvelopeId

Gets the current flow state of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Flow Id
 flow-id True string

Id of the flow in question

Returns

Name Path Type Description
Token
 token string

Get specific recipient for an envelope

Operation ID:
GetEnvelopesEnvelopeIdRecipientsRecipientId

Gets a specific recipient for a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Recipient Id
 recipient-id True string

The ID of the recipients in question

Returns

Recipient
Recipient

Get user information

Operation ID:
GetAuthUserinfo

Gets information of the currently logged in user.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action

Returns

Body
UserInfo

Get user settings

Operation ID:
GetCompaniesCompanyIdUsersUserIdSettings

Gets the settings of a given user.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company Id
 company-id True string

The ID of the company in question
User Id
 user-id True string

ID of the user in question

Returns

Body
Setting

Query all envelopes

Operation ID:
GetQueryEnvelopes

Queries all envelopes matching a given filter.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Filters
 filters string

Filter query to select subamount
From
 from integer

From date
Limit
 limit integer

Limit amount
Sort
 sort string

Sort by

Returns

response
array of EnvelopeDescriptorString

Send notification

Operation ID:
PostEnvelopesEnvelopIdJobsSendNotification

Sends a notification to recepients of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Greeting
 greeting string
Recipient Id
 id True string

The ID of the recipient the notification should be send to.

Set document abort status

Operation ID:
PostEnvelopesEnvelopeIdDocumentsDocumentIdStatusAborted

Sets the status of a given document to aborted.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Document Id
 document-id True string

The ID of the document in question

Set envelope abort status

Operation ID:
PutEnvelopesEnvelopeIdAbortStatus

Sets the status of a given envelope to aborted.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
comment
 comment string

Set envelope trash status

Operation ID:
PutEnvelopesEnvelopeIdTrashStatus

Sets the status of a given envelope to trashed.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Comment
 comment string

Update envelope settings

Operation ID:
PutEnvelopesEnvelopeId

Updates Settings of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Sequential Signing
 sequentialSigning boolean
Greeting
 greeting string
Expiration
 expiration date

Date in the following format 2017-02-26T21:59:59.999Z
Automatic Reminders
 automaticReminders number

X Days before expiration

Update publish status for envelope

Operation ID:
PutEnvelopesEnvelopeIdPublishStatus

Updates the publish status of a given envelope.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Published
 published True boolean

Update recipient by id

Operation ID:
PutEnvelopesEnvelopeIdRecipientsRecipientId

Updates a recipient.

Parameters

Name Key Required Type Description
Token
 token True string

Token received from the 'Generate security token' action
Company ID
 x-namespace string

The company ID which should be used for the action. Format: "/companies/. Defaults to connections company Id if not set.
Envelope Id
 envelope-id True string

Id of the envelope in question
Recipient Id
 recipient-id True string

The ID of the recipients in question
First Name
 givenName True string
Last Name
 familyName True string
Language
 language True string
Signing Method
 signingMethod True string
Notification Method
 notificationMethod string
E-Mail
 email True string
Telephone
 telephone string

Format should be +
Order
 order integer
Action
 action True string

Verified's name of the action a recipient should execute.
Label
 label True string

Label for the role/action of a recipient
Name
 name True string

Verified name of the role of a recipient
Secure
 secure boolean
SMS
 sms boolean
SSN
 ssn string
Bank
 bank string

Definitions

Setting

Name Path Type Description
Global
 global string
Signatory Language
 preferences.signatoryLanguage string
Greeting
 preferences.greeting string
Signing Method
 preferences.signingMethod string
Reminder Offset
 preferences.reminderOffset string

UserInfo

Name Path Type Description
First Name
 givenName string
Last Name
 familyName string
Email
 email string
Language
 metadata.language string
Missing Password
 missingPassword boolean
Is Enabled
 isEnabled boolean
Namespace
 namespace string
Enabled
 enabled boolean
UID
 uid string
Id
 id string
Roles
 roles array of Role
Validated
 validated boolean

Company

Name Path Type Description
Name
 name string
Reg. Number
 regNumber string
Created
 created string
Modified
 modified string
Address
 address string
City
 city string
Zip Code
 zipCode string
Logo
 logo string
Country
 country string
UId
 uid string
Id
 id string

Recipient

Name Path Type Description
UID
 uid string

Recipient UID
Namespace
 namespace string

Recipient Namespace
Created
 created string

Recipient Created
Role
 role RoleActionString
Last Name
 familyName string

Recipient Last Name
First Name
 givenName string

Recipient Frist Name
Language
 language string

Recipient Language
Email
 email string

Recipient Email
Signing Method
 signingMethod string

Recipient Signing Methid
Notification Method
 notificationMethod string
Order
 order integer

Recipient Order
Id
 id string

Recipient Id
Modified
 modified string

Recipient Modified
Notified
 notified boolean
Completed
 completed boolean
demandAttachment
 demandAttachment boolean

Role

Name Path Type Description
Type
 action.type string
methods
 action.methods array of string
Label
 label string

Label
Num. Max
 numMax integer

Num. Max
Num. Min
 numMin integer

Num. Min
Role Name
 roleName string

RoleActionString

Name Path Type Description
Action
 action ActionString

Action
Label
 label string

Label
Num. Max
 numMax integer

Num. Max
Num. Min
 numMin integer

Num. Min
Role Name
 roleName string

ActionString

Action

Action

Action
string

Envelope

Name Path Type Description
Id
 id string

Envelope Id
UID
 uid string

Envelope UID
Namespace
 namespace string

Envelope Namespace
Version
 version integer

Envelope Version
Published
 published boolean

Envelope Published
Complete
 completed boolean

Envelope Completed
Aborted
 aborted boolean

Envelope Avorted
Trashed
 trashed boolean

Envelope Trashed
Sequential Signing
 sequentialSigning boolean
Autmatic Reminders
 automaticReminders integer
Created
 created string

Envelope Created
Modified
 modified string

Envelope Modified
Expired
 expired boolean

Envelope Expired
Flow
 flow Flow
Descriptor
 descriptor Descriptor
Person
 sender Person
Documents
 documents array of Document
Recipients
 recipients array of Recipient
Tags
 tags array of object
Owners
 owners array of Person

EnvelopeDescriptorString

Name Path Type Description
Id
 id string

Envelope Id
UID
 uid string

Envelope UID
Namespace
 namespace string

Envelope Namespace
Version
 version integer

Envelope Version
Published
 published boolean

Envelope Published
Complete
 completed boolean

Envelope Completed
Aborted
 aborted boolean

Envelope Avorted
Trashed
 trashed boolean

Envelope Trashed
Sequential Signing
 sequentialSigning boolean
Autmatic Reminders
 automaticReminders integer
Created
 created string

Envelope Created
Modified
 modified string

Envelope Modified
Expired
 expired boolean

Envelope Expired
Flow
 flow Flow
Descriptor
 descriptor string

Envelope descriptor
Person
 sender Person
Documents
 documents array of Document
Recipients
 recipients array of Recipient
Tags
 tags array of object
Owners
 owners array of Person

File

Name Path Type Description
Id
 id string

File Id
URL
 url string

File URL
Name
 name string

File Name
MimeType
 mimeType string
File Type
 fileType string
Storage Path
 storagePath string
Uploaded At
 uploadedAt string
Created
 created string

File Created
Owners
 owners array of object
UID
 owners.uid string

File Owner UID
Id
 owners._id string

File Owner Id
Namespace
 namespace string
UID
 uid string

File UID

Flow

Name Path Type Description
Id
 id string

Flow Id
Name
 name string

Flow Name

Descriptor

Name Path Type Description
Name
 name string

Descriptor Name
Version
 version integer

Descriptor Version
UID
 uid string

Descriptor UID
Deleted
 deleted boolean

Descriptor Deletd
Public
 public boolean

Descriptor Public
Expired
 expired boolean

Descriptor Expired
Id
 id string

Descriptor Id
Mandatory
 mandatory boolean

Descriptor Mandatory
Label
 label string

Descriptor Label
Type
 type string

Descriptor Type
Roles
 roles array of Role
Owners
 owners array of Person
Flow
 flow Flow
defaultValues
 defaultValues DefaultValues

defaultValues
Instances
 instances array of object

Person

Name Path Type Description
UID
 uid string

Person UID
First Name
 givenName string

Person First Name
Last Name
 familyName string

Person Last Name
Email
 email string

Person Email
Language
 language string

Person Language
Order
 order integer

Person Order

Document

Name Path Type Description
Label
 label string

Document Label
Type
 type string

Document Type
Hash
 hash integer

Document Hash
Num. Max
 numMax integer

Document Num. Max
Num. Min
 numMin integer

Document Num. Min
UID
 uid string

Document UID
Namespace
 namespace string

Document Namespace
Source
 source string

Document Source
Created
 created string

Document Created
Name
 name string

Document Name
Id
 id string

Document Id
Modified
 modified string

Document Modified
Rejected
 rejected boolean

Document Rejected
Signed
 signed boolean

Document Signed
Trashed
 trashed boolean

Document Trashed
Aborted
 aborted boolean

Document Aborted
Version
 version integer

Document Version
attachments
 attachments array of Attachment
Flow
 flow Flow
roles
 roles array of Role
Template
 template Template
Descriptor
 descriptor Descriptor

Attachment

Name Path Type Description
Label
 label string

Attachment Label
Num. Max
 numMax integer

Attachment Num. Max
Num. Min
 numMin integer

Attachment Num.Min
Hash
 hash integer

Attachment Hash

Template

Name Path Type Description
Type
 type string

Template Type
HTML
 html string
PDFHTML
 pdfHtml string
Id
 id string
UID
 uid string
Namespace
 namespace string
Version
 version integer
Created
 created string
Modified
 modified string
Modified
 published boolean
Completed
 completed boolean
Aborted
 aborted boolean

DefaultValues

defaultValues

Name Path Type Description
Person
 signer Person
Person
 reviewer Person