BrokerCriteria Json Schema

In This Topic

Description

The Broker Criteria object contains information on loan criteria that is relevant to loan brokers.

Included here are fields for setting the compensation plan and closing cost range.

Required Fields:

ausList
dayLocks

Many of the fields are for internal use and may not be necessary for the customer. These include:

createdBy
createdDate
dayLocksList
displayConventionalDate
displayMultiple
id
mergeSet
modifiedBy
modifiedDate

Overview

BrokerCriteria

The Broker Criteria object contains information on loan criteria that is relevant to loan brokers.

Included here are fields for setting the compensation plan and closing cost range.

Required Fields:

ausList
dayLocks

Many of the fields are for internal use and may not be necessary for the customer. These include:

createdBy
createdDate
dayLocksList
displayConventionalDate
displayMultiple
id
mergeSet
modifiedBy
modifiedDate

adjCodeToExclude : Array[string]

adjNameToExclude : Array[string]

adjustments : Array[Adj]

An array of adjustments to apply to the loan cost. Adjustments are flat fees that are similar to closing costs, but simpler in terms of calculation.

Adjustment data is stored in the Adj object.

For more information, see Adjustments and Closing Costs.

adj : number

The adjustment number.

adjGroupCode : string

adjType : string

The adjustment type.

attributes : Array[AdjAttribute]

key : string

value : string

code : string

compPlan : number

The comp plan. Same value as in the criteria.compPlan field.

disqualified : boolean

forceAdjToHoldback : boolean

includeInInterpolationComp : boolean

key : string

Adjustment key.

llpa : number

margin : number

msr : number

pmiTypes : Array[string]

productCodes : Array[string]

qualifiedSpecialOptionFromAdj : Array[SpecialMortgageOption]

category : string

The category of the special mortgage option.

description : string

Description of the mortgage option.

dynamicProperties : object

enabled : boolean

Set to True if enabled.

id : ObjectId

The mortgage option ID, used for reference.

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

name : string

Name of the special mortgage option.

qualifiedSpecialOptionFromAdjFilter : Array[SpecialMortgageOption]

referenceId : string

The reference ID for the adjustment.

tags : Array[string]

targetType : string

triggerServicingGrouping : boolean

type : string

userGroupExternalId : string

valueType : string

ausIndicator : string

aus indicator

ausList : Array[string]

An adjustment filter, passed as a list of values representing adjustments. This field is required.

Enum values:

None
GUS
MUW
DU
LP

Example:

ausList: ["None", "LP", "DU"]

Note: Selecting MUW will cause disqualification because it is the disqualify adjustment for all conventional programs.

The solution is either to remove MUW or, if you want to see the disqualified products, set showDisqualify to True.

businessSourceType : string

The businessSourceType field is used for coding business sources to determine adjustments. The codes may represent a new customer, returning customer, veteran, and so on. The API provides up to 24 options, along with a N/A option, that the client can represent as they wish.

Values:

BST_NA("N/A", "N/A")

BST_1("1", "1")

BST_2("2", "2")

BST_3("3", "3")

BST_4("4", "4")

BST_5("5", "5")

BST_6("6", "6")

BST_7("7", "7")

BST_8("8", "8")

BST_9("9", "9")

BST_10("10", "10")

BST_11("11", "11")

BST_12("12", "12")

BST_13("13", "13")

BST_14("14", "14")

BST_15("15", "15")

BST_16("16", "16")

BST_17("17", "17")

BST_18("18", "18")

BST_19("19", "19")

BST_20("20", "20")

BST_21("21", "21")

BST_22("22", "22")

BST_23("23", "23")

BST_24("24", "24")

Example:

"businessSourceType": "BST_NA"
- Code is not applicable here. Returns all results.
"businessSourceType: "BST_1"
- Codes the search as whatever the client represents under BST_1 (e.g. returning customer).

closingCostRange : RangeClosingCost

Enter a range for the closing cost. This is use to return the result closest to par.

See RangeClosingCost for more details.

closestToPar : boolean

Set to "True" to return the rate closest to 0 (sometimes expressed as 100). This function considers the absolute value of the rate and returns either the positive or negative rate closest to 0. 

Returns one result per product.

Default is "False".

Examples:

If set to "True", results return something like the following:

Rate

-.500

Program Name

30/25 Yr Fixed Agency

.625

30 Year - 26 Year

closestToTargetValue : number

from : number

The low end of the rate range.

infinite : boolean

Default is False.

to : number

The high end of the rate range.

compPlan : number

Add a comp plan to a rate that doesn't have it. Default is null.

creationDate : string

internal only

dayLocks : integer

Lock Day Period. Default is 30, meaning 30 days. If daysLocks is not given in the request payload, pricing results of 30 days lock are returned.

Cannot pass multiple values for dayLocks as it is defined as an Integer.

Pricing results are returned based on this value only, and not the array list "dayLocksList":[ ].

Note: an input of multiple values such as "dayLocks": [30,45] triggers a 400 Bad Request error:

"error": "Bad Request", "message": "Could not read document: Cannot deserialize instance of int out of START_ARRAY token

dayLocksList : Array[integer]

internal only

Not used for integration.

displayConventionalRate : boolean

Setting it to True displays the conventional rate.

Default is False.

This field might be deprecated.

displayMultiple : integer

Default is False.

This field might be deprecated.

divisionSourceType : string

This field is client-specific.

executionType : string

feeServicer : FeeCompany

This field is client-specific. This refers to a third party fee service that determines fees for the client.

For more information, see Fee Company.

companyName : string

The name of the fee service company.

encompassTitleVendor : EncompassTitleVendor

Field containing the EncompassTitleVendor object.

abaNumber : string

accountNumber : string

address : string

address2 : string

affiliatedVendor : boolean

attorneyInfo : EncompassAttorneyInfo

branch : string

city : string

companyName : string

contactEmail : string

contactName : string

contactPhone : string

fax : string

isAffiliatedVendor : boolean

isPrimary : boolean

primary : boolean

rank : integer

state : string

vendorId : string

vendorName : string

zip : string

primary : boolean

Setting this field to True marks the fee company as the primary fee company.

Default is True.

vendorName : string

The name of the vendor.

vendorType : string

The vendor type.

feeServicerList : Array[FeeCompany]

This field is client-specific. Contains an array of third party fee services that determine fees for the client.

For more information, see Fee Company.

companyName : string

The name of the fee service company.

encompassTitleVendor : EncompassTitleVendor

Field containing the EncompassTitleVendor object.

primary : boolean

Setting this field to True marks the fee company as the primary fee company.

Default is True.

vendorName : string

The name of the vendor.

vendorType : string

The vendor type.

id : ObjectId

Object storing metadata for the BrokerCriteria model.

leadSourceType : string

The leadSourceType field is used for coding the source of the lead . This information can be used to make adjustments or for data collection.

This field is similar to businessSourceType.

Enum Values:

WEB("Web")
PHONE_INQUIRY("Phone Inquiry")
REFERRAL("Referral")
PORTFOLIO_RETENTION("Portfolio Retention")
TRADE_SHOW("Trade Show")
WORD_OF_MOUTH("Word of Mouth")
PURCHASED_LIST("Purchased List")
OTHER("Other")

Example:

"leadSourceType": "WEB"
- The source is from the internet.
"leadSourceType: "REFERRAL"
- The source is a referral.

lockExtensionCostRate : number

The cost to extend a lock on a loan, in percentage. Company specific.

Examples:

"lockExtensionCostRate": 1

lockGroup : string

The name of the lock group.

lockGroups : Array[string]

maxCompensation : number

The maximum broker compensation.

maxCompensationScript : string

minimunCompensation : number

Minimum value for broker compensation.

modifiedByOverride : string

internal value

overrideExistingComplan : boolean

Setting this value to True allows the user to override the compPlan value.

Default is False.

overrideMinMonthlyPaymentAmount : number

overrideMinMonthlyPaymentRate : number

pointsFinancedDollarAmount : number

priceBucketList : Array[DoubleRangeGeLe]

List of Point pricing buckets (Range of double)

from : number

The minimum value for the range.

to : number

The maximum value for the range.

pricingExceptionAmount : number

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a dollar amount.

Examples:

"pricingException": 5000

Similar to exceptionRate.

pricingExceptionRate : number

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a percent amount, and is a percentage of the loan.

Examples:

"pricingException": .10

Similar to exceptionAmount.

qmFilterLimit : integer

qm filter limit

Default is null

qmTreshold : Number

qm threshold

Default is null

qmTypes : Array[string]

rangeComplan : DoubleRangeGeLe

This field sets the range for the compensation (comp plan) that a loan officer receives.

Range values are stored in the fields to and from. Currently, the @class field must be populated.

Example:

"rangeComplan: {

"@class": "com.cre8techlabs.entity.range.DoubleRangeGeLe",

"from": 500,

"to": 2000

}

from : number

The minimum value for the range.

to : number

The maximum value for the range.

rateTypes : Array[string]

rateTypes will return only the specified rate types if set. If left null, the search will return all rate types. Passing "All" will also return all rate types.

The value passed depends on the "configuration" setup of your rate sheet.

Values:

"All"
"ForBroker"
"ForCorresponding"
"ForWholesale"
"AsRetail"

Example:

If pricing is marked as "ForBroker" under configuration, pass: "rateTypes":["ForBroker"]

See Rate Types for more information.

resultPerBucket : integer

Related to priceBucketList.

scriptWeight : integer

searchContext : object

The search context, set in an object.

Examples:

"searchContext": {}

sortStrategy : string

This field contains the sort strategy used for sorting results.

Default is "APR".

Values:

Value	Description
"APR"	Sorts by APR

Examples:
"sortStrategy": "APR"

subRateTypes : Array[string]

This field contains values for types of sub rates that can apply.

Values:

Examples:
"subRateTypes": ["", "", ""]

useExecutionType : boolean

view : string

internal only

Properties

Name Description Data Type

adjCodeToExclude Array[string]

adjNameToExclude Array[string]

adjustments

An array of adjustments to apply to the loan cost. Adjustments are flat fees that are similar to closing costs, but simpler in terms of calculation.

Adjustment data is stored in the Adj object.

For more information, see Adjustments and Closing Costs.

Array[Adj]

ausIndicator aus indicator string

ausList

An adjustment filter, passed as a list of values representing adjustments. This field is required.

Enum values:

None
GUS
MUW
DU
LP

Example:

ausList: ["None", "LP", "DU"]

Note: Selecting MUW will cause disqualification because it is the disqualify adjustment for all conventional programs.

The solution is either to remove MUW or, if you want to see the disqualified products, set showDisqualify to True.

Array[string]

businessSourceType

Values:

BST_NA("N/A", "N/A")

BST_1("1", "1")

BST_2("2", "2")

BST_3("3", "3")

BST_4("4", "4")

BST_5("5", "5")

BST_6("6", "6")

BST_7("7", "7")

BST_8("8", "8")

BST_9("9", "9")

BST_10("10", "10")

BST_11("11", "11")

BST_12("12", "12")

BST_13("13", "13")

BST_14("14", "14")

BST_15("15", "15")

BST_16("16", "16")

BST_17("17", "17")

BST_18("18", "18")

BST_19("19", "19")

BST_20("20", "20")

BST_21("21", "21")

BST_22("22", "22")

BST_23("23", "23")

BST_24("24", "24")

Example:

"businessSourceType": "BST_NA"
- Code is not applicable here. Returns all results.
"businessSourceType: "BST_1"
- Codes the search as whatever the client represents under BST_1 (e.g. returning customer).

string

closingCostRange

Enter a range for the closing cost. This is use to return the result closest to par.

See RangeClosingCost for more details.

RangeClosingCost

compPlan Add a comp plan to a rate that doesn't have it. Default is null. number

creationDate internal only string

dayLocks

Lock Day Period. Default is 30, meaning 30 days. If daysLocks is not given in the request payload, pricing results of 30 days lock are returned.

