Setting Dynamic Properties

Clients can set their own properties dynamically using the dynamicPropertiesMap field in miSearchCriteria.

The client does this by adding custom JSON in the Lender Price UI. This custom JSON is used to map the client's custom data to the Lender Price API.

This feature is useful if the client wants to create custom fields. For example, if a client wants to create a custom field for citizenship, they need to pass the fieldId, the name which the field is recognized by, and the value.

Example:

"dynamicPropertiesMap": {
  "Citizenship": {
    "fieldId": "Citizenship",
    "value": "US Citizen"
  }
}

Retrieve Your Company's Dynamic Fields

important

The list of available dynamic fields is company-specific and can change over time. Each integration should call the getDynamicFields endpoint to retrieve the latest fields for their company rather than relying on a static list.

Request

GET {{domain}}/rest/getDynamicFields/{companyId}/{userId}

Headers:

Header	Value
`companyId`	Your company ID
`secret`	Your API secret (see Authentication)

Example Response

The endpoint returns an array of field definitions. Each field includes a fieldId (the key you use in dynamicPropertiesMap), a type that determines what values are accepted, and a validator with any constraints.

[
  {
    "id": "5e96220dfee78c52a88b6cc9",
    "creationDate": "2020-04-14T20:50:21.000Z",
    "modifiedDate": "2023-12-01T18:46:39.699Z",
    "name": "FHA Case Assignment Date",
    "fieldId": "FHACASEASSIGNDATE",
    "type": "DateRange",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.DateRangeValidator",
      "reversed": false,
      "range": {
        "@class": "com.cre8techlabs.entity.range.DateRangeLeGt",
        "from": null,
        "to": null
      },
      "type": "DateRange"
    }
  },
  {
    "id": "5e96220dfee78c52a88b6ccb",
    "creationDate": "2020-04-14T20:50:21.000Z",
    "modifiedDate": "2023-12-01T18:46:39.746Z",
    "name": "FHA Endorsement Date",
    "fieldId": "FHAENDORSEMENTDATE",
    "type": "DateRange",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.DateRangeValidator",
      "reversed": false,
      "range": {
        "@class": "com.cre8techlabs.entity.range.DateRangeLeGt",
        "from": null,
        "to": null
      },
      "type": "DateRange"
    }
  },
  {
    "id": "60be958cce8ad000010668a5",
    "creationDate": "2021-06-07T21:54:20.000Z",
    "modifiedDate": "2023-12-01T18:46:42.308Z",
    "name": "Citizenship",
    "tags": [],
    "fieldId": "Citizenship",
    "type": "Enum",
    "addValueAsAdjustmentTag": false,
    "validator": {
      "@class": "com.cre8techlabs.entity.rate.adjustment.fields.EnumStringValidator",
      "id": "60be958cce8ad000010668a6",
      "reversed": false,
      "selections": [
        {
          "name": "Foreign National",
          "code": "Foreign National"
        },
        {
          "name": "US Citizen",
          "code": "US Citizen"
        },
        {
          "name": "Foreign National (w/ ITIN)",
          "code": "ForeignNationalwithITIN)"
        },
        {
          "name": "ITIN",
          "code": "ITIN"
        },
        {
          "name": "Foreign National (No ITIN)",
          "code": "ForeignNationalnoITIN)"
        },
        {
          "name": "Non-Perm Resident",
          "code": "Non-Perm Resident"
        },
        {
          "name": "Perm Resident",
          "code": "Perm Resident"
        }
      ],
      "valids": [],
      "multi": false,
      "type": "Enum",
      "init": false
    }
  }
]

Using Fields in a Pricing Request

Once you have the list of available fields, use the fieldId as the key in dynamicPropertiesMap:

"dynamicPropertiesMap": {
  "FHACASEASSIGNDATE": {
    "fieldId": "FHACASEASSIGNDATE",
    "value": "2023-05-15T18:58:41Z"
  },
  "Citizenship": {
    "fieldId": "Citizenship",
    "value": "US Citizen"
  }
}

