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 here require 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
• Authentication: Required (API Key)
• Headers:
  • X-API-Key: <your_api_key>
  • Content-Type: multipart/form-data

Request Payload

Field	Type	Description
file	File	The credit report document (.pdf, max 10MB).

cURL

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

Python

import requests

url = "https://api.riskinmind.ai/api/v1/reports/credit-report"
headers = {
    "X-API-Key": "YOUR_API_KEY"
}
files = {
    "file": open("credit_report.pdf", "rb")
}

response = requests.post(url, headers=headers, files=files)
with open("credit_report_summary.pdf", "wb") as f:
    f.write(response.content)

JavaScript

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 = window.URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = 'credit_report.pdf';
document.body.appendChild(link);
link.click();

Response

• Content-Type: application/pdf
• Returns: A binary PDF stream representing 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, outputting a PDF report.

• Method: POST
• Endpoint: /api/v1/reports/tax-statement
• Authentication: Required (API Key)
• Headers:
  • X-API-Key: <your_api_key>
  • Content-Type: multipart/form-data

Request Payload

Field	Type	Description
file	File	Tax document (.pdf, max 10MB).

cURL

curl -X POST https://api.riskinmind.ai/api/v1/reports/tax-statement \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/tax_return.pdf" --output tax_report.pdf

Python

import requests

url = "https://api.riskinmind.ai/api/v1/reports/tax-statement"
headers = {
    "X-API-Key": "YOUR_API_KEY"
}
files = {
    "file": open("tax_return.pdf", "rb")
}

response = requests.post(url, headers=headers, files=files)
with open("tax_report.pdf", "wb") as f:
    f.write(response.content)

JavaScript

const formData = new FormData();
formData.append('file', fileInput.files[0]);

const response = await fetch('https://api.riskinmind.ai/api/v1/reports/tax-statement', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: formData
});

const blob = await response.blob();
const url = window.URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = 'tax_report.pdf';
document.body.appendChild(link);
link.click();

Response

• Content-Type: application/pdf
• Returns: A binary PDF stream representing 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, returned as a PDF.

• Method: POST
• Endpoint: /api/v1/reports/bank-statement
• Authentication: Required (API Key)
• Headers:
  • X-API-Key: <your_api_key>
  • Content-Type: multipart/form-data

Request Payload

Field	Type	Description
file	File	The Bank Statement document (.pdf, max 10MB).

cURL

curl -X POST https://api.riskinmind.ai/api/v1/reports/bank-statement \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/bank_statement.pdf" --output bank_report.pdf

Python

import requests

url = "https://api.riskinmind.ai/api/v1/reports/bank-statement"
headers = {
    "X-API-Key": "YOUR_API_KEY"
}
files = {
    "file": open("bank_statement.pdf", "rb")
}

response = requests.post(url, headers=headers, files=files)
with open("bank_report.pdf", "wb") as f:
    f.write(response.content)

JavaScript

const formData = new FormData();
formData.append('file', fileInput.files[0]);

const response = await fetch('https://api.riskinmind.ai/api/v1/reports/bank-statement', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  },
  body: formData
});

const blob = await response.blob();
const url = window.URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = 'bank_report.pdf';
document.body.appendChild(link);
link.click();

Response

• Content-Type: application/pdf
• Returns: A binary PDF stream representing the generated bank statement analysis report.