Get Info

6 min

Introduction

This API allows you to access and manage Unique Document Identification Number (UDIN) for a specific patron.

Sample Curl

curl --request POST \
  --url 'https://preproduction.signzy.tech/api/v2/patrons/..your-patron-id../udin' \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'content-type: application/json' \
  --data '{"task":"getInfo","essentials":{"token":"...token...","otp":"...otp..."}}'

Input Parameters

Parameter	Type	Description
task	String	The task to be performed by the API. Set to "getInfo" to retrieve the UDIN.
token	String	The authentication token required to access the API. Obtain this token by following the authentication flow provided by Signzy.
otp	String	The one-time password required for authentication. Obtain this OTP using the flow provided by Signzy.
essentials	JSON	A JSON object that contains the essential parameters required for the API to retrieve the UDIN. The "essentials" field must include the "token" and "otp" parameters.

Sample Response

{
 	"result": {
        "verificationDate": "...verificationDate...",
        "udinGenerationDate": "...udinGenerationDate...",
        "dateOfSigningOfDocument": "...dateOfSigningOfDocument...",
        "udinNumber": "...udinNumber...",
        "memberDetails": "...memberDetails...",
        "documentType": "...documentType...",
        "typeOfCertificate": "...typeOfCertificate...",
        "figuresParticulars": "...figuresParticulars...",
        "documentDescription": "...documentDescription...",
        "status": "...status..."
    }
 }

Output Parameters

Parameter	Type	Description
verificationDate	String	The date on which the document was verified by Signzy.
udinGenerationDate	String	The date on which the UDIN was generated by Signzy.
dateOfSigningOfDocument	String	The date on which the document was signed by the member.
udinNumber	String	The unique UDIN number generated by Signzy for the document.
memberDetails	String	The details of the member who signed the document.
documentType	String	The type of document for which the UDIN was generated.
typeOfCertificate	String	The type of certificate for which the UDIN was generated.
figuresParticulars	String	The figures and particulars associated with the document.
documentDescription	String	A brief description of the document for which the UDIN was generated.
status	String	The status of the UDIN generation process. Possible values include "SUCCESS", "FAILURE", "INVALID_TOKEN", "INVALID_OTP", and "EXPIRED_OTP".

Status Codes

CODE	MESSAGE
200	OK
404	Data Not Found
409	Error in getting Data from Upstream

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].