KYC and Utility extraction API

Introduction

The KYC and Utility extraction API is a comprehensive solution designed to extract relevant information from a wide range of Officially Valid Documents (OVDs) and utility bills using a single endpoint. This API streamlines the process of identity verification.

Key Features:

Versatile Document Support: Handles multiple document types including utility bills and OVDs.

Comprehensive Data Extraction: Extracts detailed information such as names, addresses, account numbers, dates, and more.

Wide File Type Compatibility: Supports .jpg, .jpeg, .png, and .pdf formats

Easy Integration: A single endpoint for multiple document types simplifies the integration process.

Doctype classification in response: Classifies the document uploaded into respective OVDs, Utility bill type, and Others.

Supported Documents:

Utility Bills:

Electricity Bills

Broadband Bills

Lease Deeds

Gas Bills

OVD Documents:

PAN Card

Driving License

Voter ID (front and back images)

Aadhaar Card (front and back images)

Passport (front and back images)

API details

Endpoint

curl --location 'https://api-preproduction.signzy.app/api/v3/utility/single-kyc' \
--header 'Authorization: <auth_key>' \
--header 'Content-Type: application/json' \
--data'{
    "url": ["URL1, URL2"],
    "isBill": true
}'

curl --location 'https://api.signzy.app/api/v3/utility/single-kyc' \
--header 'Authorization: <auth_key>' \
--header 'Content-Type: application/json' \
--data'{
    "url": ["URL1, URL2"],
    "isBill": true
}'

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
url	Array	A list of URLs/Base64 of the ID images. Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 2 URLs/Base64).	Mandatory
isBill	Boolean	If isBill is set to true, the API processes the document as a utility bill and extracts the relevant utility bill fields. If isBill is set to false, the API processes the document as an identity document and extracts the details based on the specified idType.	Mandatory

{
    "url": [
        "https://preproduction-persist.signzy.tech/api/files/25535sa717/download/163.jpg", 
        "https://preproduction-persist.signzy.tech/api/files/2553as5717/download/163.jpg"
    ],
    "isBill": true
}

Code samples

curl --location 'https://api-preproduction.signzy.app/api/v3/single-kyc/extraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: < Auth Key >' \
--data '{
    "url": [
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg", 
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg"
    ],
    "isBill": true
}'

Response body parameters

Parameter	Data Type	Description
result	Object	Extracted ID/Utility Bill object
action	String	"extract"
completedAt	String	"2024-05-20T14:26:56"
createdAt	String	"2024-05-20T14:26:56"
requestId	String	requestID
electricityBill	Object	{ "accountNumber": "", "address": "NA", "billNumber": "", "billingDate": "", "fullName": "NA", "mobileNo": "NA", "electricityBillProvider": "NA" }
gasBill	Object	{ "address": "", "fullName":"", "billingDate": "" }
leaseOfDeed	Object	{ "leseeName": "", "lessorName": "", "licenseeAddress": "", "licensorAddress": "", "IssuedDate": "" }
broadbandBill	Object	{ "address": "", "fullName": "", "billingDate": "" }
voterId	Object	{ "status": "200", "name": "Name", "fatherName": "Relative Name", "address": "Full address", "state": "State", "ageAsOn": "Age", "dob": "DD/MM/YYYY", "gender": "MALE", "yob": "YYYY", "epicNumber": "XXX0000000", "splitAddress": { "district": [], "state": [ [] ], "city": [], "pincode": "000000", "country": [ "IN", "IND", "INDIA" ], "addressLine": "Address Line" }, "msg": "success" }, "url": [ "" ] }
aadhaar	Object	{ "uid": "", "vid": "", "name": "", "dob": "", "yob": "", "pincode": "", "address": "", "gender": "", "splitAddress": { "district": [ "" ], "state": [ [ "", "TG" ] ], "city": [ "" ], "pincode": "", "country": [ "IN", "IND", "INDIA" ], "addressLine": "" }, "uidHash": "", "summary": { "number": "", "name": "", "dob": "", "address": "", "splitAddress": { "district": [ "" ], "state": [ [ "", "" ] ], "city": [ "" ], "pincode": "", "country": [ "IN", "IND", "INDIA" ], "addressLine": "" }, "gender": "", "guardianName": "", "issueDate": "", "expiryDate": "", "dateOfBirth": "" }, "validBackAndFront": true, "dateOfBirth": "" }
passport	Object	{ "parentsGuardianName": "", "issueDate": "", "expiryDate": "", "birthDate": "", "name": "", "country": [ "IN", "IND", "India" ], "nationality": "", "sex": "", "address": "", "pincode": "", "passportNumber": "", "fileNumber": "", "placeOfBirth": "", "placeOfIssue": "", "splitAddress": { "district": [], "state": [ [] ], "city": [], "pincode": "", "country": [ "IN", "IND", "INDIA" ], "addressLine": "" }, "summary": { "number": "", "name": "", "dob": "", "address": "", "splitAddress": { "district": [], "state": [ [] ], "city": [], "pincode": "", "country": [ "IN", "IND", "INDIA" ], "addressLine": "" }, "gender": "", "guardianName": "", "issueDate": "", "expiryDate": "" } }
drivingLicense	Object	{ "dlType": [], "issueDate": "", "expiryDate": "", "dob": "", "guardianName": "", "name": "", "number": "", "state": "", "address": "", "gaurdianName": "", "splitAddress": { "district": [], "state": [ [] ], "city": [], "pincode": "", "country": [ "IN", "IND", "INDIA" ], "addressLine": "" } }
pan	Object	{ "panType": "Adult", "dob": "", "name": "", "fatherName": "", "number": "", "summary": { "number": "", "name": "", "dob": "", "address": "", "splitAddress": { "district": [], "state": [ [] ], "city": [], "pincode": "", "country": [], "addressLine": "" }, "gender": "", "guardianName": "", "issueDate": "", "expiryDate": "" } }
status	String	"completed"
taskId	String	Empty String
docType	String	Document Type detected

{
    "result": {
        "action": "extract",
        "completedAt": "2024-05-20T15:05:40",
        "createdAt": "2024-05-20T15:05:37",
        "requestId": "",
        "electricityBill": {},
        "gasBill": {},
        "leaseOfDeed": {},
        "broadbandBill": {},
        "voterId": {},
        "aadhaar": {},
        "passport": {},
        "drivingLicense": {},
        "pan": {
            "panType": "Adult",
            "dob": "",
            "name": "",
            "fatherName": "",
            "number": "",
            "summary": {
                "number": "",
                "name": "",
                "dob": "",
                "address": "",
                "splitAddress": {
                    "district": [],
                    "state": [
                        []
                    ],
                    "city": [],
                    "pincode": "",
                    "country": [],
                    "addressLine": ""
                },
                "gender": "",
                "guardianName": "",
                "issueDate": "",
                "expiryDate": ""
            }
        },
        "status": "completed",
        "taskId": "",
        "docType": ""
    }
}

Note:

The response will contain only one filled object at a time. For example, if you extract the Electricity Bill, all other OVD and Utility bill objects will be empty.

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!