API Reference

aadhaar-file

Download Aadhar XML from karza.

/api/v1/kyc/get-aadhaar-file/

{ "mode": "raw", "raw": "{\r\n \"aadhar\": \"707192518712\",\r\n \"otp\": \"195709\",\r\n \"share_code\":\"1234\"\r\n}" },v

Sample response

{
    "is_success": true,
    "data": {
        "requestId": "mocked_request_id",
        "result": {
            "dataFromAadhaar": {
                "generatedDateTime": "2024-02-23 09:15:00",
                "maskedAadhaarNumber": "XXXX XXXX 1234",
                "name": "John Doe",
                "dob": "1990-01-01",
                "gender": "M",
                "mobileHash": "mocked_mobile_hash",
                "emailHash": "mocked_email_hash",
                "fatherName": "James Doe",
                "address": {
                    "splitAddress": {
                        "houseNumber": "1234",
                        "street": "Mock Street",
                        "landmark": "Near Mock School",
                        "subdistrict": "Mock Subdistrict",
                        "district": "Mock District",
                        "vtcName": "Mock VTC",
                        "location": "Mock Location",
                        "postOffice": "Mock Post Office",
                        "state": "Mock State",
                        "country": "Mock Country",
                        "pincode": "123456"
                    },
                    "combinedAddress": "1234, Mock Street, Near Mock School, Mock Subdistrict, Mock District, Mock VTC, Mock Location, Mock Post Office, Mock State, Mock Country - 123456"
                },
                "message": "Aadhaar XML file downloaded successfully",
                "image": "rg",
                "mask-vid": "f",
                "file": ""
                },
                "consentValidation": {
                    "providedName": "John Doe",
                    "percentageOfMatch": 99.5,
                    "status": true
                }
            }
        },
        "statusCode": 200,
        "clientData": {
            "caseId": "mocked_case_id"
        },
        "is_mob_num_linked_with_aadhaar": true,
        "loan_request_id": "mocked_loan_request_id"
    }
}