Signature/status

From Safe Stamper API
Jump to: navigation, search

Returns the status of a document signature.

URL

https://www.safestamper.com/api/signature/status

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:

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

RESPONSE:

{
  "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"
    }
  ]
}