simplysign

API

All API requests must contain your personal API Key parameter (api_key).

Methods:

addDocument
Creates a new document to sign.

HTTP request

				
					POST http://api.signhere.us/addDocument
  • api_key
    your personal API key.
  • resource (JSON)
    url: document URL (must return 200 OK, then file will be uploaded, otherwise – method will return error)
    signatories: set of signatories (recepients)

Example:

				
					{
	"url" : "http://anydomain.com/full_document_path/file0035.pdf",
	"signatories" :
	[
		{
			"name" : "Miriam Peilingmore",
			"type" : 1,
			"value" : "m.peil@macrophone.com"
		},
		{
			"name" : "Peter Bowning",
			"type" : 2,
			"value" : "+15934356840"
		},
		{
			"name" : "Asu Habibzade",
			"type" : 3,
			"value" : "+129548954637"
		}
	]
}

Response:

JSON-formatted set of document properties:

  • documentId: auto-generated document ID
  • documentURL: permanent document URL
  • personalLinks: set of recepients and links for them to sign the document (feel free to use this link in <iframe> tag).

Response examples: 

				
					
Status
Response
200
{
	"documentId" : "2sg5v6cb82idgs0t",
	"documentUrl" : "https://file.signhere.us/2sg5v6cb82idgs0t",
	"personalLinks" :
		[
			{
				"value" : "m.peil@macrophone.com”,
				"link" : "http://doc.signhere.us/dm9xkglln3nbkhoq"
			},
			{
				"value" : "+1295548954634”,
				"link" : "http://doc.signhere.us/vq5nfao1rmc0nc8k"
			},
			{
				"value" : "+1295548954634”,
				"link" : "http://doc.signhere.us/bj1vg7dsmg0jhg2d"
			},
		]
}
403
{
	"error" : "’documentUrl’ parameter is missing"
}

sendDocument

Sends notification to all signatories of documents, listed in the documents parameter.

HTTP request

				
					GET http://api.signhere.us/sendDocument

Parameters:

  • api_key
    documents (JSON): set of
  • ‘documentId’ parameters (see addDocument method response).
				
					[
	"2sg5v6cb82idgs0t",
	"pv2uub9kwnmse7wy"
]
				
			
				
					Response examples
Status
Response
200
{
	"documentsFailed": 1,
	"documents":
		[
			{
				"documentId": "2sg5v6cb82idgs0t",
				"sent": TRUE
			},
			{
				"documentId": "3kg1dwh5jefh6n2m",
				"sent": FALSE,
				"error": "No document with such ID"
			}
		]
}
403
{
	"error" : "’api_key’ parameter is missing"
}

dropDocument

Removes document and all connected records.

HTTP request

				
					GET http://api.signhere.us/dropDocument

Parameters:

  • api_key
    documents (JSON): set of
  • ‘documentId’ parameters (see addDocument method response).
				
					[
	"2sg5v6cb82idgs0t",
	"pv2uub9kwnmse7wy"
]
				
			
				
					Response examples
Status
Response
200
[
	{
		"documentId" : "2sg5v6cb82idgs0t",
		"documentUrl" : "https://file.signhere.us/2sg5v6cb82idgs0t",
		"fullySigned" : TRUE,
		"signatories" :
		[
			{
				"name" : "Miriam Peilingmore",
				"type" : 1,
				"value" : "m.peil@macrophone.com",
				"link" : "http://doc.signhere.us/dm9xkglln3nbkhoq",
				"signed" : TRUE,
				"signedAt" : "2019-01-21T15:49:27Z",
			},
			{
				"name" : "Peter Bowning",
				"type" : 2,
				"value" : "+15934356840",
				"link" : "http://doc.signhere.us/vq5nfao1rmc0nc8k",
				"signed" : TRUE,
				"signedAt" : "2019-01-11T21:01:15Z",
	
			},
			{
				"name" : "Asu Habibzade",
				"type" : 3,
				"value" : "+129548954637",
				"link" : "http://doc.signhere.us/bj1vg7dsmg0jhg2d",
				"signed" : TRUE,
				"signedAt" : "2019-01-12T01:23:19Z",
			}
		]
	},

	{
		"documentId" : "pv2uub9kwnmse7wy",
		"documentUrl" : "https://signhere.us/pv2uub9kwnmse7wy",
		"fullySigned" : FALSE,
		"signatories" :
		[
			{
				"name" : "William Clemens",
				"type" : 1,
				"value" : "wclemens@gmail.com",
				"link" : "http://doc.signhere.us/d82jmv74x05msy27",
				"signed" : FALSE
			}
		]
	},
]
403
{
	"error" : "’api_key’ parameter is missing"
}