Default dynamicPropertiesMap Example

Below is an example of commonly defaulted fields inserted at the root of a search request. Always verify against your own getDynamicFields response.

"dynamicPropertiesMap": {
    "GLOBAL_GIFTFUNDPERCENT": { "fieldId": "GLOBAL_GIFTFUNDPERCENT", "value": "0" },
    "Citizenship": { "fieldId": "Citizenship", "value": "US Citizen" },
    "IncomeDocType": { "fieldId": "IncomeDocType", "value": "Full Doc - 24M" },
    "MORT30LATESLAST12M": { "fieldId": "MORT30LATESLAST12M", "value": "0" },
    "MORT60LATESLAST12M": { "fieldId": "MORT60LATESLAST12M", "value": "0" },
    "MORT90LATESLAST12M": { "fieldId": "MORT90LATESLAST12M", "value": "0" },
    "MORT120LATESLAST12M": { "fieldId": "MORT120LATESLAST12M", "value": "0" },
    "Global_DEEDINLIEU": { "fieldId": "Global_DEEDINLIEU", "value": "DIL_Null" },
    "GLOBAL_Forbearances": { "fieldId": "GLOBAL_Forbearances", "value": "ForbearNone" },
    "GLOBAL_RESERVES": { "fieldId": "GLOBAL_RESERVES", "value": "Reserves_12" },
    "GLOBAL_BorrowerType": { "fieldId": "GLOBAL_BorrowerType", "value": "Individual" },
    "GLOBAL_DELAYEDFINANCING": { "fieldId": "GLOBAL_DELAYEDFINANCING" },
    "GLOBAL_NoMortgageHistory": { "fieldId": "GLOBAL_NoMortgageHistory" },
    "Lateinlast12months": { "fieldId": "Lateinlast12months" },
    "Lateinlast24months": { "fieldId": "Lateinlast24months" },
    "FirstTimeInvestor": { "fieldId": "FirstTimeInvestor" },
    "GLOBAL_MixedUse": { "fieldId": "GLOBAL_MixedUse", "value": "true" },
    "PrepayTerm": { "fieldId": "PrepayTerm", "value": "12 Months" },
    "PrePayment_Plan_Type": { "fieldId": "PrePayment_Plan_Type" }
  }

Field Reference

The tables below list the available dynamic properties. These are example fields — your company's actual list may differ. Always call getDynamicFields for the authoritative list.

Global Fields

