Get Started
Guides
- Account
- Envelopes
- Templates
- Webhooks
Backend SDKs
- Python
- Typescript
- Go
- Java
- C#
- PHP
API Reference
- Envelope
- POSTCreate new envelope
- POSTCreate new envelope from template
- POSTList envelopes
- GETGet envelope
- DELDelete envelope
- GETGet envelope document
- GETGet envelope documents
- POSTAdd envelope document
- PUTSet envelope dynamic fields
- POSTAdd envelope signing steps
- POSTSend envelope for signature
- POSTDuplicate envelope
- PUTVoid envelope
- PUTRename envelope
- PUTSet envelope comment
- PUTSet envelope notification
- PUTSet envelope expiration date
- PUTSet envelope legality level
- GETGet envelope annotations
- GETGet envelope document annotations
- POSTAdd envelope annotation
- DELDelete envelope annotation
- GETDownload signed documents
- GETDownload certificate of completion
- POST
- Template
- Webhook
Get envelope document annotations
curl --request GET \
--url https://restapi.sign.plus/v2/envelope/{envelope_id}/annotations/{document_id} \
--header 'Authorization: Bearer <token>'{
"annotations": [
{
"id": "<string>",
"recipient_id": "<string>",
"document_id": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"required": true,
"type": "TEXT",
"signature": {
"id": "<string>"
},
"initials": {
"id": "<string>"
},
"text": {
"size": 123,
"color": 123,
"value": "<string>",
"tooltip": "<string>",
"dynamic_field_name": "<string>",
"font": {
"family": "UNKNOWN",
"italic": true,
"bold": true
}
},
"datetime": {
"size": 123,
"font": {
"family": "UNKNOWN",
"italic": true,
"bold": true
},
"color": "<string>",
"auto_fill": true,
"timezone": "<string>",
"timestamp": 123,
"format": "DMY_NUMERIC_SLASH"
},
"checkbox": {
"checked": true,
"style": "CIRCLE_CHECK"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the envelope
ID of document
Response
Unique identifier of the annotation
ID of the recipient
ID of the document
Page number where the annotation is placed
X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Width of the annotation (in % of the page width from 0 to 100)
Height of the annotation (in % of the page height from 0 to 100)
Whether the annotation is required
Type of the annotation
TEXT, SIGNATURE, INITIALS, CHECKBOX, DATE Signature annotation (null if annotation is not a signature)
Unique identifier of the annotation signature
Initials annotation (null if annotation is not initials)
Unique identifier of the annotation initials
Text annotation (null if annotation is not a text)
Font size of the text in pt
Text color in 32bit representation
Text content of the annotation
Tooltip of the annotation
Name of the dynamic field
Date annotation (null if annotation is not a date)
Font size of the text in pt
Color of the text in hex format
Whether the date should be automatically filled
Timezone of the date
Unix timestamp of the date
Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)
DMY_NUMERIC_SLASH, MDY_NUMERIC_SLASH, YMD_NUMERIC_SLASH, DMY_NUMERIC_DASH_SHORT, DMY_NUMERIC_DASH, YMD_NUMERIC_DASH, MDY_TEXT_DASH_SHORT, MDY_TEXT_SPACE_SHORT, MDY_TEXT_SPACE curl --request GET \
--url https://restapi.sign.plus/v2/envelope/{envelope_id}/annotations/{document_id} \
--header 'Authorization: Bearer <token>'{
"annotations": [
{
"id": "<string>",
"recipient_id": "<string>",
"document_id": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"required": true,
"type": "TEXT",
"signature": {
"id": "<string>"
},
"initials": {
"id": "<string>"
},
"text": {
"size": 123,
"color": 123,
"value": "<string>",
"tooltip": "<string>",
"dynamic_field_name": "<string>",
"font": {
"family": "UNKNOWN",
"italic": true,
"bold": true
}
},
"datetime": {
"size": 123,
"font": {
"family": "UNKNOWN",
"italic": true,
"bold": true
},
"color": "<string>",
"auto_fill": true,
"timezone": "<string>",
"timestamp": 123,
"format": "DMY_NUMERIC_SLASH"
},
"checkbox": {
"checked": true,
"style": "CIRCLE_CHECK"
}
}
]
}