Cannot pass multiple values for dayLocks as it is defined as an Integer.

Pricing results are returned based on this value only, and not the array list "dayLocksList":[ ].

Note: an input of multiple values such as "dayLocks": [30,45] triggers a 400 Bad Request error:

"error": "Bad Request", "message": "Could not read document: Cannot deserialize instance of int out of START_ARRAY token

integer

dayLocksList

internal only

Not used for integration.

Array[integer]

displayConventionalRate

Setting it to True displays the conventional rate.

Default is False.

This field might be deprecated.

boolean

displayMultiple

Default is False.

This field might be deprecated.

integer

divisionSourceType This field is client-specific. string

executionType string

feeServicer

This field is client-specific. This refers to a third party fee service that determines fees for the client.

For more information, see Fee Company.

FeeCompany

feeServicerList

This field is client-specific. Contains an array of third party fee services that determine fees for the client.

For more information, see Fee Company.

Array[FeeCompany]

id Object storing metadata for the BrokerCriteria model. ObjectId

leadSourceType

The leadSourceType field is used for coding the source of the lead . This information can be used to make adjustments or for data collection.

This field is similar to businessSourceType.

Enum Values:

WEB("Web")
PHONE_INQUIRY("Phone Inquiry")
REFERRAL("Referral")
PORTFOLIO_RETENTION("Portfolio Retention")
TRADE_SHOW("Trade Show")
WORD_OF_MOUTH("Word of Mouth")
PURCHASED_LIST("Purchased List")
OTHER("Other")

Example:

"leadSourceType": "WEB"
- The source is from the internet.
"leadSourceType: "REFERRAL"
- The source is a referral.

string

lockExtensionCostRate

The cost to extend a lock on a loan, in percentage. Company specific.

Examples:

"lockExtensionCostRate": 1

number

lockGroup The name of the lock group. string

lockGroups Array[string]

maxCompensation The maximum broker compensation. number

maxCompensationScript string

minimunCompensation Minimum value for broker compensation. number

modifiedByOverride internal value string

overrideExistingComplan

Setting this value to True allows the user to override the compPlan value.

Default is False.

boolean

overrideMinMonthlyPaymentAmount number

overrideMinMonthlyPaymentRate number

pointsFinancedDollarAmount number

priceBucketList List of Point pricing buckets (Range of double) Array[DoubleRangeGeLe]

pricingExceptionAmount

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a dollar amount.

Examples:

"pricingException": 5000

Similar to exceptionRate.

number

pricingExceptionRate

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a percent amount, and is a percentage of the loan.

Examples:

"pricingException": .10

Similar to exceptionAmount.

number

qmFilterLimit

qm filter limit

Default is null

integer

qmTreshold

qm threshold

Default is null

Number

qmTypes Array[string]

rangeComplan

This field sets the range for the compensation (comp plan) that a loan officer receives.

Range values are stored in the fields to and from. Currently, the @class field must be populated.

Example:

"rangeComplan: {

"@class": "com.cre8techlabs.entity.range.DoubleRangeGeLe",

"from": 500,

"to": 2000

}

DoubleRangeGeLe

rateTypes

rateTypes will return only the specified rate types if set. If left null, the search will return all rate types. Passing "All" will also return all rate types.

The value passed depends on the "configuration" setup of your rate sheet.

Values:

"All"
"ForBroker"
"ForCorresponding"
"ForWholesale"
"AsRetail"

Example:

If pricing is marked as "ForBroker" under configuration, pass: "rateTypes":["ForBroker"]

See Rate Types for more information.

Array[string]

resultPerBucket Related to priceBucketList. integer

scriptWeight integer

searchContext

The search context, set in an object.

Examples:

"searchContext": {}

object

sortStrategy

This field contains the sort strategy used for sorting results.

Default is "APR".

Values:

Value	Description
"APR"	Sorts by APR

Examples:
"sortStrategy": "APR"

string

subRateTypes

This field contains values for types of sub rates that can apply.

Values:

Examples:
"subRateTypes": ["", "", ""]

Array[string]

useExecutionType boolean

view internal only string