Disability Certificate

Endpoint Overview

POST /api/v1/disability/

Description

This API endpoint allows you to retrieve comprehensive disability certificate information using a Unique Disability ID (UDID). It provides detailed personal information, address details, disability specifics, education, employment status, and identity verification data for individuals with disabilities. This information can be used for verification purposes, service eligibility assessment, and to streamline disability-related processes.

Key Benefits

Instant verification of disability certificate authenticity

Access to comprehensive disability-related information in a single API call

Reduces manual verification processes and paperwork

Helps ensure compliance with disability-related regulations and policies

Use Cases

Financial Services

Government Services

Healthcare

Verify disability status for special financial product eligibility

Validate disability information for insurance claims processing

Confirm disability details for loan application concessions

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for authentication. Format: `Bearer {your_jwt_token}`
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
disability_udid	String	Yes	Unique Disability ID (UDID) number of the individual to retrieve information for

Example Request

{
    "disability_udid": "MP1710619720001711"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all disability certificate information
data.client_id	String	Unique identifier for the client
data.personal_details	Object	Personal information of the individual with disability
data.correspondance_addr	Object	Correspondence address details
data.permanent_addr	Object	Permanent address details
data.education_detail	Object	Educational qualification information
data.disability_details	Object	Details about the disability type and related information
data.employment_details	Object	Employment and income information
data.identity_details	Object	Identity verification information
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the API call was successful
message	String	Response message
message_code	String	Code representing the response message

Example Successful Response

{
    "data": {
        "client_id": "disability_id_dyRAjARxXRsguHnsNYjl",
        "personal_details": {
            "udid_number": "MP1710619720001711",
            "enrolment_no :": "2317/00000/1609/5494111",
            "name_of_applicant": "Sanjay  Chouhan",
            "applicant_father_name": "Atmaram chouhan",
            "applicant_mother_name": "Santosh bai chouhan",
            "date_of_birth": "05/06/1972",
            "gender": "Male",
            "mark_of_identification": "Right leg disabled",
            "category": "SC",
            "blood_group": "O+",
            "marital_status": "Married",
            "relation_with_pwd": "",
            "contact_no_guardian": "",
            "application_status": "UDID Card Dispatched to PwD",
            "age": "44 Year(s)",
            "email_id": "",
            "mobile_number ": "9926018177",
            "spouse_name": "Anita chouhan",
            "name_of_guardian": "",
            "caste_certificate": "image_base_64/ file_base_64"
        },
        "correspondance_addr": {
            "address_line_1 ": "House no. -18",
            "Address_line_2": "Ward no. - 1",
            "Address_line_3": "Pramilaganj",
            "state": "Madhya Pradesh",
            "city": "Alot",
            "pincode": "457114",
            "district": "Ratlam",
            "village": "",
            "nature_of_document_for_address_proof": "Aadhaar card",
            "proof_of_corrospondance_addr": "image_base_64/ file_base_64"
        },
        "permanent_addr": {
            "address_line_1 ": "House no. -18",
            "address_line_2": "Ward no. - 1",
            "address_line_3": "Pramilaganj",
            "state": "Madhya Pradesh",
            "city": "Alot",
            "district": "Ratlam",
            "village": "",
            "pincode": "457114"
        },
        "education_detail": {
            "highest_qualification": "Higher Secondary"
        },
        "disability_details": {
            "Do_you_have_disability_certificate": "No",
            "disability_area": "",
            "pension_card_number": "",
            "disability_since": "1972",
            "hospital": "",
            "disability_type  ": " Locomotor Disability",
            "hospital_treating_disability": "",
            "disability_due_to": "Accident"
        },
        "employment_details": {
            "employed_or_unemployed ": "Employed",
            "bpl_apl": "APL",
            "spouse_income": "Below 10000",
            "occupation": "Private Jobs",
            "personal_income": "From 10000 To 100000"
        },
        "identity_details": {
            "identity_proof ": "Aadhaar Card",
            "tin": "",
            "any_other_state": "Samagra State ID",
            "identity_proof": "image_base_64/ file_base_64",
            "adhaar_no": "406422732332"
        }
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid UDID

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid UDID number provided",
    "message_code": "invalid_udid"
}

This error occurs when the provided UDID number is not valid or does not exist in the system.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

Use HTTPS for all API communications to ensure data encryption

Implement token refresh mechanisms to handle token expiration

User Experience Guidelines

Implement proper loading states while waiting for API responses

Cache responses when appropriate to improve performance

Display user-friendly error messages when API calls fail

Provide clear instructions for corrective actions when validation fails

Code Samples

cURL

Python

Node.js

Related APIs

PAN Verification API: Verify PAN card details for identity verification

Aadhaar Verification API: Verify Aadhaar card details for identity verification

Address Verification API: Verify address information for individuals

Compliance and Legal Considerations

This API provides access to sensitive personal information and disability data. Ensure your use complies with relevant data protection regulations, including but not limited to the Rights of Persons with Disabilities Act, 2016 (India), and applicable data privacy laws. Always obtain proper consent before accessing or processing this information, and implement appropriate data security measures.

{ "data": { "client_id": "disability_id_dyRAjARxXRsguHnsNYjl", "personal_details": { "udid_number": "MP1710619720001711", "enrolment_no :": "2317/00000/1609/5494111", "name_of_applicant": "Sanjay Chouhan", "applicant_father_name": "Atmaram chouhan", "applicant_mother_name": "Santosh bai chouhan", "date_of_birth": "05/06/1972", "gender": "Male", "mark_of_identification": "Right leg disabled", "category": "SC", "blood_group": "O+", "marital_status": "Married", "relation_with_pwd": "", "contact_no_guardian": "", "application_status": "UDID Card Dispatched to PwD", "age": "44 Year(s)", "email_id": "", "mobile_number ": "9926018177", "spouse_name": "Anita chouhan", "name_of_guardian": "", "caste_certificate": "image_base_64/ file_base_64" }, "correspondance_addr": { "address_line_1 ": "House no. -18", "Address_line_2": "Ward no. - 1", "Address_line_3": "Pramilaganj", "state": "Madhya Pradesh", "city": "Alot", "pincode": "457114", "district": "Ratlam", "village": "", "nature_of_document_for_address_proof": "Aadhaar card", "proof_of_corrospondance_addr": "image_base_64/ file_base_64" }, "permanent_addr": { "address_line_1 ": "House no. -18", "address_line_2": "Ward no. - 1", "address_line_3": "Pramilaganj", "state": "Madhya Pradesh", "city": "Alot", "district": "Ratlam", "village": "", "pincode": "457114" }, "education_detail": { "highest_qualification": "Higher Secondary" }, "disability_details": { "Do_you_have_disability_certificate": "No", "disability_area": "", "pension_card_number": "", "disability_since": "1972", "hospital": "", "disability_type ": " Locomotor Disability", "hospital_treating_disability": "", "disability_due_to": "Accident" }, "employment_details": { "employed_or_unemployed ": "Employed", "bpl_apl": "APL", "spouse_income": "Below 10000", "occupation": "Private Jobs", "personal_income": "From 10000 To 100000" }, "identity_details": { "identity_proof ": "Aadhaar Card", "tin": "", "any_other_state": "Samagra State ID", "identity_proof": "image_base_64/ file_base_64", "adhaar_no": "406422732332", } }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Disability Certificate

Disability Certificate#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Disability Certificate

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples