Feel free to reach techsupport@surepass.io for any technical support or guidance.
Authorization
header as Bearer TOKEN
.https://sandbox.surepass.io
https://kyc-api.surepass.io
Header | Required | Description |
---|---|---|
Authorization | Yes | Bearer token for authentication (JWT) |
Content-Type | Yes | application/json |
Parameter | Type | Required | Description |
---|---|---|---|
id_number | String | Yes | The ration card number to be verified |
state_portal | String | Conditional | State name for verification. Required only for Karnataka state (value: "karnataka"). For all other states, use "central" or omit this parameter |
{
"id_number": "10140100006004000000",
"state_portal": "central"
}
Parameter | Type | Description |
---|---|---|
data | Object | Contains all the verification details |
data.client_id | String | Unique identifier for the client request |
data.id_number | String | The ration card number that was verified |
data.state_portal | String | The state portal used for verification |
data.state_name | String | Name of the state the ration card belongs to |
data.district_name | String | Name of the district the ration card belongs to |
data.fps_id | String | Fair Price Shop identifier associated with the ration card |
data.scheme_name | String | Name of the scheme (e.g., PHH, AAY) |
data.dup_uid_status | String | Status indicating if duplicate UIDs exist |
data.member_details_list | Array | List of members associated with the ration card |
data.member_details_list[].member_id | String | Unique identifier for each member |
data.member_details_list[].member_name | String | Name of the member |
data.member_details_list[].uid_status | Boolean | UID status of the member |
data.member_details_list[].masked_aadhaar | String | Masked Aadhaar number (if available) |
data.member_details_list[].relationship_name | String | Relationship to the ration card holder |
status_code | Integer | HTTP status code of the response |
success | Boolean | Indicates if the request was successful |
message | String | Response message |
message_code | String | Code representing the response message |
{
"data": {
"client_id": "ration_card_LqcwSxyPrnrKsnJjRwaD",
"id_number": "10140100006004000005",
"state_portal": "central",
"state_name": "BIHAR",
"district_name": "MUZAFFARPUR",
"fps_id": "121600100663",
"scheme_name": "PHH",
"dup_uid_status": "No",
"member_details_list": [
{
"member_id": "1014010000600400000501",
"member_name": "JAVANTI DEVI",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SELF"
},
{
"member_id": "1014010000600400000502",
"member_name": "RAMLAKSHAN RAI",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "NOT AVAILABLE"
},
{
"member_id": "1014010000600400000504",
"member_name": "SAJAN KUMAR",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SON"
},
{
"member_id": "1014010000600400000505",
"member_name": "VIRSAN KUMAR",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SON"
}
]
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
{
"status_code": 400,
"success": false,
"message": "Invalid ration card number",
"message_code": "invalid_ration_card"
}
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ration-card/verify' \
--header 'Content-Type: application/json' \
--data-raw '{
"id_number": "10140100006004000000",
"state_portal": "central"
}'
{
"data": {
"client_id": "ration_card_LqcwSxyPrnrKsnJjRwaD",
"id_number": "10140100006004000005",
"state_portal": "central",
"state_name": "BIHAR",
"district_name": "MUZAFFARPUR",
"fps_id": "121600100663",
"scheme_name": "PHH",
"dup_uid_status": "No",
"member_details_list": [
{
"member_id": "1014010000600400000501",
"member_name": "JAVANTI DEVI",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SELF"
},
{
"member_id": "1014010000600400000502",
"member_name": "RAMLAKSHAN RAI",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "NOT AVAILABLE"
},
{
"member_id": "1014010000600400000504",
"member_name": "SAJAN KUMAR",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SON"
},
{
"member_id": "1014010000600400000505",
"member_name": "VIRSAN KUMAR",
"uid_status": true,
"masked_aadhaar": null,
"relationship_name": "SON"
}
]
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}