Rateflow Config

Field descriptions

• target_price – Target price between 0 – 100 used for filtering rate results. The default is 100.
• cache_ttl – Duration (in seconds) for how long rate quote responses should be cached. The default is 3600 (1 hour).
• default_fees_in – Boolean that determines if fees should be included in the loan amount by default. The default is true.
• defaults – JSON object containing BankingBridge RateFlow-specific default values. The default value is empty.
• raw_defaults – JSON object with pricing engine's native default values. The default value is empty.
• prepaid_interest_days – Number of prepaid interest days included in pricing calculations. The default is 30.
• lo_map – Loan officer field mapping (custom logic or values if applicable). The default is empty.
• api_mode – Name of the pricing engine being used (e.g., mortech, polly, optimal_blue). Required with no default.
• api_config – JSON object with engine-specific authentication or configuration values. Required with no default.
• testing – Boolean to indicate if the environment is in testing mode. The default is false.
• fee_engine – Name of the third-party fee engine used for calculating estimated closing costs (e.g., lodestar). Commonly set to "lodestar".
• lead_source – Integer value used to identify the source of the lead for tracking and reporting.

Engine-Specific Authentication/Config Fields

📘

These can be required depending on the selected api_mode.

• client_id – Engine-specific client identifier.
• client_secret – Secret key paired with the client ID.
• audience_id – Identifier for the audience scope used in authentication (e.g., Polly).
• api_username – Username used for authenticating with the pricing engine.
• api_key – API key issued by the pricing engine for secure requests.
• user_id – Unique user identifier used in pricing engine configurations.
• company_id – Identifier for the lender or account within the pricing engine.
• auth_url – URL endpoint for retrieving an authentication token.
• api_url – Primary endpoint for sending pricing requests to the engine.
• grant_type – Grant type used for OAuth2-based authentication flows (e.g., client_credentials).
• resource_id – Resource or audience ID tied to the API access token.
• lockperiod_only – Boolean or string flag to restrict pricing to a single lock period option.
• biz_channel – Business channel identifier used by the pricing engine (e.g., different divisions or loan types).
• originator_id – Identifier for the individual loan originator in the pricing engine.