Envelope Structure

This document contains an envelope data block, about all fields that you can add to document body.

<envelope templateUuid="1997a1b4-88e3-4f58-88ca-fcd2c6fb5869" templateVersion="4a303734-a118-44a2-aedf-67df61612628">
        <info>
                <subject>all fields envelope</subject>
                <message/>
                <forwarding delegation="true" sharing="true"/>
        </info>
        <flow>
                <roles>
                        <role id="74266bb8-91ad-4e35-9d98-5862fc59cf3e" mailboxUuid="8dcde243-a918-444a-ac7d-44ac88554769"/>
                        <role id="a09d90c7-46c1-4f59-8d76-e7975dd8fab6" mailboxUuid="8dcde243-a918-444a-ac7d-44ac88554769"/>
                </roles>
        </flow>
        <documents>
                <document id="16c545db-1002-4efb-a4de-b46bc5ed4885">
                        <field name="Text">text</field>
                        <field name="Duplicate">text</field>
                        <field name="Number">10</field>
                        <field name="Currency">10.20</field>
                        <field name="Date">2024-01-11</field>
                        <field name="Dictionary" recordUuid="76d0b4a4-114f-45a6-9039-d654c90a2df2">one 2</field>
                        <field name="Signature">data:image/png;base64,iVBORw...K5CYII=</field>
                        <field name="File" attachmentUuid="dc317260-adf3-4231-8eaa-588759d7b6f7">Screenshot 2024-01-11 at 11.22.54.png</field>
                        <field name="Lookup">two 2</field>
                        <field name="Checkbox">1</field>
                        <field name="Dropdown">2</field>
            // If dropdown contains option multiselect
            <field name="Dropdown 2">
                <value>1</value>
                <value>2</value>
            </field>
                        <field name="1234">Choice</field>
                        <fieldgroup name="Table">
                                <fieldset index="0">
                                        <field name="Text 2">1</field>
                                </fieldset>
                                <fieldset index="1">
                                        <field name="Text 2">2</field>
                                </fieldset>
                        </fieldgroup>
                </document>
        </documents>
</envelope>

Parameter name	Description
Envelope
templateUuid	ID of the template on the basis of which the envelope was created
templateVersion	ID of the template version on the basis of which the envelope was created
created	Envelope creation date
State
status	Envelope status can be: draft, sent, waiting, completed, expired, rejected
date	Status change date
roleId	Role identifier
Info
subject	Envelope subject
message	Short message about envelope
expire	Envelope expiration date – through how many days the envelope will be expired
Documents
document id	Document identifier
dynamic fields	Dynamic field which filled by current role
Flow
role id	Role identifier
mailboxUuid	Role mailboxUUID
active	Role status – can be true or false
completed	Document processing status by role. Can be true or false

Dynamic Fields attributes

Text, Number, Currency, Date, Dropdown Fields

<field name=”string”>value</field>

• name — string, name of the field you want to fill

• value — the value of the field, all validation restrictions configurable on template, mandatory if field doesn’t have optional attribute

Several values as additional tags inside field tag.

Duplicate, Lookup and Autonumber Fields

If the template contains these field types, you do not need to send them. They are filled in automatically.

Dictionary Field

<field name=”string” recordUuid=”UUID”>value</field>

• name — string, name of the field you want to fill

• recordUuid — UUID, record UUID from dictionary you want to chose

• value — the value of the field, all validation restrictions configurable on template, optional, but if you define value verification of recordUUID and value happen

Signature Field

<field name=”string”>value</field>

• name — string, name of the field you want to fill

• value — the value of the field, value in base64 format (data:image/png;base64,iVBORw…K5CYII=), all validation restrictions configurable on template, mandatory

Checkbox Field

<field name=”string”>value</field>

• name — string, name of the field you want to fill

• value — integer, value 1 to mark it checked, if you don’t want to send value use optional field and skip fill in of particular one, all validation restrictions configurable on template

Choice Field

<field name=”string”>value</field>

• name — string, name of the GROUP of radio buttons

• value — string, name of the field from the GROUP of radio buttons which should be marked as chosen

Table Field

<fieldgroup name="string">
    <fieldset index="0">
        <field name="Text 2">1</field>
    </fieldset>
    <fieldset index="1">
        <field name="Text 2">2</field>
    </fieldset>
</fieldgroup>

• fieldgroup name — string, name of the table field

• fieldset index — integer, index of the table row (if you need more rows, just create more fieldsets)