Field Name	Type / Enums	Field ID
Unit	Number	`PROPERTYUNIT`
Fico	Number	`FICO`
Property Valuation Type	ACE / PIW / Full Appraisal / HVE / FMP / Inspection / Streamline / 1004P	`VALUATIONTYPE`
Exceed FHA Limit	SingleLimit	`FHALIMITEXCEED`
Mortgage 30 lates last 12 Months	NumberRange	`MORT30LATESLAST12M`
Mortgage 30 lates last 24 Months	NumberRange	`MORT30LATESLAST24M`
Mortgage 60 lates last 12 Months	NumberRange	`MORT60LATESLAST12M`
Mortgage 60 lates last 24 Months	NumberRange	`MORT60LATESLAST24M`
Mortgage 90 lates last 12 Months	NumberRange	`MORT90LATESLAST12M`
Mortgage 90 lates last 24 Months	NumberRange	`MORT90LATESLAST24M`
Bankruptcy last 12 Months	NumberRange	`BANKRUPTCYLAST12M`
Chap.7 Bankruptcy last 12 Months	NumberRange	`CH7BANKRUPTCYLAST12M`
Chap.13 Bankruptcy last 12 Months	NumberRange	`CH13BANKRUPTCYLAST12M`
Chap.13 Bankruptcy last 24 Months	NumberRange	`CH13BANKRUPTCYLAST24M`
Has Open CH12 Bankruptcy	Boolean	`OPENCH12BANKRUPCY`
Foreclosure last 60 Months	NumberRange	`FORECLOSURELAST60M`
Deed in Lieu last 24 Months	NumberRange	`DEEDINLIEULAST24M`
DSCR Ratio	>= 1.25 / 1.00-1.24x / 0.75-0.99x / < 0.75x	`DSCRRATIO`
DTI	> 50 / 43-50 / ≤ 43	`DTI`
Citizenship	Non-Perm Resident / Perm Resident / US Citizen / Foreign National	`Citizenship`
Income Doc Type	Bank Statements - 24M / Full Doc - 24M / DSCR / 1099 - 12M / Full Doc - 12M / Asset Utilization / 1099 - 24M / Bank Statements - 12M	`IncomeDocType`
Bankruptcy Seasoning	Bank Statements - 24M / Full Doc - 24M / DSCR / 1099 - 12M / Full Doc - 12M / Asset Utilization / 1099 - 24M / Bank Statements - 12M	`BankruptcySeasoning`
Bankruptcy Chapter	Chapter 13 / Chapter 11 / Chapter 7	`BankruptcyChapter`
Housing History	0X30x24 / 1X30X12 / 0X60X12 / 0X30x12 / 0x90x12 / 0x120x12	`HousingHistory`
FC/SS/DIL Seasoning	7+ Years / Never / 4-7 Years / 2-4 Years / < 2 Years	`FC/SS/DIL Seasoning`
Prepay Term	36 Months / 24 Months / 12 Months / None	`PrepayTerm`
Tradelines	3 for 12+ Months / 2 for 24+ Months / Limited	`Tradelines`
Interest Only	Boolean	`InterestOnly`
Escrow Waiver	Boolean	`EscrowWaiver`
First Time Home Buyer	Boolean	`FirstTimeHomeBuyer`
FHA Case Assignment Date	Date	`FHACASEASSIGNDATE`
FHA Endorsement Date	Date	`FHAENDORSEMENTDATE`
Affordable Housing Type	None / HFAPreferred / HFAPreferredRiskSharing / HomeReady / HomePossible
Application Taken Date	Date	`Global_APPLICATIONTAKENDATE`
Execution Type	Best Efforts / Mandatory	`Global_EXECUTIONTYPE`
Doc Type	Full Doc / 24 Mo. Personal Bank Statements / 12 Mo. Personal Bank Statements / 24 Mo. Business Bank Statements / 12 Mo. Business Bank Statements / Other Bank Statements / 24 Mo. CPA Prepared P&L / 12 Mo. CPA Prepared P&L / 24 Mo. Tax-Prepared P&L / 12 Mo. Tax-Prepared P&L / 1 Yr. Tax Returns / VOE / Asset Utilization / Debt Service Coverage (DSCR) / No Ratio	`Global_DOCTYPE`
Renovation Loan	Boolean	`Global_RENOVATIONLOAN`
Cashout Amount	$	`Global_CASHOUTAMOUNT`
Interest Only	Boolean	`Global_INTERESTONLY`
First Time Home Buyer	Boolean	`Global_FIRSTTIMEHOMEBUYER`
Self Employed	Boolean	`Global_SELFEMPLOYED`
BuyDown	3/2/1 / 2/1 / 1/1 / 1/0	`Global_BUYDOWN`
Closed End	Boolean	`Global_CLOSEDEND`
Balloon?	Boolean	`Global_BALLOON`
Rural	Boolean	`Global_RURAL`
Non-Occ CoBorrower	Boolean	`Global_NONOCCCOBWR`
Prior Sale Date	Date	`Global_PRIORSALEDATE`
Construction Draw	$	`Global_CONSTRUCTIONDRAW`
Renovation Cost	$	`Global_RENOVATIONCOST`
Borrower Count	Number	`Global_NUMBEROFBWRS`
Manufactured Initiative	MH Advantage / CHOICEHome	`Global_MHINITIATIVE`
AUS Response	None / DU_Approve_Eligible / DU_Approve_Ineligible / DU_OutOfScope / DU_ReferWith_Caution / DU_ReferWith_Caution_IV / DU_Refer_Eligible / DU_Refer_Ineligible / LP_Accept_Eligible / LP_Accept_Ineligible / LP_Caution_AMinusEligible / LP_Caution_Eligible / LP_Caution_Ineligible	`Global_AUSRESPONSE`
Citizenship	US Citizen / Permanent Resident / Non-Permanent Resident Alien / Non-Resident Alien / Foreign National	`Global_CITIZENSHIP`
Closing Date	Date	`Global_CLOSINGDATE`
Community Second	Boolean	`Global_COMMUNITYSECOND`
Relocation Loan	Boolean	`Global_RELOCATIONLOAN`
VA Eligible	Boolean	`Global_VAELIGIBLE`
PrePayment Penalty	Boolean	`Global_PREPAYMENTPENALTY`
New Construction	Boolean	`Global_NEWCONSTRUCTION`
Texas 50(a)(6)	Boolean	`Global_TX50A6`
FHA Prog Type	None / FHA 203(k) / FHA 203(h)	`Global_FHAPROGTYPE`
Foreclosures	None / >=2 Years / >=3 Years / >=4 Years / >=5 Years / >=7 Years / Settled	`Global_FORECLOSURES`
Deed in Lieu	None / >=2 Years / >=3 Years / >=4 Years / >=5 Years / Settled	`Global_DEEDINLIEU`
Short Sales	None / >=2 Years / >=3 Years / >=4 Years / >=5 Years / Settled	`Global_SHORTSALES`
Bankruptcies	None / BK > 4 Years / CH 7 Discharge >=2 Yrs / CH 7 Discharge >=3 Yrs / CH 7 Discharge >=4 Yrs / CH 7 Discharge >=5 Yrs / CH 7 Discharge Settled / CH 11 BK >=2 Yrs / CH 11 BK >=3 Yrs / CH 11 BK >=5 Yrs / CH 11 Personal BK >=4 Yrs / CH 13 BK >=2 Yrs / CH 13 BK >=3 Yrs / CH 13 BK >=4 Yrs / CH 13 BK >=5 Yrs / CH 13 BK Settled / CH 13 Discharge >=2 Yrs / CH 13 Dismissal >=4 Yrs	`Global_BANKRUPTCIES`
# of Financed Properties	Number	`Global_FINANCED PROPERTIES`
Target Investor	FNMA / FHLMC / FNMA and FHLMC / Ginnie Mae / and others	`Global_TargetInvestor`
FHA Purpose Type	FHA to FHA / Non-FHA to FHA / Streamlined Refinance without Appraisal / Streamlined Refinance with Appraisal	`Global_FHAPurposeType`
Mortgage Insurance Payment Type	Monthly / Annually / Single	`Global-MortgageInsurancePaymentType`
Terms	range	`GLOBAL_TERMS`
Term (In Months)	Boolean	`GLOBAL_TERMINMONTHS`
Channel	ForWholeSale / ForCorresponding / ForBroker / AsRetail / All	`GLOBAL_CHANNEL`
Channel SubType	All / NonDelegated / Delegated	`GLOBAL_CHANNELSUBTYPE`
LPMI Eligible	TRUE / FALSE	`GLOBAL_LPMIELIGIBLE`
Gift Fund %	percent	`GLOBAL_GIFTFUNDPERCENT`
Property is listed	Boolean	`GLOBAL_PROPERTYLISTED`
Covid Forbearance	Boolean	`GLOBAL_COVIDFORBEARANCE`
Prepay Level	Level 1 / Level 2	`GLOBAL_PREPAYLEVEL`
Reserves	12 Month LCRs / 6 Month LCRs / 3 Month LCRs / No LCRs	`GLOBAL_RESERVES`

