---
title: "Credit Report"
method: GET
path: "/v1/financial-services/credit-bureau/credit-report"
tags: ["Financial Services"]
---

# Credit Report

`GET /v1/financial-services/credit-bureau/credit-report`

## Request

- Base URL: `https://api.deepvue.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.deepvue.ai/v1/financial-services/credit-bureau/credit-report`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `authorize`
- TypeScript: <https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/docs/v1/financial-services/credit-bureau/credit-report/get.ts> (a function with typed inputs; its response is checked against the schema)

Credit Bureau is an agency that collects information related to the credit ratings of individuals and makes it available to financial companies, banks, and other legal authorities.

The Credit Report API gives information about a person's credit. It fetches credit reports using detailed parameters.   
Our partner bureaus - Equifax and more in the pipeline.

## Query parameters

- `full_name` string, required
- `pan_number` string, required
- `mobile_number` string, required
- `consent` string, required
- `purpose` string, required
- `generate_pdf` boolean

## Response `200`

Successful Response

- union
  - RESPONSECREDITREPORT
    - `code` integer, required
    - `timestamp` integer
    - `transaction_id` string
    - `sub_code` string
    - `message` string, required
    - `data` CreditReportData
      - `pan` string
      - `mobile` string
      - `name` string
      - `credit_score` string
      - `credit_report` object, required
      - `pdf_url` string
      - `total_sanctioned_amount` string
      - `active_loan_summary` object[]
      - `emi_summary` object
  - CREDITREPORTNORECORD
    - `code` integer
    - `timestamp` integer, required
    - `transaction_id` string, required
    - `sub_code` string
    - `message` string
  - INVALIDPANPLUS
    - `code` integer
    - `timestamp` integer, required
    - `transaction_id` string, required
    - `sub_code` string
    - `message` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide.md) - [All operations](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/llms.txt) - [OpenAPI document](https://skmtc.dev/deepvue/apis/deepvue-tech-developers-guide/revisions/c1b0558e7d77?raw)