The envelope instance returned by envelopes.create
Properties:
Name | Type | Description |
---|---|---|
id |
string | The envelope id |
data |
object | The raw envelope data from the last reflection |
documents |
Array.<Document> | The envelopes documents |
Methods
-
Adds a new recipient to the envelope
Name Type Description recipient
object The recipient data Name Type Description givenName
string The recipients first name familyName
string The recipients last name language
string The language code. "en_EN", "nb_NO", "sv_SE" etc signingMethod
string The recipients signing method. "email", "touch-sign", "bankid-no", "bankid-se" email
string The recipients email address order
number The recipients order in the envelope process role
object The role of the recipient Name Type Description action
string The recipients action. "sign", "review", "edit" label
string The recipients label that will appear in the Verified Webapp name
string The role name as described in the envelope descriptor -
Creates a new document
Name Type Description data
object The payload to be sent with the request to the API Returns:
Type Description object Raw HTTP response form the API -
firstDocument ()Document
-
Get the first document in the envelope
Returns:
Type Description Document The first document in the envelope -
firstTemplate ()Template
-
Get the first template in the first document of the envelope
Returns:
Type Description Template The first template in the first document -
Poll for bearer token
Name Type Description flowId
string The flow id of the envelope as specified in the descriptor Returns:
Type Description string JWT with permissions to make actions on the envelope -
Get sign link for a recipient
Name Type Description id
string The id of the recipient Returns:
Type Description string Full URL to signpage -
Poll for a sign token
Name Type Description flowId
string The flow id of the envelope as specified in the descriptor Returns:
Type Description string JWT with permissions to sign the documents -
Publish the envelope
-
Makes a raw PUT request to the API on the envelope
Name Type Description data
object The payload to be sent -
Fetches the envelope data from API and parses the data, instanciating documents etc