Financial Reports (/api/v1/reports)
Endpoints for extracting intelligence from uploaded financial documents and generating structured PDF reports. These utilize the RiskInMind document parsers and extraction pipelines.
All endpoints require authentication via X-API-Key and consume credits (PDF_ANALYSIS).
All report endpoints use multipart/form-data with a single file upload mapped to the file field.
1. Generate Credit Report
Upload a consumer or commercial credit report PDF to extract FICO scores, trade lines, inquiries, and historical data, and download an AI-generated summary PDF report.
- Method:
POST - Endpoint:
/api/v1/reports/credit-report
Request Payload
| Field | Type | Description |
|---|---|---|
file | File | The credit report document (.pdf, max 100MB) |
- cURL
- JavaScript
curl -X POST https://api.riskinmind.ai/api/v1/reports/credit-report \
-H "X-API-Key: YOUR_API_KEY" \
-F "file=@/path/to/credit_report.pdf" --output credit_report_summary.pdf
const formData = new FormData();
formData.append('file', fileInput.files[0]);
const response = await fetch('https://api.riskinmind.ai/api/v1/reports/credit-report', {
method: 'POST',
headers: { 'X-API-Key': 'YOUR_API_KEY' },
body: formData
});
const blob = await response.blob();
const url = URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = 'credit_report.pdf';
link.click();
Response
- Content-Type:
application/pdf - Returns: Binary PDF stream of the generated credit report.
2. Generate Tax Statement Report
Upload Tax Returns (e.g., 1040, 1120, W-2s) to compute adjusted gross income, schedules, and taxable income metrics for underwriting.
- Method:
POST - Endpoint:
/api/v1/reports/tax-statement
Request Payload
| Field | Type | Description |
|---|---|---|
file | File | Tax document (.pdf, max 100MB) |
Response
- Content-Type:
application/pdf - Returns: Binary PDF stream of the generated tax analysis report.
3. Generate Bank Statement Report
Upload a single or multiple bank statements to evaluate cash flow, average daily balances, and NSF (Non-Sufficient Funds) occurrences.
- Method:
POST - Endpoint:
/api/v1/reports/bank-statement
Request Payload
| Field | Type | Description |
|---|---|---|
file | File | Bank statement document (.pdf, max 100MB) |
Response
- Content-Type:
application/pdf - Returns: Binary PDF stream of the generated bank statement analysis report.