API Reference

Action	Type	Endpoint
Login	GET	/v1/user/login
Retrieve Account Details	GET	/v1/user/
Update Account Settings	PUT	/v1/user/userSettings
Update Notifications Settings	PUT	/v1/user/userSettings

Document Controller

DOCUMENTS Contains information regarding documents that are to be signed

Action	Type	Endpoint
Create a Document	POST	/v1/documents/array
Bulk Sign Using a Template	POST	/v1/templates/use/{docID}/
Retrieve Template Report	GET	/v1/documents/{docID}/childrentags
Retrieve Document	GET	/v1/documents/{docID}
List Documents	GET	/v2/documents/search2
Use Template to Create a Document	POST	/v2/templates/sign/{templateID}

Folder Management

FOLDERS Contains information regarding folders and how to create, rename, delete and list them.

Action	Type	Endpoint
Get List of Document Folders	GET	/v1/folders
Get List of Template Folders	GET	/v1/folders/template
Create a Folder	POST	/v1/folders
Rename a Folder	PUT	/v1/folders/{folderId}
Delete a Folder	DELETE	/v1/folders/{folderId}

Callbacks

If you want Signority push the result to your server when the document is finalized, you need to set the document.documentSetting.postBackURL.
For example: Document.documentSetting.postBackURL = callback_URL/document_id
If the postBackURL is empty, Signority will not push the document back to your server
Notify Method : POST <Signority sends two requests to your server, one is to push the document in JSON to your server, another is to push the signed files back to your server. If it doesn’t meet your requirement, please contact us.>
You can set a different URL for each document.

Constants

Term	Definition
Base URL	Defined to be: https://sign.signority.com/api
Document	A set of files that need to be signed. A document is like an envelope
Files	A document contains one or more files, of which can be signed by a signing party
Tags	Tags locate on the specific page at a specific location. Tags are fields for the signers to fill in or sign
docID	The ID of a document, can be viewed either through a request or by looking at the URL of the document
fileID	The ID of a file, can be viewed either through a request