Skip to main content

Reports (/api/v1/reports)

Endpoints for extracting intelligence from uploaded financial documents and generating structured 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.

  • Method: POST
  • Endpoint: /api/v1/reports/credit-report
  • Authentication: Required (Bearer Token)
  • Headers: Content-Type: multipart/form-data

Request Payload​

  • file: The credit report document (.pdf, .png, .jpg supported, max 10MB).
  • loanId (optional): To associate the generated report with a specific application.

Response​

{
  "success": true,
  "data": {
    "creditScore": 720,
    "totalDebt": 12500,
    "inquiries": 2,
    "delinquencies": 0
  }
}

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
  • Authentication: Required (Bearer Token)
  • Headers: Content-Type: multipart/form-data

Request Payload​

  • file: Tax document (.pdf, max 10MB).
  • loanId (optional): The associated loan ID.

Response​

{
  "success": true,
  "data": {
    "agi": 85000,
    "totalTaxesPaid": 15000,
    "wages": 75000,
    "businessIncome": 10000
  }
}

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
  • Authentication: Required (Bearer Token)
  • Headers: Content-Type: multipart/form-data

Request Payload​

  • file: The Bank Statement document (.pdf, max 10MB).
  • loanId (optional): Associated loan ID.

Response​

{
  "success": true,
  "data": {
    "averageDailyBalance": 4500.50,
    "endingBalance": 3200.00,
    "totalDeposits": 12000.00,
    "totalWithdrawals": 8800.00,
    "nsfCount": 0
  }
}