API reference / Credit
Credit bureau report
Credit bureau report by PAN, name, date of birth, mobile and pincode. The consumer's consent is required (given, timestamp, the IP they consented from); every pull is audited and fires a consumer alert.
POST
/v1/credit/bureau-report- Authentication
- Bearer token
- Scope
credit:read
Before you integrate
- The consumer's consent is required. Send consent.given as true, the time they consented and the IP address they consented from; a call without all three is rejected.
- Every report pulled is audited and triggers a consumer alert, so only call this for a consumer who has agreed.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
pan | string | Yes | PAN of the consumer, for example ABCDE1234F. |
first_name | string | Yes | First name, 1 to 60 characters. |
last_name | string | Yes | Last name, 1 to 60 characters. |
dob | string | Yes | Date of birth, a past date as YYYY-MM-DD, DD/MM/YYYY or DD-MM-YYYY. |
mobile | string | Yes | 10-digit Indian mobile number starting 6 to 9; a leading +91, 91 or 0 and spaces are ignored. |
pincode | string | Yes | Six-digit pincode of the consumer's address; a number is also accepted. |
consent | object | Yes | The consumer's consent to the report being pulled. |
consent.given | boolean | Yes | Must be true. |
consent.timestamp | string | Yes | When the consumer consented: an ISO 8601 time with offset, such as 2026-11-05T10:00:00+05:30, or a Unix time in seconds or milliseconds. It cannot be in the future. |
consent.ip_address | string | Yes | The IPv4 or IPv6 address the consumer consented from. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/credit/bureau-report' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pan": "ABCDE1234F",
"first_name": "Asha",
"last_name": "Rao",
"dob": "1990-08-17",
"mobile": "9876543210",
"pincode": "411001",
"consent": {
"given": true,
"timestamp": "2026-11-05T10:00:00+05:30",
"ip_address": "203.0.113.10"
}
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"status_code": 200,
"message": "Success",
"data": {
"json_bureau_report": {
"header": {
"system_code": 0,
"message_text": "Success",
"report_date": 20261105,
"report_time": 100005
},
"credit_profile_header": {
"report_date": 20261105,
"report_time": 100005,
"version": "V2.4",
"report_number": 1234567
},
"cais_account": {
"cais_summary": {
"credit_account": {
"credit_account_total": "5",
"credit_account_active": "4",
"credit_account_default": "0",
"credit_account_closed": "1"
},
"total_outstanding_balance": {
"outstanding_balance_all": "450000"
}
},
"cais_account_details": [
{
"subscriber_name": "EXAMPLE BANK",
"account_type": "10",
"open_date": 20220115,
"current_balance": 120000,
"amount_past_due": 0
}
],
"score": {
"fcirexscore": 742
}
}
}
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
status_code | number | Status code of the report. |
message | string | Message about the report. |
data | object | The report. |
data.json_bureau_report | object | The credit bureau report. |
data.json_bureau_report.header | object | Report header with system_code, message_text, report_date and report_time. |
data.json_bureau_report.credit_profile_header | object | Report number, version and date. |
data.json_bureau_report.current_application | object | The application details the report was pulled for. |
data.json_bureau_report.cais_account | object | The consumer's credit accounts. |
data.json_bureau_report.cais_account.cais_summary | object | Totals across all accounts. |
data.json_bureau_report.cais_account.cais_summary.credit_account | object | Counts of total, active, defaulted and closed accounts. |
data.json_bureau_report.cais_account.cais_summary.total_outstanding_balance | object | Outstanding balance, split into secured and unsecured. |
data.json_bureau_report.cais_account.cais_account_details | array | One entry per account, with lender, type, open date, balances, amount past due and payment history. |
data.json_bureau_report.cais_account.score | object | The consumer's bureau score. |
data.json_bureau_report.excel_bureau_report | string | A spreadsheet version of the report, as returned. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.