Create an envelope

Creates a new envelope and, by default, sends a signing email to all eligible recipients, respecting the order and muted properties defined on each recipient. For more detail on how recipients behave, refer to the recipients section.

All envelopes must include an account_id to identify the sender. If the account is assigned to a group, the envelope will automatically inherit that group. This can be overridden by supplying a group_id directly.

Each envelope must include at least one document and one recipient with a type of signer. Every signer must have at least one field defined.

To create a draft envelope, set draft to true and include at least one document. Drafts can optionally include recipients, but recipient fields are not supported in drafts.

Drafts can be opened and completed in the Annature dashboard by visiting: https://dashboard.annature.com.au/create-envelope?envelopeId={{envelope_id}}

​

Field placement methods

When creating fields for a recipient, there are two supported placement strategies:

​

Anchors (automatic placement)

Anchors allow you to specify a text string, and fields will be automatically created at every location in all documents where that string appears. Anchors are a fast and flexible way to apply fields without knowing exact coordinates.

• All anchor matches use the bottom-left of the matched text as the origin.
• Optional x_offset and y_offset can be supplied to fine-tune placement.
• If a field would overflow the page, it is silently skipped.

​

Coordinates (fixed positioning)

For precise control, coordinates can be supplied using absolute x_coordinate and y_coordinate values.

• All coordinates use 72 DPI rendering with a bottom-left origin.
• For most fields, positioning is relative to the bottom-left corner.
• For input fields, positioning is relative to the top-left, and height expands downward based on content.

​

Parameters

POST /v1/envelopes

{
  "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
  "name": "Non disclosure agreement",
  "message": "Lorem ipsum dolor sit amet.",
  "status": "sent",
  "shared": false,
  "created": "2019-12-17T05:30:00Z",
  "sent": "2019-12-17T05:30:00Z",
  "voided": null,
  "declined": null,
  "completed": null,
  "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
  "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "recipients": [{
    "id": "255e591c2c9fe1bc99be1ec03075b402",
    "name": "Ted Annature",
    "email": "ted@annature.com.au",
    "mobile": "+61422000000",
    "type": "signer",
    "status": "sent",
    "message": "Lorem ipsum dolor sit amet.",
    "password": false,
    "sms_auth": "+61422000000",
    "muted": false,
    "order": 1,
    "declined_reason": null,
    "created": "2019-12-17T05:30:00Z",
    "sent": "2019-12-17T05:30:00Z",
    "declined": null,
    "completed": null,
    "redirects": {
      "session_completed": "https://..",
      "session_declined": "https://..",
    }
  }],
  "metadata": {}
}