improved

Changes in Aadhaar OKYC API

We have improved the API requests and responses for ease of use for the users.

πŸ“˜

This is a versioned change


You need to pass x-api-version as 2.0 to access the updated API. The existing version is marked deprecated. The API documentation has been updated as per this version.

Changes in Request Body

  • The following Keys have been added
    • @entity
    • consent
    • reason
{
    "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.request",
    "aadhaar_number": "99999999999",
    "consent": "Y",
    "reason": "For KYC of the Individual"
}
{
    "aadhaar_number": "99999999999"
}

Changes in Response

  • The following Keys have been added
    • @entity
  • The following Keys have been renamed
    • ref_id is now reference_id
{
    "code": 200,
    "timestamp": 1713426154458,
    "transaction_id": "c9431c86-868c-4208-b71e-ea90c7bed435",
    "data": {
        "@entity": "in.co.sandbox.kyc.aadhaar.okyc.otp.response",
        "reference_id": "1234567",
        "message": "OTP sent successfully"
    }
}
{
    "code": 200,
    "timestamp": 1713426154458,
    "transaction_id": "c9431c86-868c-4208-b71e-ea90c7bed435",
    "data": {,
        "ref_id": "1234567",
        "message": "OTP sent successfully"
    }
}

Changes in Request Body

  • The following Keys have been added
    • @entity
  • The following Keys have been renamed
    • ref_id is now reference_id
{
    "@entity": "in.co.sandbox.kyc.aadhaar.okyc.request",
    "reference_id": "1234567",
    "otp": "121212"
}
{
    "ref_id": "1234567",
    "otp": "121212"
}

Changes in Response

  • The following Keys have been added
    • share_code
  • The following Keys have been renamed
    • ref_id is now reference_id
    • dob is now date_of_birth
    • dist is now district
    • po is now post_office
    • subdist is now subdistrict
    • address is now full_address
    • split_address is now address
    • email is now email_hash
    • photo_link is now photo
    • @entity value has changed
{
    "code": 200,
    "timestamp": 1713426154458,
    "transaction_id": "c9431c86-868c-4208-b71e-ea90c7bed435",
    "data": {
        "@entity": "in.co.sandbox.kyc.aadhaar.okyc",
        "reference_id": "1234567",
        "status": "VALID",
        "message": "Aadhaar Card Exists",
        "care_of": "S/O: Johnny Doe",
        "full_address": "Mangal Kanaka Niwas, Main Cross 3rd, Bengaluru, Bengaluru-Karnataka, India ",
        "date_of_birth": "21-04-1985",
        "email_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
        "gender": "M",
        "name": "John Doe",
        "address": {
            "@entity": "in.co.sandbox.kyc.aadhaar.okyc.address",
            "country": "India",
            "district": "Bengaluru",
            "house": "Mangal Kanaka Niwas",
            "landmark": "",
            "pincode": "581615",
            "post_office": "Bengaluru",
            "state": "Karnataka",
            "street": "Main Cross 3rd",
            "subdistrict": "",
            "vtc": "Bengaluru"
        },
        "year_of_birth": "1985",
        "mobile_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
        "photo": "data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q==",
        "share_code": "2356"
    }
}
{
    "code": 200,
    "timestamp": 1713426154458,
    "transaction_id": "c9431c86-868c-4208-b71e-ea90c7bed435",
    "data": {
        "@entity": "@in.co.sandbox.kyc.aadhaar",
        "ref_id": "1234567",
        "status": "VALID",
        "message": "Aadhaar Card Exists",
        "care_of": "S/O: Johnny Doe",
        "address": "Mangal Kanaka Niwas, Main Cross 3rd, Bengaluru, Bengaluru-Karnataka, India ",
        "dob": "21-04-1985",
        "email": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
        "gender": "M",
        "name": "John Doe",
        "split_address": {
            "@entity": "@in.co.sandbox.kyc.aadhaar.split_address",
            "country": "India",
            "dist": "Bengaluru",
            "house": "Mangal Kanaka Niwas",
            "landmark": "",
            "pincode": "581615",
            "po": "Bengaluru",
            "state": "Karnataka",
            "street": "Main Cross 3rd",
            "subdist": "",
            "vtc": "Bengaluru"
        },
        "year_of_birth": "1985",
        "mobile_hash": "044917e2c4c62a439d068.......d9f71bbde10b1d227a914e",
        "photo_link": "data:image/jpeg;base64,/9j/4AAQSk.......mj/2Q=="
    }
}