x-api-key and x-api-secret.| Header | Description |
|---|---|
x-api-key | Your unique API key provided by Finpass upon registration. |
x-api-secret | Your API secret paired with the API key for authenticated access. |
https://api.finpass.ai| Header | Required | Description |
|---|---|---|
| x-api-key | Yes | Your unique API key for authentication. Provided by Finpass during registration. |
| x-api-secret | Yes | Your API secret paired with the API key. Provided by Finpass during registration. |
| Content-Type | Yes | Must be set to application/json |
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | Yes | Unique identifier for the client/customer in the Account Aggregator system. Format: account_aggregator_v2_{unique_id} |
| request_id | string | Conditional | Unique identifier for the consent request obtained from the Refresh Data endpoint (/api/v1/account-aggregator/refresh-data). Required for loan_monitoring flow. Optional for loan_underwriting flow. |
{
"client_id": "aa_6989cbcf_a136a40db8abb6b691067",
"request_id": "account_aggregator_v2_ojmzgkXAqwzTroKp"
}| Parameter | Type | Description |
|---|---|---|
| data | object | Container object for the response data |
| data.client_id | string | Echo of the client_id from the request |
| data.reports | array | Array of report objects, one for each FIP/account combination |
| data.reports[].fip_id | string | Financial Information Provider identifier (e.g., "HDFC-FIP", "SBI-FIP") |
| data.reports[].account_number | string | Masked account number for privacy (e.g., "XXXXXXXXXX1234") |
| data.reports[].status | string | Report generation status. Values: "READY", "PENDING", "FAILED" |
| data.reports[].statement_report_link | string | Pre-signed URL to download the PDF report. Valid for limited time |
| status_code | integer | HTTP status code (200 for success) |
| success | boolean | Indicates whether the request was successful |
| message | string | Human-readable response message |
| message_code | string | Machine-readable message code for programmatic handling |
{
"data": {
"client_id": "account_aggregator_v2_oOxRfypvwDqMjti",
"reports": [
{
"fip_id": "HDFC-FIP",
"account_number": "XXXXXXXXXX1234",
"status": "READY",
"statement_report_link": "https://example.com/dummy-report-1.pdf?dummy_signature=1234567890abcdef"
},
{
"fip_id": "SBI-FIP",
"account_number": "XXXXXXXX9876",
"status": "READY",
"statement_report_link": "https://example.com/dummy-report-2.pdf?dummy_signature=abcdef1234567890"
}
]
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}{
"data": null,
"status_code": 404,
"success": false,
"message": "Client not found",
"message_code": "client_not_found"
}x-api-key and x-api-secret securely using environment variables or a secrets manager (e.g., AWS Secrets Manager, HashiCorp Vault). Never hardcode credentials in source code or expose them in client-side applications.curl --location --request POST 'https://api.finpass.ai/api/v1/services/account-aggregator/fetch-statement-pdf' \
--header 'X-API-Key: M5RwMtvbYGqAGZpG8d223xkEq1298kjcGGpJ7s7_' \
--header 'X-API-Secret: LG8zVXK1MZv1jP6i4l6QZQ2nD9kLTvFWipV_anPvacE' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_id": "aa_oOx8989898RfypvwDqMjti"
}'{
"success": true,
"status_code": 200,
"message": "Success",
"data": {
"client_id": "aa_69873a09_e75a2206a8f9cd71212f32533",
"reports": [
{
"fip_id": "FDRLFIPPROD",
"account_number": "XXXXXXXXXX8517",
"status": "READY",
"statement_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/tanishq1_console/account_aggregator_v2/account_aggregator_v2_jNhDbRpotzkekYxLONgs/account_aggregator_v2_1770470141502632.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5KVPBYKKE%2F20260216%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20260216T100109Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=884fe071fa7df6ca64a74230db897fa649b4decef6"
},
{
"fip_id": "ICICI-FIP",
"account_number": "XXXXXXXX1326",
"status": "READY",
"statement_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/tanishq1_console/account_aggregator_v2/account_aggregator_v2_jNhDbRpotzkekYxLONgs/account_aggregator_v2_1770470149718842.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5KVPBYKKE%2F20260216%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20260216T100109Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=1ba173ca5d6e4aabe554616d3a913643e24a7be44c8f625"
}
]
}
}