Company Level Fields

Field Name	Type / Enums	Field ID
PremierBuilder	boolean	`COMPANY_PremierBuilder`
Adjustment Subtypes	Sales / Secondary marketing adjustor / None / TPO Perf Rating / Channel adjustor / Corporate adjustor	`ADJ_SUBTYPES`
Display Flag	Yes / No	`COMPANY_DisplayFlag`
Channel Subtype	All / NonDelegated / Delegated Bulk / Delegated Flow / Distributed Retail Encompass / Distributed Retail Loantrac / Consumer Direct Retail	`COMPANY_CHANNELSUBTYPE`
Bulk Delivery	boolean (allows NULL, True=Bulk)	`COMPANY_BULKDELIVERY`
No VOR / VOM	boolean (Null Available)	`COMPANY_NOVORVOM`
Gift of Equity	boolean (Null Available)	`COMPANY_GIFTOFEQUITY`
DSCR Ratio	No DSCR / DSCR >1.00 / DSCR =<1.00	`COMPANY_DSCRRATIO`
Open BK	boolean (Null Available)	`COMPANY_OPENBK`
Not Current	boolean (Null Available)	`COMPANY_NOTCURRENT`
Lease Option Buyout	boolean (Null Available)	`COMPANY_LEASEOPTIONBUYOUT`
51% Owner Occupied	boolean (Null Available)	`COMPANY_51PERCENTOWNEROCC`
Credit Grade	A++ / A+ / A / A- / B / B- / C / D	`COMPANY_CREDITGRADE`
Bankruptcies	< 4 years / < 3 years / < 2 years / < 1 year	`COMPANY_BANKRUPTCIES`
Major Mortgage Event (FC/SS/DIL)	< 4 years / < 3 years / < 2 years / < 1 year / Currently In	`COMPANY_MAJOR MORTGAGEEVENT`
SFR Used as Care Facility	boolean	`COMPANY_SFRUSEDASCAREFACILITY`
Major Event Settled	boolean	`COMPANY_MAJOREVENTSETTLED`
Lending Type	Consumer Purpose / Business Purpose	`COMPANY_LENDINGTYPE`
Property Type	SFR/PUD / Condo / 2-4 Unit / Townhome / NonWarrantable Condo / Condotel	`COMPANY_PROPTYPE`
Property Attributes	None / Rural / Commercial Mixed Use / Commercial MultiFamily	`COMPANY_PROPERTYATTRIBUTES`
Prepayment Penalty	No Prepay / 1 Yr Prepay / 2 Yr Prepay / 3 Yr Prepay / 4 Yr Prepay / 5 Yr Prepay	`COMPANY_PREPAYPENALTY`
Borrower Type	Individual / Multiple Individuals / Trust / LLC / S-Corp / C-Corp	`COMPANY_BORROWERTYPE`
Borrower Attributes	None / Non-Occupant Co Borrower / First Time Home Buyer	`COMPANY_BORROWERATTRIBUTES`
ITIN with Visa	Boolean	`COMPANY_ITIN`
ACH	Boolean	`COMPANY_ACH`
Income Doc Type	Full Document / Alt - 12 mo bank stmts / Lite - 6 mo bank stmts / NINA / NISA / No Doc (NINANE) / No Ratio (NIVA) / NIV (SISA) / NIV (SIVA) / VISA / No Doc Verif Assets / VINA / Alt Doc - 24 / Alt Doc - 12 / Alt Doc - VOE / Alt Doc - P&L / Alt Doc - K-1 / Alt Doc - 1099 / Alt Doc - AD-5 year / Re-Entry to Workforce / Contract w/in 60 days / 12 month Full doc / 12 month 1099 / 12 Month K-1	`COMPANY_INCOMEDOCTYPE`
Channel	Refinance / New Construction / Company Generated / Discount Tier 1 / Employee Loan / Family Loan	`COMPANY_CXSD_CHANNEL`

Retrieve Your Company's Dynamic Fields​

Request​

Example Response​

Using Fields in a Pricing Request​

Default dynamicPropertiesMap Example​

Field Reference​

Global Fields​

Company Level Fields​