Fair API Pricing

No Surprise Fees

Secure Your Document Distribution and Management with a Signority API Plan

Frequently Asked Questions

Signing workflow without going to Email Inbox

1. In the form fill up page capture customer information such as Name, Email and any other text such as date/company name etc and post it to your server.
2. Once your server has the information, you need to send the document file and the information (Recipent Email, Name, etc) along with signature tags to Signority using a post request.
3. Once post your document to signority you will get a ‘Document’ JSON response from our server which will contain information such Document Title, Sender Name, Signing Status etc. The structure of response is available in section “1.2.1 The Main Structure” of the API Documentation (Page 2).
4. The response in step 3 has a Invitation Array as shown in “1.2.2. The Structure of Invitations”, the invitation array has a GUID, you will need the GUID to load the signing/invitation page (This is the same link you get in your email when a document is sent for you to sign). Form a invitation url using the GUID
https://sign.signority.com/UI/documentDesigner2.html?iid=<Put the GUID here>
Example:
https://sign.signority.com/UI/documentDesigner2.html?iid=0d7df95e-5fca-4927-a2a7-c8968c724ebe
5. Once your server gets the response from signority, grabs the GUID from the Invitation array and forms the invitation URL, have the server send it back to the client. The client can load the page in an iframe that way the user can sign the document in your website.
6. After the signing is completed you can detect it using javascript redirect/send the user the next page (i.e payment page).

Implement Custom Fields using Tags
tags
more tags
You can use the PUT Tags API to put these tags on your request, you can follow API Documentation section “3.4. PUT /v1/documents/{id}/tags” for more information.
Alternatively you can put it in the one big call request as well, you already put a signature tag I guess, all you need to do is just change the value of ‘type’ field in the tag array. Below are codes for each tag types.
SIGNATURE: 250,
INITIAL: 251,
TEXT: 252,
CHECKBOX: 253,
RADIO: 254,
DATE: 255,
ATTACHMENT: 256,
DROPDOWN: 257,
NOTE: 258
You just need put the corresponding value to the type field.
For redirection, one way to do this would be to put a button outside the iframe (i.e next/payment page), once the user clicks that button it sents the request to your server, which sends a Get document status request to signority to check if the signing is actually completed if the response shows that its completed your server can redirect the user to the proper payment/next page.
This section in API Documentation outlines the get document request “3.6. GET /v1/documents/{id}”, the {id} portion is the document id which got from the response when you created a new document. If the “signingStatus” key in the response is ’53’ it means the document is completed (Page 17 of API Documentation), any other values means the document is not completed can you can return an error back to the user.
Downloading Specific Signed Documents

After a document has completed it’s signing process, the user way download it in one of 4 ways.

  1. File containing just the signed document
    • Make a GET request to https://sign.signority.com/api/v1/documents/{docID}/download?content=esign
  2. File containing just the audit portion of the signed document
    • Make a GET request to https://sign.signority.com/api/v1/documents/{docID}/download?content=audit
  3. File containing the signed document with the audit history
    • Make a GET request to https://sign.signority.com/api/v1/documents/{docID}/download?content=esignwithaudit
  4. A zipped folder containing all three of the above files
    • Make a GET request to https://sign.signority.com/api/v1/documents/{docID}/download
Purging Documents off Signority

To delete documents permanently from Signority servers, send a DELETE request to:

https://sign.signority.com/api/v1/documents//array/purgeall