KYC ID QR verification API

Introduction

The KYC ID QR verification API offers a fast and efficient solution for real-time KYC ID verification. It confirms data authenticity and extracts key personal details like name, date of birth, and gender directly from the QR code for secure validation.

Key Benefits:

Fraud Prevention: Ensures only genuine KYC ID cards are used, reducing fraud risk.

Error-Free: Automates data entry, eliminating manual mistakes and enhancing accuracy.

Precision: Provides real-time, accurate data extraction.

Faster Onboarding: Speeds up user onboarding with instant data retrieval.

This solution enhances security, prevents errors, and accelerates onboarding, making it vital for identity management and fraud prevention.

Current accuracy: 92%

Constraint: Image should be clear enough for QR to be captured without noise.

API details

Endpoint

POST https://api.signzy.app/api/v3/identityQR/verifyAndFetchDetails

   POST https://api-preproduction.signzy.app/api/v3/identityQR/verifyAndFetchDetails

Request body parameters

Parameter	Data Type	Description	Required
url	String	The URL of the KYC ID QR image. Format supported should be .jpg/.jpeg, .png	Mandatory
consent	String	Consent of user Y, N It has to be Y to process the request	Mandatory

{
    "url": "https://persist.signzy.tech/api/files/1328712340/download/XXXX.jpeg",
    "consent": "Y"
}

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.

Code Samples

curl --location 'https://api-preproduction.signzy.app/api/v3/identityQR/verifyAndFetchDetails' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_key>' \
--data '{
    "url": "https://persist.signzy.tech/api/files/1328712340/download/XXXX.jpeg",
    "consent": "Y"
}

    '

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the response for the KYCID card holder.
result.isQRVerified	String	Possible values are true, false and empty string. true, if QR code is verified false, if QR code is not verified empty string, if QR code is not digitally signed
result.isQRSecure	String	Represents if the QR code is secure or not true, if QR code is secure false, if QR code is not secure
result.demographicData	Object	Demographic data of the aadhaar card holder
result.demographicData.name	String	Name of the aadhaar card holder
result.demographicData.dob	String	The data of birth of the aadhaar card holder
result.demographicData.gender	String	Gender of the KYC ID card holder
result.demographicData.pincode	String	Pincode of the KYC ID card holder
result.demographicData.postOffice	String	Postoffice of the KYC ID card holder
result.demographicData.state	String	state of the KYC ID card holder
result.demographicData.district	String	District of the KYC ID card holder
result.demographicData.subDistrict	String	Subdistrict of the KYC ID card holder
result.demographicData.vtc	String	Village/town/city of the KYC ID card holder
result.demographicData.landmark	String	Landmark of the KYC ID card holder
result.demographicData.street	String	Street of the KYC ID card holder
result.demographicData.location	String	Location of the KYC ID card holder
result.demographicData.kycId	String	Masked kycId of the KYC ID card holder
result.demographicData.careOf	String	CareOf of the KYC ID card holder
result.demographicData.house	String	House no of the KYC ID card holder
result.demographicData.yob	String	Year of birth of the KYC ID card holder

{
    "result": {
        "isQRVerified": "true",
        "isQRSecure": "true",
        "demographicData": {
            "name": "Nikhil Patra",
            "dob": "09/05/2001",
            "gender": "M",
            "pincode": "768106",
            "postOffice": "",
            "state": "Maharastra",
            "district": "Nanded",
            "subDistrict": "",
            "vtc": "Jay S.O",
            "landmark": "NEAR CHOTA AYACHIT MANDIR",
            "street": "",
            "location": "678,CHOTA CHAUK,Jay",
            "kycId": "XXXXXXXX8922",
            "careOf": "S/O Naba Patra",
            "house": "",
            "yob": "2001"
        }
    },
    "message": "Success",
    "reason": "REQUEST_SUCCESSFUL",
    "code": "S001"
}

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!

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.statusCode	Request Status code from Signzy
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.reason	Reason for error
error.type	Type of the error

Error Codes

CODE	DESCRIPTION	INTERPRETATION
400	Bad Request	Input Parameter has a missing required parameter
401	Authorization Failed	Authorization token is invalid.
409	Upstream Error	Upstream is down, please contact support
500	Internal Server Error	Internal error at Signzy, please contact support.

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