Create Envelope (POST /v2.0/envelopes/create)

Create an envelope with a base64 payload that includes document basic information, placeholder details, and geometric information.

Request Parameters

Request Headers

Header	Value
Authorization	Bearer {access_token}
app_auth_type	jsign-oauth2

Request Body

Field	Type	Required	Description
envelope	JSON Object	Yes	Contains envelope basic detail
envelope.name	String	Yes	Envelope name
envelope.description	String	No	Envelope description
envelope.categories	Array [String]	No	Envelope tags
envelope.signature	String	Yes	Signature type (e.g. "Esignature")
envelope.sign_process_flow	String	No	Signing flow [Sequential, Parallel, Hybrid]
envelope.expiration_days	Integer	No	Number of days after which the document will expire
envelope.email_reminders	Boolean	No	Enable to send automatic reminders
envelope.reminder_period	Integer	No	Send automatic reminders before [n] days of expiration
envelope.append_verification_qr_code	Boolean	No	Append QA code to the document post signing
envelope.remove_signed_document	Boolean	No	Remove document file document post signing
envelope.enforce_signers_location	Boolean	No	Capture GPS location of a signer
envelope.enable_element_tag	Boolean	No	Create document using element_tag
envelope.send_email_to_recipients	Boolean	No	Send signing invitation email to the recipients
document	JSON Object	Yes	Contains each document's basic detail
document.document_ref_no	Integer	Yes	Reference number of each document
document.name	String	Yes	Document name
document.document_base64	String	Yes	File base64
recipients	JSON Object	Yes	Contains signers and observers information
recipients.signers[]	Array	Yes	Signers information along with annotation cordinates
recipients.signers[].name	String	Yes	Signer's fullname
recipients.signers[].email	String	Yes	Signer's email
recipients.signers[].country_code	Integer	Conditional	Signer's country ISD code (without the + symbol). For example, 91.
recipients.signers[].phone_number	String	Conditional	Signer's phone number
recipients.signers[].signing_order	Boolean	No	Signing order [Sequential, Parallel, Hybrid]
recipients.signers[].private_note	String	No	Private message for signers, this will be sent in an email
recipients.signers[].tabs	JSON Object	Yes	Contains information of coordinates for different fields
recipients.signers[].tabs.sign_here_tabs[]	Array	Yes	Contains information of sign annotation coordinates
recipients.signers[].tabs.sign_here_tabs[].x_position	Decimal	Yes	x position of an annotation
recipients.signers[].tabs.sign_here_tabs[].y_position	Decimal	Yes	y position of an annotation
recipients.signers[].tabs.sign_here_tabs[].w_position	Decimal	Yes	Width of an annotation
recipients.signers[].tabs.sign_here_tabs[].h_position	Decimal	Yes	Height of an annotation
recipients.signers[].tabs.sign_here_tabs[].x_position_percentage	Decimal	Yes	X coordinate in percentage
recipients.signers[].tabs.sign_here_tabs[].y_position_percentage	Decimal	Yes	Y coordinate in percentage
recipients.signers[].tabs.sign_here_tabs[].w_position_percentage	Decimal	Yes	Width in percentage
recipients.signers[].tabs.sign_here_tabs[].h_position_percentage	Decimal	Yes	Height in percentage
recipients.signers[].tabs.sign_here_tabs[].page_number	Array [Integer]	Yes	Page number
recipients.signers[].tabs.sign_here_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.sign_here_tabs[].apply_to_all_pages	Boolean	No	Apply this annotation on all the pages
recipients.signers[].tabs.sign_here_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.initial_tabs[]	JSON Array	No	Contains information of initial field coordinates
recipients.signers[].tabs.initial_tabs[].x_position	Decimal	Conditional	x position of an initial field
recipients.signers[].tabs.initial_tabs[].y_position	Decimal	Conditional	y position of an initial field
recipients.signers[].tabs.initial_tabs[].w_position	Decimal	Conditional	w position in an initial field
recipients.signers[].tabs.initial_tabs[].x_position_percentage	Decimal	Conditional	X coordinate in an initial field
recipients.signers[].tabs.initial_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate in an initial field
recipients.signers[].tabs.initial_tabs[].w_position_percentage	Decimal	Conditional	Width in percentage
recipients.signers[].tabs.initial_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.initial_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.initial_tabs[].apply_to_all_pages	Boolean	Conditional	Apply this annotation on all the pages
recipients.signers[].tabs.initial_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.name_tabs[]	JSON Array	No	Contains information of signer name field coordinates
recipients.signers[].tabs.name_tabs[].x_position	Decimal	Conditional	x position of a signer name field
recipients.signers[].tabs.name_tabs[].y_position	Decimal	Conditional	y position of a signer name field
recipients.signers[].tabs.name_tabs[].w_position	Decimal	Conditional	w position of a signer name field
recipients.signers[].tabs.name_tabs[].x_position_percentage	Decimal	Conditional	X coordinate in signer name field
recipients.signers[].tabs.name_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate in signer name field
recipients.signers[].tabs.name_tabs[].w_position_percentage	Decimal	Conditional	Width in percentage
recipients.signers[].tabs.name_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.name_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.name_tabs[].apply_to_all_pages	Boolean	Conditional	Apply this annotation on all the pages
recipients.signers[].tabs.name_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.sign_date_tabs[]	JSON Array	No	Contains information of signing date field coordinates
recipients.signers[].tabs.sign_date_tabs[].x_position	Decimal	Conditional	x position of a signing date field
recipients.signers[].tabs.sign_date_tabs[].y_position	Decimal	Conditional	y position of a signing date field
recipients.signers[].tabs.sign_date_tabs[].w_position	Decimal	Conditional	w position of a signing date field
recipients.signers[].tabs.sign_date_tabs[].x_position_percentage	Decimal	Conditional	X coordinate in signing date field
recipients.signers[].tabs.sign_date_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate in signing date field
recipients.signers[].tabs.sign_date_tabs[].w_position_percentage	Decimal	Conditional	Width in percentage
recipients.signers[].tabs.sign_date_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.sign_date_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.sign_date_tabs[].apply_to_all_pages	Boolean	Conditional	Apply this annotation on all the pages
recipients.signers[].tabs.sign_date_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.text_tabs[]	JSON Array	No	Contains information of signing date field coordinates
recipients.signers[].tabs.text_tabs[].x_position	Decimal	Conditional	X position of a signing date field
recipients.signers[].tabs.text_tabs[].y_position	Decimal	Conditional	Y position of a signing date field
recipients.signers[].tabs.text_tabs[].w_position	Decimal	Conditional	Width in position points
recipients.signers[].tabs.text_tabs[].h_position	Decimal	Conditional	Height in position points
recipients.signers[].tabs.text_tabs[].x_position_percentage	Decimal	Conditional	X coordinate of a signing date field
recipients.signers[].tabs.text_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate of a signing date field
recipients.signers[].tabs.text_tabs[].w_position_percentage	Decimal	Conditional	Width in percentage
recipients.signers[].tabs.text_tabs[].h_position_percentage	Decimal	Conditional	Height in percentage
recipients.signers[].tabs.text_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.text_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.text_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.text_tabs[].required	Boolean	No	Make the text field mandatory for a signer
recipients.signers[].tabs.text_tabs[].text_property	JSON Object	Conditional	Textbox field properties
recipients.signers[].tabs.text_tabs[].text_property.alignment	String	Conditional	Textbox field value alignment (top, middle, bottom)
recipients.signers[].tabs.text_tabs[].text_property.placeholder	String	Conditional	Textbox field placeholder
recipients.signers[].tabs.text_tabs[].text_property.char_limit	Integer	Conditional	Textbox field allowed character limit
recipients.signers[].tabs.text_tabs[].text_property.char_limit_type	String	Conditional	Textbox field allowed character limit type (max, min, exact)
recipients.signers[].tabs.text_tabs[].text_property.validation_type	String	Conditional	Textbox field allowed value type (none, numberOnly, alphabetOnly)
recipients.signers[].tabs.custom_date_tabs[]	JSON Array	No	Contains information of custom date field coordinates
recipients.signers[].tabs.custom_date_tabs[].x_position	Decimal	Conditional	X position of a custom date field
recipients.signers[].tabs.custom_date_tabs[].y_position	Decimal	Conditional	Y position of a custom date field
recipients.signers[].tabs.custom_date_tabs[].w_position	Decimal	Conditional	W position of a custom date field
recipients.signers[].tabs.custom_date_tabs[].x_position_percentage	Decimal	Conditional	X coordinate percentage of a custom date field
recipients.signers[].tabs.custom_date_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate percentage of a custom date field
recipients.signers[].tabs.custom_date_tabs[].w_position_percentage	Decimal	Conditional	W coordinate percentage of a custom date field
recipients.signers[].tabs.custom_date_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.custom_date_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.custom_date_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.custom_date_tabs[].required	Boolean	No	Make the custom date field mandatory for a signer
recipients.signers[].tabs.custom_date_tabs[].date_property	JSON Object	No	Custom date properties
recipients.signers[].tabs.custom_date_tabs[].date_property.placeholder	String	Conditional	Custom date field placeholder
recipients.signers[].tabs.checkbox_tabs	JSON Object	Conditional	Check box JSON Object
recipients.signers[].tabs.checkbox_tabs.groups[]	JSON Array	Conditional	Chec kbox group array
recipients.signers[].tabs.checkbox_tabs.groups[].group	String	Conditional	Group name
recipients.signers[].tabs.checkbox_tabs.groups[].validation_type	String	Conditional	Validation for the group
recipients.signers[].tabs.checkbox_tabs.checkboxes[]	JSON Array	Conditional	Check box array
recipients.signers[].tabs.checkbox_tabs.checkboxes[].x_position	Decimal	Conditional	X position of check box
recipients.signers[].tabs.checkbox_tabs.checkboxes[].y_position	Decimal	Conditional	Y position of check box
recipients.signers[].tabs.checkbox_tabs.checkboxes[].x_position_percentage	Decimal	Conditional	X coordinate percentage of check box
recipients.signers[].tabs.checkbox_tabs.checkboxes[].y_position_percentage	Decimal	Conditional	Y coordinate percentage of check box
recipients.signers[].tabs.checkbox_tabs.checkboxes[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.checkbox_tabs.checkboxes[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.checkbox_tabs.checkboxes[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.checkbox_tabs.checkboxes[].placeholder	String	No	Check box placeholder
recipients.signers[].tabs.checkbox_tabs.checkboxes[].group	String	No	Check box group
recipients.signers[].tabs.dropdown_tabs[]	JSON Array	Conditional	Dropdown JSON Array
recipients.signers[].tabs.dropdown_tabs[].x_position	Decimal	Conditional	X position of dropdown
recipients.signers[].tabs.dropdown_tabs[].y_position	Decimal	Conditional	Y position of dropdown
recipients.signers[].tabs.dropdown_tabs[].w_position	Decimal	Conditional	W position of dropdown
recipients.signers[].tabs.dropdown_tabs[].x_position_percentage	Decimal	Conditional	X coordinate percentage of dropdown
recipients.signers[].tabs.dropdown_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate percentage of dropdown
recipients.signers[].tabs.dropdown_tabs[].w_position_percentage	Decimal	Conditional	W coordinate percentage of dropdown
recipients.signers[].tabs.dropdown_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.dropdown_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.dropdown_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.dropdown_tabs[].dropdown_property	JSON Object	Conditional	Dropdown property JSON object
recipients.signers[].tabs.dropdown_tabs[].dropdown_property.alignment	String	No	Dropdown alignment
recipients.signers[].tabs.dropdown_tabs[].dropdown_property.placeholder	String	No	Dropdown placeholder
recipients.signers[].tabs.dropdown_tabs[].dropdown_property.options[]	String Array	Conditional	Dropdown option
recipients.signers[].tabs.dropdown_tabs[].dropdown_property.default_option	String	No	Dropdown default option to be selected
recipients.signers[].tabs.image_tabs[]	JSON Array	Conditional	Image JSON Array
recipients.signers[].tabs.image_tabs[].x_position	Decimal	Conditional	X position of an image
recipients.signers[].tabs.image_tabs[].y_position	Decimal	Conditional	Y position of an image
recipients.signers[].tabs.image_tabs[].w_position	Decimal	Conditional	W position of an image
recipients.signers[].tabs.image_tabs[].h_position	Decimal	Conditional	H position of an image
recipients.signers[].tabs.image_tabs[].x_position_percentage	Decimal	Conditional	X coordinate percentage of image
recipients.signers[].tabs.image_tabs[].y_position_percentage	Decimal	Conditional	Y coordinate percentage of image
recipients.signers[].tabs.image_tabs[].w_position_percentage	Decimal	Conditional	W coordinate percentage of image
recipients.signers[].tabs.image_tabs[].h_position_percentage	Decimal	Conditional	H coordinate percentage of image
recipients.signers[].tabs.image_tabs[].page_number	Array [Integer]	Conditional	Page number
recipients.signers[].tabs.image_tabs[].document_ref_no	Integer	Yes	Reference number of individual document
recipients.signers[].tabs.image_tabs[].element_tag_string	String	Conditional	Element tag string to generate annotation
recipients.signers[].tabs.image_tabs[].required	Boolean	Conditional	Make the image field mandatory for signer
recipients.signers[].tabs.image_tabs[].image_property	JSON Object	Conditional	Image property JSON object
recipients.signers[].tabs.image_tabs[].image_property.placeholder	String	No	Image placeholder
recipients.observers[]	JSON Array	No	Signers information along with annotation coordinates
recipients.observers[].name	String	Conditional	Observer's full name
recipients.observers[].email	String	Conditional	Observer's email

Response Parameters

Response Body Message Field

Field	Value
message	The returned message

Response Body Data Fields

Field	Always Preset	Notes
envelope_id	Yes	ID of the created envelope

Sample Success Response - Fixed Position

REQUEST:
curl --location --request POST '/api/v2.0/envelopes/create' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Content-Type: application/json' \
--data-raw '{
"envelope": {
"name": "Sample Envelope",
"description": "This is a test description",
"categories": [
"New Envelope",
"NDA"
],
"signature": "Esignature",
"sign_process_flow": "Parallel",
"expiration_days": 4,
"email_reminders": true,
"reminder_period": 2,
"append_verification_qr_code": false,
"remove_singed_document": false,
"enforce_signers_location": false,
"enable_element_tag": false,
"send_email_to_recipients": true
},
"documents": [
{
"name": "Sample Document.pdf",
"document_base64": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvU[...]
"document_ref_no": 1
},
{
"name": "Test Document.pdf",
"document_base64": "JVBERi0xLjUKJafj8fEKMiAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUG[...]
"document_ref_no": 2
}
],
"recipients": {
"signers": [
{
"name": "Jon Smith",
"email": "[email protected]",
"signing_order": 1,
"country_code": 91,
"phone_number": "9000000000",
"private_note": "Please sign as soon as you receive the document",
"tabs": {
"sign_here_tabs": [
{
"x_position": 15,
"y_position": 15,
"w_position": 77.07,
"h_position": 46.28,
"x_position_percentage": 2,
"y_position_percentage": 1,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 15,
"w_position": 77.07,
"h_position": 46.28,
"x_position_percentage": 2,
"y_position_percentage": 1,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 2
}
],
"initial_tabs": [
{
"x_position": 15,
"y_position": 70,
"w_position": 77.07,
"x_position_percentage": 2,
"y_position_percentage": 8,
"w_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 70,
"w_position": 77.07,
"x_position_percentage": 2,
"y_position_percentage": 8,
"w_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 2
}
],
"name_tabs": [
{
"x_position": 15,
"y_position": 120,
"w_position": 127.07,
"x_position_percentage": 2,
"y_position_percentage": 15,
"w_position_percentage": 20,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 120,
"w_position": 127.07,
"x_position_percentage": 2,
"y_position_percentage": 15,
"w_position_percentage": 20,
"page_number": [
1
],
"document_ref_no": 2
}
],
"sign_date_tabs": [
{
"x_position": 15,
"y_position": 200,
"w_position": 107.07,
"x_position_percentage": 2,
"y_position_percentage": 25,
"w_position_percentage": 17,
"page_number": [
1
],
"document_ref_no": 1
},
{
"x_position": 15,
"y_position": 120,
"w_position": 107.07,
"x_position_percentage": 2,
"y_position_percentage": 25,
"w_position_percentage": 17,
"page_number": [
1
],
"document_ref_no": 2
}
],
"text_tabs": [
{
"x_position": 15,
"y_position": 250,
"w_position": 77.07,
"h_position": 46.24,
"x_position_percentage": 2,
"y_position_percentage": 31,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"text_property": {
"alignment": "Bottom",
"placeholder": "textbox 1",
"char_limit": 100,
"char_limit_type": "max",
"validation_type": "none"
}
},
{
"x_position": 15,
"y_position": 250,
"w_position": 77.07,
"h_position": 46.24,
"x_position_percentage": 2,
"y_position_percentage": 31,
"w_position_percentage": 12,
"h_position_percentage": 5,
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"text_property": {
"alignment": "Bottom",
"placeholder": "textbox 1",
"char_limit": 100,
"char_limit_type": "max",
"validation_type": "none"
}
}
],
"custom_date_tabs": [
{
"x_position": 15,
"y_position": 300,
"w_position": 177.07,
"x_position_percentage": 2,
"y_position_percentage": 37,
"w_position_percentage": 28,
"page_number": [
1
],
"document_ref_no": 1,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
},
{
"x_position": 15,
"y_position": 300,
"w_position": 177.07,
"x_position_percentage": 2,
"y_position_percentage": 37,
"w_position_percentage": 28,
"page_number": [
1
],
"document_ref_no": 2,
"required": false,
"date_property": {
"placeholder": "textbox 1"
}
},
{
"checkbox_tabs": {
"groups": [
{
"group": "Group 1",
"validation_type": "none"
}
],
"checkboxes": [
{
"x_position": 15,
"y_position": 350,
"x_position_percentage": 2,
"y_position_percentage": 44,
"page_number": [
1
],
"document_ref_no": 1,
"placeholder": "Checkbox 1",
"group": "Group 1"
}
]
},
"dropdown_tabs": [
{
"x_position": 15,
"y_position": 400,
"w_position": 130.26,
"x_position_percentage": 2,
"y_position_percentage": 50,
"w_position_percentage": 21,
"page_number": [
1
],
"document_ref_no": 1,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1"
"options": [
"option 1",
"option 2",
"option 3",
],
"default_option": "option 2"
}
},
{
"x_position": 15,
"y_position": 400,
"w_position": 130.26,
"x_position_percentage": 2,
"y_position_percentage": 50,
"w_position_percentage": 21,
"page_number": [
1
],
"document_ref_no": 2,
"dropdown_property": {
"alignment": "bottom",
"placeholder": "Dropdown 1"
"options": [
"option 1",
"option 2",
"option 3",
],
"default_option": "option 2"
}
}
],
"image_tabs": [
{
"x_position": 15,
"y_position": 500,
"w_position": 100,
"h_position": 100,
"x_position_percentage": 2,
"y_position_percentage": 63,
"w_position_percentage": 16,
"h_position_percentage": 12,
"page_number": [
1
],
"document_ref_no": 1
},
"required": false,
"image_property": {
"placeholder": "Image 1"
}
}
]
}
}
],
"observers": [
{
"name": "Neal Davis",
"email": "[email protected]"
}
]
}
}'

RESPONSE:
{
"message": "Envelope created successfully",
"data": {
"envelope_id": "06cd321e-cee6-45b1-9665-0a0e091342e3"
}
}

Sample Success Response - Element Position

Sample Error Response

Note: View the full list of applicable error code for this method here.

Return to the top of this page.