eStamping & DocSigner

eStamping & DocSigner Query API

Introduction
Welcome to the  eStamp and DocSigner query API. This API serves as a powerful tool for conducting efficient database searches based on unique reference IDs generated by the eStamp and DocSigner consume API . The goal is to streamline the retrieval of contract-related information, given by end clients to uniquely identify each succesful request.
Key Features:
Efficient Searches: Conduct targeted searches within the database based on uniquereferenceId, ensuring rapid access to relevant data.
Universal Integration: Seamlessly integrate with existing systems, utilizing the uniquereferenceId as a consistent identifier across all transactions.
Scalability and Flexibility: Accommodate various eStamp management needs, from individual inquiries to bulk data retrieval, with scalability to support evolving requirements.
Secure Retrieval: Prioritize data security through robust authentication measures, ensuring authorized access to sensitive information.
Harness the capabilities of the eStamp and DocSigner query API to streamline contract management processes, enhance operational efficiency, and make informed decisions with confidence across finance, legal, and enterprise management domains.
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call. 
Sample cURL
pre-production
production
curl --location 'https://api-preproduction.signzy.app/api/v3/contract/eStampAndDocSigner/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXX' \
--data '{
    "x-uniqueReferenceId": "Std-157"
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/contract/eStampAndDocSigner/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXX' \
--data '{
    "x-uniqueReferenceId": "Std-157"
}'
﻿
Input Parameters
key
Type
M/O
﻿
x-uniqueReferenceId
String
Mandatory
Unique reference id passed for each eStamp and DocSigner consume API request. It needs to be generated at client's end and passed in API. 
Sample Response
200 (estamping)
200 (docsigner)
{
    "pdf": "",
    "stampedPdf": "",
    "refId": "669e5f292f790187102ea25b",
    "x-uniqueReferenceId": "Std-157"
}
{
    "pdf": "",
    "stampedPdf": "",
    "refId": "669e5f292f790187102ea25b",
    "x-uniqueReferenceId": "Std-157"
}
﻿
Output parameters: 
Parameter Name
Type
Description
pdf
String
The input PDF document to be stamped
signatureOptions
String
4 supported signature options -
docSignerClass2
docSignerClass3
SEAL
VIRTUALESIGN
stampedPdf
String
The signed PDF document after eStamping 
signedPdf
String
The signed PDF document after docsigner (if eStamping is passed as well, signed PDF will also be eStamped)
refId
String
Signzy generated unique transaction ID for the eStamp and DocSigner  consume API response. 
x-uniqueReferenceId
String
Unique reference id passed for each eStamp and DocSigner consume API request. It needs to be generated at client's end and passed in API. 
Sample errors
400
404
{
    "name": "error",
    "message": "x-uniqueReferenceId is not allowed to be empty",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
{
    "name": "error",
    "message": "x-uniqueReferenceId is not allowed to be empty",
    "reason": "VALIDATION_ERROR",
    "type": "Bad Request",
    "statusCode": 400
}
﻿
Error Parameters
Parameter
Type
Description
name
String
In case of errors, it will have the value "error". It represents an error.
message
String
Message for the error
reason
String
Reasons for the error
type
String
Type of error
statusCode
String
Status code of the error
Error Codes
Error Code
Error Message
Explanation
400
Bad Request
Input parameter has a missing required parameter or invalid inputs
401
Authorization Failed
Authorization token is invalid
404
Not Found 
Unique reference ID eneterd is not found in the database
500
Internal Server Error
Internal error at Signzy, Please reach out to [email protected]
﻿
﻿

eStamping & DocSigner API

Get Wallet Logs API (eStamping)

Docs powered by Archbee

TABLE OF CONTENTS

key	Type	M/O
x-uniqueReferenceId	String	Mandatory	Unique reference id passed for each eStamp and DocSigner consume API request. It needs to be generated at client's end and passed in API.

Parameter Name	Type	Description
pdf	String	The input PDF document to be stamped
signatureOptions	String	4 supported signature options - docSignerClass2 docSignerClass3 SEAL VIRTUALESIGN
stampedPdf	String	The signed PDF document after eStamping
signedPdf	String	The signed PDF document after docsigner (if eStamping is passed as well, signed PDF will also be eStamped)
refId	String	Signzy generated unique transaction ID for the eStamp and DocSigner consume API response.
x-uniqueReferenceId	String	Unique reference id passed for each eStamp and DocSigner consume API request. It needs to be generated at client's end and passed in API.

Parameter	Type	Description
name	String	In case of errors, it will have the value "error". It represents an error.
message	String	Message for the error
reason	String	Reasons for the error
type	String	Type of error
statusCode	String	Status code of the error

Error Code	Error Message	Explanation
400	Bad Request	Input parameter has a missing required parameter or invalid inputs
401	Authorization Failed	Authorization token is invalid
404	Not Found	Unique reference ID eneterd is not found in the database
500	Internal Server Error	Internal error at Signzy, Please reach out to [email protected]