SignNow Python SDK
SignNow is a powerful web-based e-signature solution that streamlines the signing process and overall document flow for businesses of any size. SignNow offers SaaS as well as public and private cloud deployment options using the same underlying API. With SignNow you can easily sign, share and manage documents in compliance with international data laws and industry-specific regulations. SignNow enables you to collect signatures from partners, employees and customers from any device within minutes.
If you have questions about the SignNow API, please visit [https://help.signnow.com/docs](https://help.signnow.com/docs) or email [api@signnow.com](mailto:api@signnow.com).
See additional contact information at the bottom.
To install to Python library:
Download the signnow library and extract it into the location of your choice.
Navigate to the extracted file and run the following:
python setup.py install
import signnow_python_sdk
signnow_python_sdk.Config(client_id="YOUR_CLIENT_ID", client_secret="YOUR_CLIENT_SECRET", base_url="https://api-eval.signnow.com")To run the examples you will need an API key. You can get one here [https://www.signnow.com/api](https://www.signnow.com/api). For a full list of accepted parameters, refer to the SignNow REST Endpoints API guide: [https://help.signnow.com/docs](https://help.signnow.com/docs).
access_token = signnow_python_sdk.OAuth2.request_token("YOUR USERNAME", "YOUR PASSWORD")access_token_verify = signnow_python_sdk.OAuth2.verify(AccessToken)new_user = signnow_python_sdk.User.create("name@domain.com", "newpassword", "Firstname", "Lastname")sn_user = signnow_python_sdk.User.get(access_token)# without annotations
document_data = signnow_python_sdk.Document.get(access_token, "YOUR_DOCUMENT_ID")
# with annotations
document_data = signnow_python_sdk.Document.get(access_token, "YOUR_DOCUMENT_ID", True)dir_path = os.path.dirname(os.path.realpath(__file__)) + '/testing123.pdf'
doc_id = signnow_python_sdk.Document.upload(access_token, dir_path, False)dir_path = os.path.dirname(os.path.realpath(__file__)) + '/testing123.pdf'
doc_id = signnow_python_sdk.Document.upload(access_token, dir_path)update_payload = {
"texts": [
{
"size": 22,
"x": 61,
"y": 72,
"page_number": 0,
"font": "Arial",
"data": "a sample text element",
"line_height": 9.075,
"client_timestamp": datetime.now().strftime("%s")
}
],
fields: [
{
"x": 10,
"y: 10,
"width": 122,
"height": 34,
"page_number": 0,
"role": "Buyer",
"required": True,
"type": "signature"
}
]
}
update_doc_res = signnow_python_sdk.Document.update(access_token, doc_id, update_payload)delete_doc_res = signnow_python_sdk.Document.delete(access_token, doc_id)# without history
download_doc_res = signnow_python_sdk.Document.download(access_token, "YOUR DOCUMENT ID", "/", "sample")
# with history
download_doc_res = signnow_python_sdk.Document.download(access_token, "YOUR DOCUMENT ID", "/", "sample", True)invite_payload = new
{
"from": "account_email@domain.com",
"to": "name@domain.com"
}
freeform_invite_res = signnow_python_sdk.Document.invite(access_token, "YOUR DOCUMENT ID", invite_payload)invite_payload = {
"to": [
{
"email": "name@domain.com",
"role_id": "",
"role": "Role 1",
"order": 1,
"authentication_type": "password",
"password": "SOME PASSWORD",
"expiration_days": 15,
"reminder": 5
},
{
"email": "name@domain.com",
"role_id": "",
"role": "Role 2",
"order": 2,
"authentication_type": "password",
"password": "SOME PASSWORD",
"expiration_days": 30,
"reminder": 10
}
],
"from": "your_account_email@domain.com",
"cc": [
"name@domain.com"
],
"subject": "YOUR SUBJECT",
"message": "YOUR MESSAGE"
};
role_based_invite_res = signnow_python_sdk.Document.invite(access_token, "YOUR DOCUMENT ID", invite_payload)cancel_invite_res = signnow_python_sdk.Document.cancel_invite(access_token, "YOUR DOCUMENT ID");merge_doc_payload = {
"name": "My New Merged Doc",
"document_ids": ["YOUR DOCUMENT ID", "YOUR DOCUMENT ID"]
}
merge_doc_res = signnow_python_sdk.Document.merge_and_download(access_token, mergeDocsObj, "/", "sample-merge");doc_history_res = signnow_python_sdk.Document.get_history(access_token, "YOUR DOCUMENT ID");new_template_res = signnow_python_sdk.Template.create(access_token, "YOUR DOCUMENT ID", "My New Template");copy_template_res = signnow_python_sdk.Template.copy(access_token, "YOUR TEMPLATE ID", "My Copy Template Doc");| Filters | Values |
|---|---|
signing-status |
waiting-for-me, waiting-for-others, signed, pending |
document-updated |
datetime.now().strftime("%s") |
document-created |
datetime.now().strftime("%s") |
| Sort | Values |
|---|---|
document-name |
asc/desc |
updated |
asc/desc |
created |
asc/desc |
root_folder_Res = signnow_python_sdk.Folder.root_folder(access_token);get_folder_res = signnow_python_sdk.Folder.get(access_token, "YOUR FOLDER ID");| Events | Description |
|---|---|
document.create |
Webhook is triggered when a document is uploaded to users account in SignNow |
document.update |
Webhook is triggered when a document is updated (fields added, text added, signature added, etc.) |
document.delete |
Webhook is triggered when a document is deleted from |
invite.create |
Webhook is triggered when an invitation to a SignNow document is created. |
invite.update |
Webhook is triggered when an invite to Signnow document is updated. Ex. A signer has signed the document. |
createWebhookRes = signnow_python_sdk.Webhook.create(access_token, "document.create", "YOUR URL");list_webhooks_res = signnow_python_sdk.Webhook.list_all(access_token);delete_webhook_res = signnow_python_sdk.Webhook.delete(AccessToken, "YOUR WEBHOOK ID");create_link_res = signnow_python_sdk.Link.create(access_token, "YOUR DOCUMENT ID");To contact SignNow support, please email [support@signnow.com](mailto:support@signnow.com).
For pricing information please call (800) 831-2050 or email [sales@signnow.com](mailto:sales@signnow.com).