ID OCR and Masking API

Introduction

This API streamlines the process of capturing key details from ID cards and also provides you with masked ID images that can be stored in your systems adhering to RBI regulations. It is a valuable resource for organizations and developers seeking to automate their onboarding processes with seamless integration and efficient data extraction.

API description

Sample Curl:

Preproduction

Production

curl --location 'https://api-preproduction.signzy.app/api/v3/identity/extraction-masking' \
--header 'Content-Type: application/json' \
--header 'Authorization: <your auth code>' \
--data '{
    "frontUrl": "https://preproduction-persist.signzy.tech/api/files/xx/download/xx.jpg",
    "backUrl": "https://preproduction-persist.signzy.tech/api/files/xx/download/xx.jpg",
    "mask": true
}'

curl --location 'https://api.signzy.app/api/v3/identity/extraction-masking' \
--header 'Content-Type: application/json' \
--header 'Authorization: <your auth code>' \
--data '{
    "frontUrl": "https://preproduction-persist.signzy.tech/api/files/xx/download/xx.jpg",
    "backUrl": "https://preproduction-persist.signzy.tech/api/files/xx/download/xx.jpg",
    "mask": true
}'

Input Parameters:

Property	Data Type	Example Value	Mandatory	Description
frontUrl	String (URL)	"https://persist.signzy.tech/api/files/xx.jpg"	Yes	The URL of the front image of the ID card for OCR and masking.
backUrl	String (URL)	"https://persist.signzy.tech/api/files/xx.jpg"	No	The URL of the back image of the ID card for OCR and masking.

Details of the response properties

Sample Response:

The API response will be a JSON object containing the following properties:

Property	Data Type	Example Value	Description
poi	String	"000000001614"	The extracted ID number.
vid	String	""	The extracted VID (Virtual ID).
name	String	"JOHN DOE"	The name of the ID cardholder.
dob	String	"22/07/1998"	The date of birth of the cardholder in DD/MM/YYYY format.
yob	String	"1998"	The year of birth of the cardholder.
pincode	String	"560079"	The PIN code associated with the cardholder's address.
address	String	"C / O ABC FHID"	The full address of the cardholder as extracted from the ID card.
gender	String	"Male"	The gender of the cardholder.
splitAddress	Object	-	An object containing a breakdown of the cardholder's address into different components.
idHash	String	"2650a102c9f28f2XXX"	A hashed version of the extracted ID number for security purposes.
validBackAndFront	Boolean	true	Indicates whether the front and back images of the ID card are valid for processing.
validFront	Boolean	true	Indicates whether the front image of the ID card is valid for processing.
validBack	Boolean	true	Indicates whether the back image of the ID card is valid for processing.
maskedfrontUrl	String	"https://persist.com/files/5831dc1e2.jpg"	The URL to access the masked front image of the ID card.
maskedBackUrl	String	"https://persist.com/files/5831dc1e2.jpg"	The URL to access the masked back image of the ID card.

Error Codes

Error Code	Description
400	Bad request. This error occurs when the request is invalid or missing required parameters.
401	Unauthorized. This error occurs when the request does not contain a valid API key or access token.
403	Forbidden. This error occurs when the API key or access token provided with the request does not have permission to access the requested resource.
404	Not Found. This error occurs when the provided doc image is not found or not in the proper format.
429	Too Many Requests. This error occurs when the request limit for the API endpoint has been reached.
500	Internal Server Error. This error occurs when there is an unexpected error on the server side.

FAQ

What are the image types supported?

JPEG, JPG, TIFF, PNG, PDF (1 page) are supported.