167 lines
4.8 KiB
Markdown
167 lines
4.8 KiB
Markdown
---
|
|
name: cra-routes
|
|
description: Handle 19 OpenAPI operation(s) under /cra for the cra route group.
|
|
---
|
|
|
|
# cra API Routes
|
|
|
|
Handle 19 OpenAPI operation(s) under /cra for the cra route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### cra_monitoring_insights_subscribe
|
|
|
|
- Operation ID: `cra_monitoring_insights_subscribe`
|
|
- Route: `POST /cra/monitoring_insights/subscribe`
|
|
- Mode: WRITE
|
|
- Summary: Subscribe to Monitoring Insights
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_monitoring_insights_unsubscribe
|
|
|
|
- Operation ID: `cra_monitoring_insights_unsubscribe`
|
|
- Route: `POST /cra/monitoring_insights/unsubscribe`
|
|
- Mode: WRITE
|
|
- Summary: Unsubscribe from Monitoring Insights
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_monitoring_insights_get
|
|
|
|
- Operation ID: `cra_monitoring_insights_get`
|
|
- Route: `POST /cra/monitoring_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve a Monitoring Insights Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_partner_insights_get
|
|
|
|
- Operation ID: `cra_partner_insights_get`
|
|
- Route: `POST /cra/partner_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve cash flow insights from the bank accounts used for income verification
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_income_insights_get
|
|
|
|
- Operation ID: `cra_check_report_income_insights_get`
|
|
- Route: `POST /cra/check_report/income_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve cash flow information from your user's banks
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_base_report_get
|
|
|
|
- Operation ID: `cra_check_report_base_report_get`
|
|
- Route: `POST /cra/check_report/base_report/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve a Base Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_pdf_get
|
|
|
|
- Operation ID: `cra_check_report_pdf_get`
|
|
- Route: `POST /cra/check_report/pdf/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve a Consumer Report as a PDF
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_create
|
|
|
|
- Operation ID: `cra_check_report_create`
|
|
- Route: `POST /cra/check_report/create`
|
|
- Mode: WRITE
|
|
- Summary: Refresh or create a Consumer Report
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_partner_insights_get
|
|
|
|
- Operation ID: `cra_check_report_partner_insights_get`
|
|
- Route: `POST /cra/check_report/partner_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve cash flow insights from partners
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_cashflow_insights_get
|
|
|
|
- Operation ID: `cra_check_report_cashflow_insights_get`
|
|
- Route: `POST /cra/check_report/cashflow_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve cash flow insights from your user's banking data
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_lend_score_get
|
|
|
|
- Operation ID: `cra_check_report_lend_score_get`
|
|
- Route: `POST /cra/check_report/lend_score/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve the LendScore from your user's banking data
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_network_insights_get
|
|
|
|
- Operation ID: `cra_check_report_network_insights_get`
|
|
- Route: `POST /cra/check_report/network_insights/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve network attributes for the user
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_verification_get
|
|
|
|
- Operation ID: `cra_check_report_verification_get`
|
|
- Route: `POST /cra/check_report/verification/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve various home lending reports for a user
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_check_report_verification_pdf_get
|
|
|
|
- Operation ID: `cra_check_report_verification_pdf_get`
|
|
- Route: `POST /cra/check_report/verification/pdf/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve a Consumer Report as a Verification PDF
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_loans_applications_register
|
|
|
|
- Operation ID: `cra_loans_applications_register`
|
|
- Route: `POST /cra/loans/applications/register`
|
|
- Mode: WRITE
|
|
- Summary: Register loan applications and decisions
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_loans_register
|
|
|
|
- Operation ID: `cra_loans_register`
|
|
- Route: `POST /cra/loans/register`
|
|
- Mode: WRITE
|
|
- Summary: Register a list of loans to their applicants
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_loans_update
|
|
|
|
- Operation ID: `cra_loans_update`
|
|
- Route: `POST /cra/loans/update`
|
|
- Mode: WRITE
|
|
- Summary: Update loan data
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_loans_unregister
|
|
|
|
- Operation ID: `cra_loans_unregister`
|
|
- Route: `POST /cra/loans/unregister`
|
|
- Mode: WRITE
|
|
- Summary: Unregister a list of loans
|
|
- Body: JSON request body accepted.
|
|
|
|
### cra_credit_profile_report_get
|
|
|
|
- Operation ID: `cra_credit_profile_report_get`
|
|
- Route: `POST /cra/credit_profile/report/get`
|
|
- Mode: WRITE
|
|
- Summary: Retrieve the credit profile report for a user
|
|
- Body: JSON request body accepted.
|