Initiate

6 min

Introduction

The Signzy UDIN API enables you to initiate and manage Unique Document Identification Number (UDIN) requests for your patrons. Using this API, you can initiate UDIN requests, check the status of existing UDIN requests, and fetch details of generated UDINs.

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":"initiate","essentials":{"name":"...name...","mobileNumber":"...mobileNumber...","email":"...email...","udinNumber":"...udinNumber..."}}'

Input Parameters

Parameter	Type	Required	Description
task	String	Yes	The task to be performed by the API. In this case, it should be set to "initiate".
essentials	Object	Yes	An object containing the essential details required to initiate a UDIN request.
name	String	Yes	The name of the patron initiating the UDIN request.
mobileNumber	String	Yes	The mobile number of the patron initiating the UDIN request.
email	String	Yes	The email address of the patron initiating the UDIN request.
udinNumber	String	Yes	The unique document identification number (UDIN) for which a request is being initiated.

Sample Response

 {
 	"result": {
        "token": "...token..."
 	}
 }

Output Parameters

Parameter	Type	Description
token	string	Access token to access UDIN generation.

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].