Reference IDs

Several fields in the LeadInput type accept reference IDs instead of free-form text. This page documents the valid values for each reference field.

Residence Type

Use residenceTypeId to indicate the applicant’s housing situation.

ID	Value	Description
1	Home Owner	Owns their home
2	Rent	Renting
3	Living with Family	Living with family members
4	Other	Other arrangement

Example:

{
  "residenceTypeId": 1 // Home Owner
}

Income Source

Use incomeSourceId to indicate the primary source of income.

ID	Value	Description
1	Employed	Regular employment
2	Social Security	Social Security benefits
3	Pension	Pension income
4	Disability	Disability benefits
5	Self Employed	Self-employment income
6	Student	Student
7	Unemployed	Currently unemployed

Example:

{
  "incomeSourceId": 1 // Employed
}

Pay Frequency

Use payFrequencyId to indicate how often the applicant receives income.

ID	Value	Description
1	Weekly	Paid every week
2	Every two weeks	Paid every two weeks (bi-weekly)
3	Twice a month	Paid twice per month (semi-monthly)
4	Monthly	Paid once per month
5	4 Weekly	Paid every 4 weeks
6	Other	Other pay schedule

Example:

{
  "payFrequencyId": 2 // Every two weeks
}

Tip

When calculating monthly income from pay frequency:

• Weekly: Annual ÷ 52 × 4.33
• Every two weeks: Pay × 2.17
• Twice a month: Pay × 2
• Monthly: Pay as-is
• 4 Weekly: Pay × 13 ÷ 12

Loan Purpose

Use loanPurposeId to indicate the purpose of the requested loan.

ID	Value	Description
1	Debt Consolidation	Consolidate existing debts
2	Home improvement / Pool / Solar	Home renovation, pool, or solar installation
3	Vacation / Travel	Travel or vacation expenses
4	New auto purchase	New vehicle purchase
5	Large Purchase	Major purchase
6	Pay off credit cards	Credit card payoff
7	Student Loan Refinancing	Refinance student loans
8	Education	Education expenses
9	Special Occasion	Special event or celebration
10	Cosmetic Procedures	Cosmetic or elective procedures
11	Moving and Relocation	Moving expenses
12	Household Expenses	General household costs
13	Medical/Dental	Medical or dental expenses
14	Taxes	Tax payments
15	Business	Business expenses
16	Other	Other purpose
17	Funeral expenses	Funeral costs
18	Auto loan refinance	Refinance existing auto loan
19	Used auto purchase	Used vehicle purchase
20	Auto lease buyout	Buy out auto lease
21	Baby / Adoption expenses	Baby or adoption costs
22	Emergency expenses	Emergency financial needs
23	Wedding / Engagement	Wedding or engagement costs
24	Auto repairs	Vehicle repairs
25	Equipment Purchase	Equipment acquisition

Example:

{
  "loanPurposeId": 1 // Debt Consolidation
}

Note

Include all applicable product codes separated by commas. The system will match the lead to the appropriate product based on qualification results.

State Codes

Use standard 2-letter USPS state abbreviations for the state field.

States

Code	State	Code	State
AL	Alabama	MT	Montana
AK	Alaska	NE	Nebraska
AZ	Arizona	NV	Nevada
AR	Arkansas	NH	New Hampshire
CA	California	NJ	New Jersey
CO	Colorado	NM	New Mexico
CT	Connecticut	NY	New York
DE	Delaware	NC	North Carolina
FL	Florida	ND	North Dakota
GA	Georgia	OH	Ohio
HI	Hawaii	OK	Oklahoma
ID	Idaho	OR	Oregon
IL	Illinois	PA	Pennsylvania
IN	Indiana	RI	Rhode Island
IA	Iowa	SC	South Carolina
KS	Kansas	SD	South Dakota
KY	Kentucky	TN	Tennessee
LA	Louisiana	TX	Texas
ME	Maine	UT	Utah
MD	Maryland	VT	Vermont
MA	Massachusetts	VA	Virginia
MI	Michigan	WA	Washington
MN	Minnesota	WV	West Virginia
MS	Mississippi	WI	Wisconsin
MO	Missouri	WY	Wyoming

Territories

Code	Territory
DC	District of Columbia
PR	Puerto Rico
VI	Virgin Islands
GU	Guam

Complete Example

Here’s an example using multiple reference IDs:

{
  "input": {
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1985-06-15",
    "email": "john.doe@example.com",
    "homePhone": "9496779225",
    "address1": "123 Main Street",
    "city": "Los Angeles",
    "state": "CA",
    "zipCode": "90001",
    "leadSourceId": "partner-sandbox",
    "productCodes": "3225,3226,3227,3228,3229",

    // Reference IDs
    "residenceTypeId": 2, // Rent
    "incomeSourceId": 1, // Employed
    "payFrequencyId": 2, // Every two weeks
    "loanPurposeId": 1 // Debt Consolidation
  }
}

Related

• Lead Input Schema - Complete field reference
• createLead - Submit leads