Signature/status - Revision history

Adminwiki: /* Returns */

2024-09-18T08:14:05Z

Returns

← Older revision		Revision as of 04:14, 18 September 2024
Line 28:		Line 28:
	* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)
	** This URL is for end users to access the signature certificate.		** This URL is for end users to access the signature certificate.
	* '''password''': ~~Access~~ password for downloading the signature certificate (for SIGNED documents).		* '''password''': Generated access password for downloading the signature certificate (for SIGNED documents).
	** End users will need to know this password to get the document from certificateValidationUrl.		** End users will need to know this password to get the document from certificateValidationUrl.
	* '''signatures''': The list of signatures		* '''signatures''': The list of signatures

Adminwiki: /* Returns */

2024-09-18T08:13:41Z

Returns

← Older revision		Revision as of 04:13, 18 September 2024
Line 24:		Line 24:
	* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)
	* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)
	** This URL ~~should~~ be used ~~only~~ to download the certificate internally ~~and~~ should not be provided to the end user.		** This URL can be used to download the certificate internally, but should not be provided to the end user.
	** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.		** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.
	* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)

Adminwiki: /* Returns */

2024-09-18T08:11:52Z

Returns

← Older revision		Revision as of 04:11, 18 September 2024
Line 28:		Line 28:
	* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)
	** This URL is for end users to access the signature certificate.		** This URL is for end users to access the signature certificate.
	* '''password''': Access password for downloading the signature certificate. End users will need to know this password to ~~access~~ the certificateValidationUrl.		* '''password''': Access password for downloading the signature certificate (for SIGNED documents).
			** End users will need to know this password to get the document from certificateValidationUrl.
	* '''signatures''': The list of signatures		* '''signatures''': The list of signatures
	** '''signerName''': Signer name		** '''signerName''': Signer name

Adminwiki: /* Returns */

2024-09-18T08:10:53Z

Returns

← Older revision		Revision as of 04:10, 18 September 2024
Line 23:		Line 23:
	** '''SIGNED''': The document has all its signatures and it has generated a signing certificate		** '''SIGNED''': The document has all its signatures and it has generated a signing certificate
	* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)
	* '''certificateUrl''': ~~Validation~~ URL of the signature certificate, if it has already been generated (for SIGNED documents)		* '''certificateUrl''': Direct download URL for the signature certificate, if it has already been generated (for SIGNED documents)
	** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet.		** This URL should be used only to download the certificate internally and should not be provided to the end user.
			** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet for download.
			* '''certificateValidationUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)
			** This URL is for end users to access the signature certificate.
			* '''password''': Access password for downloading the signature certificate. End users will need to know this password to access the certificateValidationUrl.
	* '''signatures''': The list of signatures		* '''signatures''': The list of signatures
	** '''signerName''': Signer name		** '''signerName''': Signer name
Line 33:		Line 37:
	** '''signerIP''': IP address from which the document was signed		** '''signerIP''': IP address from which the document was signed
	** '''signatureDate''': Date of signature		** '''signatureDate''': Date of signature


	= HTTP Errors =		= HTTP Errors =

Adminwiki: 1 revision imported

2023-10-17T11:27:28Z

1 revision imported

← Older revision	Revision as of 07:27, 17 October 2023
(No difference)

api>Admin at 06:48, 25 September 2020

2020-09-25T06:48:35Z

New page

Returns the status of a document signature.

= URL =
<nowiki>https://www.safestamper.com/api/signature/status</nowiki>

= Parameters =
* '''sharedkey''': Your API client shared key
* '''authkey''': Authorization key, if needed
* '''code''': Document code, returned by [[signature/sign]]
* '''signature''': Parameters signature, as explained in [[Signature parameter]]

= Returns =

A JSON object with the following fields:

* '''code''': Document code
* '''title''': Document title
* '''senderName''': Sender name
* '''senderEmail''': Sender e-mail address
* '''entryDate''': Date of upload
* '''state''': Document state
** '''PENDING''': The document doesn't have all its signatures
** '''SIGNED''': The document has all its signatures and it has generated a signing certificate
* '''certificateCode''': Code of the signature certificate, if it has already been generated (for SIGNED documents)
* '''certificateUrl''': Validation URL of the signature certificate, if it has already been generated (for SIGNED documents)
** If the document status is queried when the document has just been signed by its last signer, it may be in SIGNED state, but the certificate can still be in process and may not be available yet.
* '''signatures''': The list of signatures
** '''signerName''': Signer name
** '''signerEmail''': Signer e-mail address
** '''state''': Signature state
*** '''PENDING''': The signer has not answered yet
*** '''SIGNED''': The signer has signed the document
** '''signerIP''': IP address from which the document was signed
** '''signatureDate''': Date of signature

= HTTP Errors =

* '''403''' Forbidden, the sharedkey or parameter signature are not valid
* '''401''' Unauthorized, the authkey is not valid
* '''404''' Document code not found

= Example =

REQUEST:
<pre>
https://www.safestamper.com/api/signature/sign
?sharedkey=5hmpod0d2vx7fnh6ysxab3olz
&code=b508e6e9-e5f6-4bb5-beef-c89bf6b50764
&signature=6e83ffc1db2ea262c71426f2660882539d40ec60
</pre>

RESPONSE:
<pre>
{
"code":"b508e6e9-e5f6-4bb5-beef-c89bf6b50764",
"title":"Test Document",
"senderName":"John Doe",
"senderEmail":"john@example.com",
"state":"PENDING",
"entryDate":"2019-07-29T09:18:46Z",
"signatures":[
{
"signerName":"Anne Example",
"signerEmail":"anne@example.com",
"signerIP":"127.0.0.1",
"state":"SIGNED",
"signatureDate":"2019-07-29T09:32:41Z"
},
{
"signerName":"Bernie Beans",
"signerEmail":"bernie@example.com",
"state":"PENDING"
}
]
}
</pre>