Developer documentation

Detailed reports

Create and retrieve durable, purpose-bound snapshots for manual or high-value review.

Request a report

Shell

curl "https://api.redmontcredit.com/api/v1/reports" -X POST \
  -H "Authorization: Bearer $RCN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject_id":"SUBJECT_ID",
    "purpose":"COMMERCIAL_CREDIT_REVIEW",
    "proposed_credit_amount":15000.00,
    "notes":"Case CR-2026-118; reviewed by underwriting"
  }'

The current API builds the profile synchronously and returns status READY with the report ID and content. Store the report ID in the related underwriting case.

Retrieve and retain

GET /reports/{report_id} requires reports view access. Institution users can only retrieve their institution's reports; platform administrators can retrieve any report. A missing or inaccessible report returns the same 404 response to avoid revealing its existence.

Review controls

Display the report creation time, model version, purpose, subject identity and reason codes.
Mark reports as point-in-time snapshots; do not imply they remain current indefinitely.
Record the human reviewer, independent affordability evidence and decision rationale outside RCN.
Restrict exports to authorised case participants and follow the institution's retention policy.