POST
/
envelope
/
{envelope_id}
/
annotation

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

envelope_id
string
required

ID of the envelope

Body

application/json
recipient_id
string

ID of the recipient

document_id
string
required

ID of the document

page
integer
required

Page number where the annotation is placed

x
number
required

X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner

y
number
required

Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner

width
number
required

Width of the annotation (in % of the page width from 0 to 100)

height
number
required

Height of the annotation (in % of the page height from 0 to 100)

required
boolean
type
enum<string>
required

Type of the annotation

Available options:
TEXT,
SIGNATURE,
INITIALS,
CHECKBOX,
DATE
signature
object

Signature annotation (null if annotation is not a signature)

initials
object

Initials annotation (null if annotation is not initials)

text
object

Text annotation (null if annotation is not a text)

datetime
object

Date annotation (null if annotation is not a date)

checkbox
object

Checkbox annotation (null if annotation is not a checkbox)

Response

200 - application/json
id
string

Unique identifier of the annotation

recipient_id
string

ID of the recipient

document_id
string

ID of the document

page
integer

Page number where the annotation is placed

x
number

X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner

y
number

Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner

width
number

Width of the annotation (in % of the page width from 0 to 100)

height
number

Height of the annotation (in % of the page height from 0 to 100)

required
boolean

Whether the annotation is required

type
enum<string>

Type of the annotation

Available options:
TEXT,
SIGNATURE,
INITIALS,
CHECKBOX,
DATE
signature
object

Signature annotation (null if annotation is not a signature)

initials
object

Initials annotation (null if annotation is not initials)

text
object

Text annotation (null if annotation is not a text)

datetime
object

Date annotation (null if annotation is not a date)

checkbox
object

Checkbox annotation (null if annotation is not a checkbox)

Get envelope document annotationsDelete envelope annotation