NREGA CARD (BETA)

Introduction

This API allows users to extract information from NREGA cards through images. The API accepts an image URL containing NREGA card. The API returns a JSON response with the extracted information in a result object including Job Card No, Household head, Family ID, and other pertinent information.

API details

Endpoint

POST https://api-preproduction.signzy.app/api/v3/extraction/nrega_card

POST https://api.signzy.app/api/v3/extraction/nrega_card

Request headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Request body parameters

Parameter	Data type	Description	Required
imgurl	String	A URL of the image. Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 2 pages) containing NREGA card.	Mandatory

{
   "imgurl" : "https://persist.signzy.tech/api/files/40281535/download/xxxxxxxxxxxxxxxxxx.jpeg"
}

Code samples

curl --location 'https://api.signzy.app/api/v3/extraction/nrega_card' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Token>' \
--data '{
    "imgurl": "https://persist.signzy.tech/api/files/795928401/download/xxxxxxxxxxxxxxxxxxxx.png"
}'

Response body parameters

Parameter	Data Type	Description
result	Object	An object containing the extracted NREGA Card details
result.jobCardNo	String	The job Card Number of the family.
result.nameOfHeadOfHousehold	String	Name of the head of the household.
result.nameOfFather/Husband	String	Name of the father or husband of the head of the household.
result.category	String	Category of the family
result.dateOfRegistration	String	Date when NREGA card was registered
result.villages	String	Village
result.panchayat	String	Panchayat
result.block	String	Block
result.district	String	District
result.bplFamily	String	Family is BPL or not
result.familyId	String	An ID specific to the family
result.detailsOfApplicantsOfHousehold	Object	An object containing household members registered on the NREGA card.
result.detailsOfApplicantsOfHousehold.Name of Applicant	String	Name of the working applicant
result.detailsOfApplicantsOfHousehold.Age	String	Age of the working applicant
result.detailsOfApplicantsOfHousehold.Gender	String	Gender of the working applicant
result.detailsOfApplicantsOfHousehold.Bank/Postoffice	String	Bank Account of the working applicant

{
    "message": "Invalid authentication credentials"
}

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!