API Documentation: HighMark Score Check

Overview

This document provides instructions on how to use the API for checking CIBIL scores. Users will need to obtain a secret key from an administrator,provide necessary details, and retrieve their CIBIL score.

Checking Highmark Score

• Endpoint: /api/checkHighMark
• Method: POST
• Authorization: Bearer Token (Use the Secret Key As Bearer Token obtained from administrator)
• Request Body:
• One is Mendatory:PanCard , Voter Id, Aadhar Number

        {
            "service_email_id": "Your Email"
            "applicant_name": "Your Full Name",
            "address":"Address",
            "city": "City",
            "state": "State",
            "pin_code": "Pin Code",
            "pan_card": "Your Pan Card Number(optional)",
            "voter_id": "Your Voter ID(optional)",
            "uid": "Your Aadhar number(optional)",
            "ration_card": "Your rationcard number",
            "dob": "Your Date of Birth (YYYY-MM-DD)",
            "mobile_no": "Your Mobile No",
        }
        

• Response:
Download Response Here:Highmark Report

Error Handling

Ensure to handle errors gracefully using appropriate HTTP status codes and error messages for invalid requests or authentication failures.

---

Checking Highmark Score

Overview

This document provides instructions on how to use the API for checking CIBIL scores. Users will need to obtain a secret key from an administrator,provide necessary details, and retrieve their CIBIL score.

• Endpoint: /api/highmark-response
• Method: POST
• Authorization: Bearer Token (Use the Secret Key As Bearer Token obtained from administrator)
• Request Body:

        {
            "referance_number": "referance_number",
            "email": "Your Email Address"
        }
        

• Response:

        {
            "name": "Your Full Name",
            "cibil_score": 750,
            "message": "CIBIL Score retrieved successfully."
        }
        

• name: Your full name.
• cibil_score: Your CIBIL score.
• message: Informational message.

Error Handling

Ensure to handle errors gracefully using appropriate HTTP status codes and error messages for invalid requests or authentication failures.