> For the complete documentation index, see [llms.txt](https://docs.tutelar.io/tutelar-api-document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tutelar.io/tutelar-api-document/business-profile/credit-bureau-check.md).

# Credit Bureau Check

The API supports the evaluation of an individual's credit health, delivering essential information for evaluating loan eligibility and managing financial risk. Efficiency and Accuracy: This API simplifies credit data retrieval, offering accurate, timely information that enhances decision-making processes and reduces the time spent on manual credit assessments.

## `credit_bureau_check`

<mark style="color:green;">`POST`</mark> `https://secctrl.tutelar.io/api/v1/services/business_profile/credit_bureau_check`

#### Sample Request Body

<table><thead><tr><th width="145.46484375">Body</th><th width="90.90234375">Type</th><th width="120.5625">Mandatory</th><th width="347.33984375">Description</th></tr></thead><tbody><tr><td>panNumber</td><td>string</td><td>Yes</td><td>The PAN (Permanent Account Number) of the individual.</td></tr><tr><td>phoneNumber</td><td>string</td><td>Yes</td><td>The phone number of the individual for whom the credit report is requested.</td></tr><tr><td>pinCode</td><td>string</td><td>Yes</td><td>Pincode of the user.</td></tr><tr><td>dob</td><td>string</td><td>Yes</td><td>Date of Birth of the user.<br>Format: yyyy-mm-dd</td></tr><tr><td>firstName</td><td>string</td><td>Yes</td><td>The first name of the individual.</td></tr><tr><td>lastName</td><td>string</td><td>Yes</td><td>The last name of the individual.</td></tr><tr><td>consent</td><td>string</td><td>Yes</td><td>Your consent to Tutelar processing your information for verification and compliance purposes only.</td></tr></tbody></table>

#### Sample Post Parameters

```json
{
    "panNumber": "MDQPS602xx",
    "phoneNumber": "93601040xx",
    "pinCode": "600001",
    "dob": "2001-07-08",
    "firstName": "Siva",
    "lastName": "Manikandan",
    "consent": "Y"
}
```

{% tabs %}
{% tab title="200: Success Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "6a732ac4-2852-4c7f-a72c-dc08a5714bef",
    "status": "completed",
    "result": {
        "currentApplicationDetails": {
            "firstName": "Siva",
            "lastName": "Manikandan",
            "gender": "Male",
            "dob": "19870811",
            "telephoneNumberApplicant1st": "",
            "mobilePhoneNumber": 9360104074,
            "emailId": "sivamani072001@gmail.com",
            "incomeTaxPan": "MDQPS6020K",
            "enquiryReason": 6,
            "financePurpose": "",
            "amountFinanced": 0,
            "durationOfAgreement": 0
        },
        "excelUrl": "http://3.108.106.182:8000/image-pub/kyc/TUTWEBK00xxx/creditBureauCheckDocuments/credit_bureau_1783496593180-178349659xxx.xlsx"
    },
    "requested_at": "2026-07-08T07:43:01.386Z",
    "completed_at": "2026-07-08T07:43:14.444Z"
}
```

{% endtab %}

{% tab title="200 : In progress" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "d1bbfb97-c82f-475d-b666-07e7b258f3da",
    "status": "in_progress",
    "requested_at": "2026-07-08T07:43:14.444Z",
}
```

{% endtab %}

{% tab title="400: Validation Error Response" %}

```json
{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "PAN Number should not be empty",
        "field": "panNumber",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Date of birth should not be empty",
        "field": "dob",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Pincode should not be empty",
        "field": "pinCode",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Date of birth should not be empty",
        "field": "dob",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "First Name should not be empty",
        "field": "firstName",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Last Name should not be empty",
        "field": "lastName",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Invalid PAN number",
        "field": "panNumber",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "phone Number must contain exactly 10 digits",
        "field": "phoneNumber",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Pincode must contain exactly 6 digits",
        "field": "pinCode",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Invalid date of birth format. Use YYYY-MM-DD.",
        "field": "dob",
        "code": "BAD_REQUEST"
    } 
} 

 {
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "First Name must be between 3 and 50 characters",
        "field": "firstName",
        "code": "BAD_REQUEST"
    }
}

 {
    "success": false,
    "code": 400,
    "message": "Invalid input. Please check your request and try again.",
    "error": {
        "message": "Last Name must be between 3 and 50 characters",
        "field": "lastName",
        "code": "BAD_REQUEST"
    }
}      
{
    "success": false,
    "code": 400,
    "message": "Consent should not be empty",
    "error": {
        "message": "Consent should not be empty",
        "field": "consent",
        "code": "BAD_REQUEST"
    }
}

{
    "success": false,
    "code": 400,
    "message": "consent must be 'Y'",
    "error": {
        "message": "consent must be 'Y'",
        "field": "consent",
        "code": "BAD_REQUEST"
    }
}
```

{% endtab %}

{% tab title="200: Failure Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "548025c4-9528-4502-958a-5b1226a63a60",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2026-07-08T07:43:14.444Z",
    "completed_at": "2026-07-08T07:43:15.444Z"
}

```

{% endtab %}
{% endtabs %}

## Get details

<mark style="color:blue;">`GET`</mark> `https://secctrl.tutelar.io/api/v1/services/business_profile/credit_bureau_check`

### Query parameters description is given below,

<table><thead><tr><th width="197">Query Parameter </th><th width="139">Type</th><th>Is  Mandatory</th><th>Description</th></tr></thead><tbody><tr><td>reference_id </td><td>String </td><td>Yes </td><td>Document reference id</td></tr></tbody></table>

{% tabs %}
{% tab title="200: Success Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request has been successfully completed.",
    "reference_id": "6a732ac4-2852-4c7f-a72c-dc08a5714bef",
    "status": "completed",
    "result": {
        "currentApplicationDetails": {
            "firstName": "Siva",
            "lastName": "Manikandan",
            "gender": "Male",
            "dob": "19870811",
            "telephoneNumberApplicant1st": "",
            "mobilePhoneNumber": 9360104074,
            "emailId": "sivamani072001@gmail.com",
            "incomeTaxPan": "MDQPS6020K",
            "enquiryReason": 6,
            "financePurpose": "",
            "amountFinanced": 0,
            "durationOfAgreement": 0
        },
        "excelUrl": "http://3.108.106.182:8000/image-pub/kyc/TUTWEBK00xxx/creditBureauCheckDocuments/credit_bureau_1783496593180-178349659xxx.xlsx"
    },
    "requested_at": "2026-07-08T07:43:01.386Z",
    "completed_at": "2026-07-08T07:43:14.444Z"
}
```

{% endtab %}

{% tab title="200: In progress Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request is being processed. Please wait for completion.",
    "reference_id": "d1bbfb97-c82f-475d-b666-07e7b258f3da",
    "status": "in_progress",
    "requested_at": "2026-07-08T07:43:14.444Z",
}
```

{% endtab %}

{% tab title="200: Failure Response" %}

```json
{
    "success": true,
    "code": 200,
    "message": "The request could not be completed due to an error.",
    "reference_id": "548025c4-9528-4502-958a-5b1226a63a60",
    "status": "failed",
    "error": {
        "message": "Invalid details were provided. Please submit valid details.",
        "code": "ERROR"
    },
    "requested_at": "2026-07-08T07:43:14.444Z",
    "completed_at": "2026-07-08T07:43:15.444Z"
}
```

{% endtab %}
{% endtabs %}