X-API-KEY and X-API-Secret.https://api.finpass.ai| Header | Required | Description |
|---|---|---|
| Content-Type | Yes | Must be set to application/json. |
| X-API-KEY | Yes | Your unique API key issued by Finpass. |
| X-API-Secret | Yes | Your API secret issued by Finpass for request authentication. |
| Parameter | Type | Required | Description |
|---|---|---|---|
| business_name | string | Yes | The registered name of the business entity. Must be at least 2 characters long. |
| pan | string | Yes | The 10-character PAN (Permanent Account Number) of the business. Format: ABCDE1234F (5 uppercase letters, 4 digits, 1 uppercase letter). |
| consent | string | No | Indicates whether the user has provided consent to fetch the credit report. Accepted values: Y (Yes) or N (No). Defaults to Y. |
| report_type | string | No | The format in which the credit report should be returned. Only html is currently supported. Defaults to html. |
{
"business_name": "Acme Pvt Ltd",
"pan": "ABCDE1234F",
"consent": "Y",
"report_type": "html"
}| Parameter | Type | Description |
|---|---|---|
| status | string | Indicates the status of the API request (e.g., success or failed). |
| message | string | A human-readable message describing the outcome of the request. |
| data | object | Contains the credit report details and metadata. |
| data.business_name | string | The business name as submitted in the request. |
| data.pan | string | The PAN submitted in the request. |
| data.report_type | string | The format of the returned report. Currently always html. |
| data.report | string | The credit report content as an HTML string, ready to be rendered in a browser or web application. |
| data.report_url | string | A URL to download or view the generated credit report. |
| data.generated_at | string | ISO 8601 timestamp indicating when the report was generated. |
{
"status": "success",
"message": "Credit report fetched successfully",
"data": {
"business_name": "Acme Pvt Ltd",
"pan": "ABCDE1234F",
"report_type": "html",
"report": "<html>...credit report content...</html>",
"report_url": "https://api.finpass.ai/reports/abc123.html",
"generated_at": "2026-05-21T10:30:00Z"
}
}{
"status": "failed",
"message": "Invalid PAN format. Expected format: ABCDE1234F",
"error_code": "INVALID_PAN"
}X-API-KEY and X-API-Secret) in secure environment variables or a secrets manager; never hard-code them in source code or expose them in client-side applications.consent field must reflect actual user authorization.curl --location 'https://api.finpass.ai/api/v1/services/credit-report-commercial/fetch' \
--header 'x-api-key;' \
--header 'x-api-secret;' \
--header 'Content-Type: application/json' \
--data '{
"business_name": "Acme Pvt Ltd",
"pan": "ABCDE1234F",
"consent": "Y",
"report_type": "html"
}'{}