Document
Endpoints
The Document object
Attributes
-
id stringUnique identifier for the object.
-
user_id stringUnique identifier of the document owner.
-
document_name stringThe name of the document.
-
page_count stringThe number of pages in the document.
-
created stringUnix timestamp for when the document was created.
-
updated stringUnix timestamp for when the document was updated.
-
original_filename stringThe original name of the document upon uploading to signNow.
-
origin_document_id stringThe document ID if redirected from another source.
-
owner stringOwner’s account email address
-
template booleanWhether this document is a template: true - yes, it is a template; false - no, it isn’t.
-
signatures array[object]Signature objects on the document: one signature - one object.
-
fields array[object]
-
roles array[object]Signer roles. Every field must be assigned to a role. One signer - one role.
-
tags array[object]Text tags that represent fillable fields in the document. Learn more in Text tags
-
seals array[object]Seal objects in the document.
-
texts array[object]Contents of the fillable fields.
-
field_invites array[object]Invites to sign this document. Learn more in Invite
More attributes
- thumbnail array[string]
- inserts array[object]
- checks array[object]
- requests array[object]
- notary_invites array[object]
- attachments array[object]
- version_time string
- enumeration_options array[object]
- routing_details array[object]
- integrations array[object]
- hyperlinks array[object]
- radiobuttons array[object]
- document_group_template_info array[string]
- originator_organization_settings array[object]
- document_group_info array[string]
- settings array[booleans]
- parent_id string
- originator_logo string
- pages array[object]
The Document object
"id": "a09b26feeba7ce70228afe6290f4445700b6f349",
"user_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae",
"document_name": "pdf-test",
"page_count": "1",
"created": "1565787561",
"updated": "1565858757",
"original_filename": "pdf-test.pdf",
"origin_document_id": null,
"owner": "api@signnow.com",
"template": false,
"thumbnail": {
"small": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=small",
"medium": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=medium",
"large": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large"
},
"signatures": [
{
"id": "2600e6cfbe65cfeb5624749fbe75b432c392c128",
"user_id": "e9f673c1bc43f95d611295a7aa3ec425e433715f",
"email": "guest_signer_585873482916@no.reply",
"page_number": "0",
"width": "56",
"height": "21",
"x": "70",
"y": "362",
"created": "1565858757",
"data": "iVBORw0KGgoAAAANSUhEUgAAApoAAAD8CAYAAADXPgSRAAAgAElEQVR4Xu2dB9QsRZmG3zVHQETFHGANYM7ZVRcVc0YFw5pzjgiKETFn1hzWnBVzdk2romJERVCCoII5Yd7z7K1Z5vbt7qme6equ7nq/c/5zw99dXfVUzcw7VV/4F9lMwARMwARMwARMwARMIAGBf0nQpps0ARMwARMwARMwARMwAVloehGYgAmYgAmYgAmYgAkkIWChmQSrGzUBEzABEzABEzABE7DQ9BowARMwARMwARMwARNIQsBCMwlWN2oCJmACJmACJmACJmCh6TVgAiZgAiZgAiZgAiaQhICFZhKsbtQETMAETMAETMAETMBC02vABEzABEzABEzABEwgCQELzSRY3agJmIAJ"
}
],
"seals": [],
"texts": [],
"checks": [],
"inserts": [],
"tags": [
{
"type": "system",
"name": "fields"
}
],
"fields": [
{
"id": "d88e08ddbc12ee20f6830750787f8314f38938b4",
"type": "signature",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"json_attributes": {
"page_number": 0,
"x": 70,
"y": 362,
"width": 83,
"height": 21,
"required": true,
"name": "Signature_1"
},
"role": "Signer 1",
"originator": "api@signnow.com",
"fulfiller": "guest_signer_585873482916@no.reply",
"field_request_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c",
"element_id": "2600e6cfbe65cfeb5624749fbe75b432c392c128",
"field_request_canceled": null,
"template_field_id": null,
"field_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c"
}
],
"requests": [],
"notary_invites": [],
"roles": [
{
"unique_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"signing_order": "1",
"name": "Signer 1"
}
],
"field_invites": [
{
"id": "372cf980e486bd977da68f7ea31da0f05dd01139",
"status": "fulfilled",
"is_document_locked": "0",
"password_protected": "0",
"password_type": "",
"password_method": "",
"reassign": "0",
"pfrid": null,
"pfrtype": null,
"pfrmerchant_id": null,
"pfrstatus": null,
"pframount": null,
"pfrpayment_transaction_id": null,
"pfrcreated": null,
"pfrmerchant_type": null,
"pfrmerchant_account_name": null,
"pfrcurrency_name": null,
"pfrjson_attributes": null,
"id_verification_required": "NO",
"id_verified": "UNVERIFIED",
"created": "1565858734",
"email": "guest_signer_585873482916@no.reply",
"role": "Signer 1",
"reminder": "0",
"updated": "1565858757",
"expiration_time": "1568450734",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"electronic_consent_id": null,
"stripe_ach_bank_account_verified": "0",
"stripe_ach_bank_account_present": "0",
"redirect_uri": null,
"declined": [],
"prefill_signature_name": null,
"force_new_signature": null,
"signing_instructions": null,
"required_preset_signature_name": null,
"decline_by_signature": null,
"electronic_consent_required": 0,
"payment_request": null
}
],
"version_time": "1565858757",
"enumeration_options": [],
"attachments": [],
"routing_details": [
{
"id": "983f2a230a808d9a7d92fd15ae2902d21441762a",
"data": [
{
"default_email": "",
"inviter_role": false,
"name": "Signer 1",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"signing_order": 1
}
],
"created": "1565858709",
"updated": null,
"cc": [],
"cc_step": [],
"invite_link_instructions": null
}
],
"integrations": [],
"hyperlinks": [],
"radiobuttons": [],
"document_group_template_info": [],
"originator_organization_settings": [
{
"setting": "invite_completion_redirect_url",
"value": "https://facebook.com"
},
{
"setting": "invite_decline_redirect_url",
"value": ""
},
{
"setting": "required_preset_signature_name",
"value": "0"
},
{
"setting": "require_email_subject",
"value": "0"
},
{
"setting": "require_login_for_signing",
"value": "0"
},
{
"setting": "logout_on_signing",
"value": "0"
},
{
"setting": "front_end_session_length",
"value": "0"
},
{
"setting": "add_signature_stamp_with_name",
"value": "0"
},
{
"setting": "cfr_title_21_part_11",
"value": "0"
},
{
"setting": "require_authentication_for_invites",
"value": "0"
},
{
"setting": "document_guide",
"value": "1"
},
{
"setting": "block_export_options_when_credit_card_validation_is_used",
"value": "no"
}
],
"document_group_info": {
"document_group_id": null,
"document_group_name": null,
"invite_id": null,
"invite_status": null,
"doc_count_in_group": 0
},
"settings": {
"no_document_attachment": false,
"copy_export": false,
"no_document_file_attachments": false,
"no_user_signature_return": false,
"mobileweb_option": false,
"require_drawn_signatures": false,
"org_allowed_team_admins": false,
"cloud_auto_export": false,
"digitally_sign_dowloaded_docs": false,
"invite_completion_redirect_url": false,
"invite_decline_redirect_url": false,
"add_signature_stamp": false,
"pending_invite_document_view_notification": false,
"signing_link_document_download": false,
"required_preset_signature_name": false,
"cloud_export_with_history": false,
"emailed_docs_include_history": false,
"require_email_subject": false,
"document_completion_retention_days": false,
"enable_hyperlink_protection": false,
"enable_advanced_threat_protection": false,
"require_login_for_signing": false,
"logout_on_signing": false,
"audit_trail_completion_retention_days": false,
"front_end_session_length": false,
"email_admin_on_banned_login": false,
"add_signature_stamp_with_name": false,
"cfr_title_21_part_11": false,
"unsuccessful_logout_attempts_allowed": false,
"require_authentication_for_invites": false,
"electronic_consent_required": false,
"electronic_consent_text": false,
"document_guide": false,
"watermark_downloaded_document": false,
"restrict_download": false,
"disable_email_notifications": false,
"upload_limit": false,
"document_schema_extended": false,
"invite_update_notifications_for_all_invites_at_invite_create": false,
"enable_full_story_tracker": false,
"document_attachment_only_for_signer": false,
"sso-only-login": false,
"block_export_options_when_credit_card_validation_is_used": false,
"only_administrator_is_able_to_invite_to_the_team": false,
"block_login_via_social_networks": false },
"parent_id": "c8fdb570bddbefab469a30a8cb4de4d96851cce3",
"originator_logo": "",
"pages": [
{
"src": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large&page=0",
"size": {
"width": 612,
"height": 792
}
}
]
}
Get document
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
GET /document
curl
-X GET
\
https://api-eval.signnow.com/document/{{document_id}}
\
-H
'Authorization:
Bearer {{access_document}}'
Response
{
"id": "a09b26feeba7ce70228afe6290f4445700b6f349",
"user_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae",
"document_name": "pdf-test",
"page_count": "1",
"created": "1565787561",
"updated": "1565858757",
"original_filename": "pdf-test.pdf",
"origin_document_id": null,
"owner": "api@signnow.com",
"template": false,
"thumbnail": {
"small": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=small",
"medium": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=medium",
"large": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large"
},
"signatures": [
{
"id": "2600e6cfbe65cfeb5624749fbe75b432c392c128",
"user_id": "e9f673c1bc43f95d611295a7aa3ec425e433715f",
"email": "guest_signer_585873482916@no.reply",
"page_number": "0",
"width": "56",
"height": "21",
"x": "70",
"y": "362",
"created": "1565858757",
"data": "iVBORw0KGgoAAAANSUhEUgAAApoAAAD8CAYAAADXPgSRAAAgAElEQVR4Xu2dB9QsRZmG3zVHQETFHGANYM7ZVRcVc0YFw5pzjgiKETFn1hzWnBVzdk2romJERVCCoII5Yd7z7K1Z5vbt7qme6equ7nq/c/5zw99dXfVUzcw7VV/4F9lMwARMwARMwARMwARMIAGBf0nQpps0ARMwARMwARMwARMwAVloehGYgAmYgAmYgAmYgAkkIWChmQSrGzUBEzABEzABEzABE7DQ9BowARMwARMwARMwARNIQsBCMwlWN2oCJmACJmACJmACJmCh6TVgAiZgAiZgAiZgAiaQhICFZhKsbtQETMAETMAETMAETMBC02vABEzABEzABEzABEwgCQELzSRY3agJmIAJ"
}
],
"seals": [],
"texts": [],
"checks": [],
"inserts": [],
"tags": [
{
"type": "system",
"name": "fields"
}
],
"fields": [
{
"id": "d88e08ddbc12ee20f6830750787f8314f38938b4",
"type": "signature",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"json_attributes": {
"page_number": 0,
"x": 70,
"y": 362,
"width": 83,
"height": 21,
"required": true,
"name": "Signature_1"
},
"role": "Signer 1",
"originator": "api@signnow.com",
"fulfiller": "guest_signer_585873482916@no.reply",
"field_request_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c",
"element_id": "2600e6cfbe65cfeb5624749fbe75b432c392c128",
"field_request_canceled": null,
"template_field_id": null,
"field_id": "c23790a9ad6a7cbc586f6b8d8a0c1f360097047c"
}
],
"requests": [],
"notary_invites": [],
"roles": [
{
"unique_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"signing_order": "1",
"name": "Signer 1"
}
],
"field_invites": [
{
"id": "372cf980e486bd977da68f7ea31da0f05dd01139",
"status": "fulfilled",
"is_document_locked": "0",
"password_protected": "0",
"password_type": "",
"password_method": "",
"reassign": "0",
"pfrid": null,
"pfrtype": null,
"pfrmerchant_id": null,
"pfrstatus": null,
"pframount": null,
"pfrpayment_transaction_id": null,
"pfrcreated": null,
"pfrmerchant_type": null,
"pfrmerchant_account_name": null,
"pfrcurrency_name": null,
"pfrjson_attributes": null,
"id_verification_required": "NO",
"id_verified": "UNVERIFIED",
"created": "1565858734",
"email": "guest_signer_585873482916@no.reply",
"role": "Signer 1",
"reminder": "0",
"updated": "1565858757",
"expiration_time": "1568450734",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"electronic_consent_id": null,
"stripe_ach_bank_account_verified": "0",
"stripe_ach_bank_account_present": "0",
"redirect_uri": null,
"declined": [],
"prefill_signature_name": null,
"force_new_signature": null,
"signing_instructions": null,
"required_preset_signature_name": null,
"decline_by_signature": null,
"electronic_consent_required": 0,
"payment_request": null
}
],
"version_time": "1565858757",
"enumeration_options": [],
"attachments": [],
"routing_details": [
{
"id": "983f2a230a808d9a7d92fd15ae2902d21441762a",
"data": [
{
"default_email": "",
"inviter_role": false,
"name": "Signer 1",
"role_id": "4882e98672db1bbe55ccdef31cf43d24cf1917ca",
"signing_order": 1
}
],
"created": "1565858709",
"updated": null,
"cc": [],
"cc_step": [],
"invite_link_instructions": null
}
],
"integrations": [],
"hyperlinks": [],
"radiobuttons": [],
"document_group_template_info": [],
"originator_organization_settings": [
{
"setting": "invite_completion_redirect_url",
"value": "https://facebook.com"
},
{
"setting": "invite_decline_redirect_url",
"value": ""
},
{
"setting": "required_preset_signature_name",
"value": "0"
},
{
"setting": "require_email_subject",
"value": "0"
},
{
"setting": "require_login_for_signing",
"value": "0"
},
{
"setting": "logout_on_signing",
"value": "0"
},
{
"setting": "front_end_session_length",
"value": "0"
},
{
"setting": "add_signature_stamp_with_name",
"value": "0"
},
{
"setting": "cfr_title_21_part_11",
"value": "0"
},
{
"setting": "require_authentication_for_invites",
"value": "0"
},
{
"setting": "document_guide",
"value": "1"
},
{
"setting": "block_export_options_when_credit_card_validation_is_used",
"value": "no"
}
],
"document_group_info": {
"document_group_id": null,
"document_group_name": null,
"invite_id": null,
"invite_status": null,
"doc_count_in_group": 0
},
"settings": {
"no_document_attachment": false,
"copy_export": false,
"no_document_file_attachments": false,
"no_user_signature_return": false,
"mobileweb_option": false,
"require_drawn_signatures": false,
"org_allowed_team_admins": false,
"cloud_auto_export": false,
"digitally_sign_dowloaded_docs": false,
"invite_completion_redirect_url": false,
"invite_decline_redirect_url": false,
"add_signature_stamp": false,
"pending_invite_document_view_notification": false,
"signing_link_document_download": false,
"required_preset_signature_name": false,
"cloud_export_with_history": false,
"emailed_docs_include_history": false,
"require_email_subject": false,
"document_completion_retention_days": false,
"enable_hyperlink_protection": false,
"enable_advanced_threat_protection": false,
"require_login_for_signing": false,
"logout_on_signing": false,
"audit_trail_completion_retention_days": false,
"front_end_session_length": false,
"email_admin_on_banned_login": false,
"add_signature_stamp_with_name": false,
"cfr_title_21_part_11": false,
"unsuccessful_logout_attempts_allowed": false,
"require_authentication_for_invites": false,
"electronic_consent_required": false,
"electronic_consent_text": false,
"document_guide": false,
"watermark_downloaded_document": false,
"restrict_download": false,
"disable_email_notifications": false,
"upload_limit": false,
"document_schema_extended": false,
"invite_update_notifications_for_all_invites_at_invite_create": false,
"enable_full_story_tracker": false,
"document_attachment_only_for_signer": false,
"sso-only-login": false,
"block_export_options_when_credit_card_validation_is_used": false,
"only_administrator_is_able_to_invite_to_the_team": false,
"block_login_via_social_networks": false },
"parent_id": "c8fdb570bddbefab469a30a8cb4de4d96851cce3",
"originator_logo": "",
"pages": [
{
"src": "https://api.signnow.com/document/a09b26feeba7ce70228afe6290f4445700b6f349/thumbnail?size=large&page=0",
"size": {
"width": 612,
"height": 792
}
}
]
Edit document
Updates a document by adding/overwriting fields or elements (texts, checks, signatures, hyperlinks, attachments).
Fields - spaces in the document designated for signing and editing (filling in) by the recipient. There are different types of fields for different kinds of input: Signature Field, Text Field, Date Field, Formula Field etc.
Users can add or remove fields in the document and assign them to a particular signer. Fields can be marked required. In that case signers wouldn’t be able to send their signed copies without filling in those fields.
Every field is an object that contains field properties: ID, role, label, name etc.
Field properties: field ID, its type, the role it’s been assigned to, x/y coordinates in the document, field width and height, its label, prefilled text, and the custom defined options.
Field properties are described in a fields array.
Content of a field can be found in texts, signatures, or checks arrays (“checks” for checkboxes) based on the type of data that’s been filled in. You can retrieve all the values from Text, Dropdown, Calculated, Hyperlink, or Date fields from the texts array.
Each field has its own ID. You can find it as element_id parameter in the fields array.
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
PUT /document
curl
-X PUT
\
https://api-eval.signnow.com/document/{{document_id}}
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
application/json'
\
-d
'{
"fields":
[
{
"x":
305,
"y":
18,
"width":
122,
"height":
10,
"page_number":
0,
"label":
"first_name",
"role":
"Signer 1",
"required":
true,
"type":
"text",
"prefilled_text":
"John"
},
{
"x":
305,
"y":
38,
"width":
122,
"height":
10,
"page_number":
0,
"label":
"last_name",
"role":
"Signer 1",
"required":
true,
"type":
"text",
"prefilled_text":
"Doe"
},
{
"x":
305,
"y":
67,
"width":
100,
"height":
34,
"page_number":
0,
"label":
"a sample label",
"role":
"Signer 1",
"required":
true,
"type":
"signature"
}
]
}'
Response
{
"id": "3db38d8c1fdfca762b25d57d82b3cf327a65485e"
}
Prefill text fields
Adds values to fields that the Signers can later edit when they receive the document for signature. Works only with Text field types.
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
fields requiredThe array that contains field objects to add values to. Each field object is identified by the field_name.
-
field_name requiredThe unique field name that identifies the field. Can be found in the name parameter of the field in response from GET /document/{{document_id}}
-
prefilled_text requiredThe value that should appear on the document.
Returns
PUT /v2/documents/{{document_id}}/prefill-texts
curl
-X PUT
\
https://api-eval.signnow.com/v2/documents/{{document_id}}/prefill-texts
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
application/json'
\
-d
'{
"fields":
[
{
"field_name":
"first_name",
"prefilled_text":
"Jane",
},
{
"field_name":
"last_name",
"prefilled_text":
"Mitchell",
}
]
}'
Response
Status: 204 No Content
Delete document
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
DELETE /document
curl
-X DELETE
\
'https://api.signnow.com/document/{{document_id}}'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"status": "success"
}
Upload document
Uploads a file to user’s account and returns unique id of the uploaded document. Accepts .doc, .docx, .pdf, .xls, .xlsx, .ppt, .pptx and .png file types.
File size limits
Maximum file size per upload is 50 Mb.
Parameters
-
file requiredString parameter: @path/to/your/file.pdf
Returns
POST /document
curl
-X POST
\
https://api-eval.signnow.com/document
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
multipart/form-data'
\
-F
'file=
@/path/to/your/document/pdf-test.pdf'
\
-F
'folder_id=
"{{unique_folder_id}}" '
Response
{
"id": "9c95ef588b109c988595018543aec8885390a5c8"
}
Upload document with tags
Parameters
-
file requiredString parameter: @path/to/your/file.pdf
-
tag_name requiredThe text tag name mentioned in the file.
-
role requiredWhich role the field under the text tag is assigned to.
-
label optionalHint for the signer inside a fillable field about the field type, e.g. first_name or text_1; once the field is filled in, the value automatically appears in all the fields with the same label.
-
required requiredBoolean: Whether the field is mandatory to fill in, e.g. true/false.
-
type requiredType of the field. Could be “text”, “signature”, “initials”, “checkbox”, “attachment”, "radio button group", or “enumeration”
-
prefilled_text optionalEditable text that appears in the field when the signer opens the document, e.g. Lucy
-
lsd optionalBoolean: Lock the signing date. Means whether to set the current date as a signing date when the recipient signs the document. Possible values: y - set, n - no setting
-
validator_id optionalData validation format for a field. Check for available formats in Data Validators.
-
width optionalHow many pixels wide the field is.
-
height optionalHow many pixels high the field is.
-
parse_type optionalDefines how to parse the document that contains Adobe form fields and Text tags. Possible values:default - if the document contains Adobe form fields, only these fields will be parsed. If there are no Adobe form fields, Text tags will be parsed; all - both Adobe form fields and Text tags will be parsed; adobe - only Adobe form fields will be parsed; tag - only Text tags will be parsed.
Returns
POST /document/fieldextract
curl
-X POST
\
https://api-eval.signnow.com/document/fieldextract
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
multipart/form-data'
\
-F
'file=
@/path/to/your/document/pdf-test.pdf'
\
-F
'Tags=
[
{
"tag_name":
"tag1"
,
"role":
"Signer 1"
,
"label":
"date"
,
"name":
"Test date tag"
,
"required":
"true"
,
"lock_to_sign_date":
"true"
,
"type":
"text"
,
"height":
15
,
"width":
100
,
"validator_id":
"059b068ef8ee5cc27e09ba79af58f9e805b7c2b3"
},
{
"tag_name":
"tag2"
,
"role":
"Signer 1"
,
"label":
"Your signature"
,
"name":
"Test signature tag"
,
"required":
"true"
,
"type":
"signature"
,
"height":
15
,
"width":
100
}
]'
Response
{
"id": "3db38d8c1fdfca762b25d57d82b3cf327a65485e"
}
Download document
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
type requiredPath parameter: Can be "collapsed", "zip" or "certificate". Collapsed returns the raw data of a PDF document that can be written into a blank .pdf file. Zip returns the raw data of a zip file containing the PDF and any attachments that can be written to a blank .zip file. Certificate returns a PDF document with document ID on every page.
-
?with_history optionalQuery parameter: downloads a collapsed document with a table containing document history.
-
?base64 optionalQuery parameter: downloads a PDF document encoded in base64. Available values: true, false
-
?client_timestamp optionalQuery parameter: downloads a PDF document with a client timestamp. Available values: 1, 0
Returns
GET /document/{{document_id}}/download
curl
-X GET
\
https://api-eval.signnow.com/document/{{document_id}}/download?type=collapsed
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"status": "success"
}
Move document
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
folder_id requiredID of the folder where you'd like to keep this document.
Returns
POST /document/{{document_id}}/move
curl
-X POST
\
https://api-eval.signnow.com/document/{{document_id}}/move
\
-H
'Authorization:
Bearer {{access_token}}'
\
-d
'{
"folder_id":
"d3d5e79a4a4bcabd18bcd136547be6851d19ce12"
}
Response
{
"result": "success"
}
Send an invite to sign
Create and sends an invite to sign a document. There are 2 types of signature invite:
- Free form invite - for a document without fillable fields
- Role-based invite - document has at least one field
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
document_id requiredID of the document for signature.
-
to requiredArray[object]: email addresses and settings for all recipients.
-
email required(Inside "to" array)Recipient's email address.
-
role_id required(Inside "to" array) ID of the recipient's Signer role.
-
role required(Inside "to" array) Recipient's Signer role name. e.g. Signer 1, Signer 2
-
order required(Inside "to" array) Integer, order of signing: 1 - the recipient has to sign the document first, then the document is sent to 2,3 etc. Several recipients can hold the same order of signing.
-
reassign required(Inside "to" array) Whether or not to allow recipients reassign this invite to another email address.
-
decline_by_signature required(Inside "to" array) Whether or not to allow recipients decline the invite.
-
reminder required(Inside "to" array) In how many days to send a reminder email to recipients
-
expiration_days required(Inside "to" array) In how many days the invite expires.
-
authentication_type optional(Inside "to" array) Type of recipient's identity verification. Can be password or phone.
-
password optional(Inside "to" array) Recipient's verification password.
-
subject required(Inside "to" array) Custom email subject for the recipient.
-
message required(Inside "to" array) Custom email message for the recipient.
-
from requiredSender's email address: you can use only the email address associated with your signNow account (login email) as "from" address.
-
cc requiredArray[string]: email addresses for CC recipients.
-
subject requiredEmail subject for all signers.
-
message requiredEmail message for all signers.
-
redirect_uri requiredThe redirect link for the invite.
Returns
POST /document/{{document_id}}/invite
curl
-X POST
\
https://api-eval.signnow.com/document/{{document_id}}/invite
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
application/json'
\
-d
'{
"from":
"sender@signnow.com",
"to":
"signer.email@signnow.com"
}
Response
{
"status": "success"
}
Cancel invite
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
PUT /document/{{document_id}}/fieldinvitecancel
curl
-X PUT
\
https://api-eval.signnow.com/document/{{document_id}}/fieldinvitecancel
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"status": "success"
}
Get document download link
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
POST /document/{{document_id}}/download/link
curl
-X POST
\
https://api-eval.signnow.com/document/{{document_id}}/download/link
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
{
"link": "https://signnow.com/dispatch?route=onetimedownload&document_download_id=67de624701a70cdfe208b5c537f61fefa48b410a"
}
Add custom event
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
client_timestamp required
-
event_type required
Returns
POST /document/{{document_id}}/custom_history_event
curl
-X POST
\
https://api-eval.signnow.com/document/{{document_id}}/custom_history_event
\
-H
'Authorization:
Bearer {{access_token}}'
\
-d
'{
"client_timestamp":
1460739202,
"event_type":
"test_event"
}'
Response
{
"status": "success"
}
Merge documents
Parameters
-
name requiredThe name of the merged document.
-
document_ids requiredArray[strings]: IDs of the documents to be merged.
Returns
POST /document/merge
curl
-X POST
\
https://api-eval.signnow.com/document/merge
\
-H
'Authorization:
Bearer {{access_token}}'
\
-H
'content-type:
application/json'
\
-d
'{
"name":
"the merged doc",
"document_ids":
[
"84a18d12bf7473ea3dd0e4dd1cdcded6ba6281aa",
"a71d963c49f33176e90c5827069c422616b1500c"
]
}'
Response
Downloads the merged document
Get document history
Parameters
-
document_id requiredPath parameter: ID of the requested document.
Returns
GET /document/{{document_id}}/historyfull
curl
-X GET
\
'https://api.signnow.com/document/{{document_id}}/historyfull'
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
[
{
"email": "user@signnow.com",
"created": "1568298674",
"event": "created_document",
"ip_address": "35.153.16.185",
"client_app_name": "SignNow Web Application",
"application_id": 85,
"origin": "original",
"version": "0",
"client_timestamp": "1568298673"
},
{
"unique_id": "13cb43cc7dd6512762e8e5993d20dfbb1d88ba78",
"created": "1568298675",
"client_timestamp": "1568298673",
"event": "document_signing_session_completed",
"client_app_name": "SignNow Web Application",
"ip_address": "35.153.16.185",
"user_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae",
"email": "user@signnow.com",
"document_id": "20473f1616bed3de1461eea5ccb47d4068a0631b",
"field_id": null,
"element_id": null,
"json_attributes": null
},
{
"unique_id": "5543027441078487cad1c8aa934754d22c22cf48",
"created": "1568298762",
"client_timestamp": "1568298763",
"event": "document_viewed",
"client_app_name": "SignNow Web Application",
"ip_address": "217.20.164.1",
"user_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae",
"email": "user@signnow.com",
"document_id": "20473f1616bed3de1461eea5ccb47d4068a0631b",
"field_id": null,
"element_id": null,
"json_attributes": null
}
]
Resend email invite
Parameters
-
fieldRequestUniqueId requiredPath parameter: ID of the invite to sign a document.
Returns
PUT /fieldinvite/{{fieldRequestUniqueId}}/resend
curl
-X PUT
\
https://api-eval.signnow.com/fieldinvite/{{fieldRequestUniqueId}}/resend
\
-H
'Authorization:
Bearer {{access_document}}'
\
Response
{
"status": "success"
}
Download document attachment
Parameters
-
document_id requiredPath parameter: ID of the requested document.
-
attachment_id requiredPath parameter: ID of the requested attachment. Can be found in the response to GET /document/{{document_id}} request.
Returns
GET /document/{{document_id}}/attachment/{{attachment_id}}/download
curl
-X GET
\
https://api-eval.signnow.com/document/{{document_id}}/attachment/{{attachment_id}}/download
\
-H
'Authorization:
Bearer {{access_token}}'
\
Response
Attachment file is returned in the response.