🚧
Consider your current form carefully
Employment status requires changes to the fields accessible to the user in your form and the payload you send us.

Within our own Eligibility Check form we vary the visibility of certain fields depending on their previous answers.

This is particularly important when considering the Employment Status of an Applicant.

Applicants with the following type of employment statuses should only be asked details about theirother income:

•	R - Retired.
•	U - Unemployed.

Please note that if the Employment Status of the applicant is one of the above, their income should be passed within the "Other Income" array of the request and not within the "Gross Income" related fields (this can validly be passed as zero) as that relates more to a salaried income.

Unemployed Example

Let's say a user selects that they are employed, there will be fields visible to the user about the details of their employment.

If the user selects they are unemployed, we don't ask for their employment details anymore and we allow for them to specify their other income.

Additionally, we no longer include them within the API payload:

The complete payload should look something like this:

{
    "Partner": {
        "partner_code": "FFW-TEST",
        "reference": "1234567"
    },
    "Quote": {
        "cash_advance": "N",
        "balance_transfer": "Y",
        "balance_to_transfer": 5000
    },
    "Primary_Applicant": {
        "title": "Mrs",
        "first_name": "Clotilde",
        "middle_name": null,
        "surname": "Kemmer",
        "dob": "03/04/1981",
        "gender": "F",
        "email": "test@example.com",
        "home_phone": null,
        "mobile_phone": "07712345678",
        "marital_status": "M",
        "residential_status": "H",
        "no_of_dependents": 0,
        "other_household_income": 9050,
        "Current_Address": {
            "flat": null,
            "house_name": null,
            "house_number": "23",
            "street": "HIGH STREET",
            "locality": "Westbury",
            "posttown": "Westbury",
            "county": "Wiltshire",
            "postcode": "BA133BN",
            "country": "United Kingdom",
            "years_lived": 3,
            "months_lived": 1
        },
        "Current_Employment": {
            "employment_status": "U",
            "gross_income_all": 0
        },
        "Other_Income": [
            {
                "income_description": "WTC",
                "income": 300,
                "period": "M"
            }
        ],
        "Expenditure": {
            "monthly_mortgage_rent": 1560
        }
    }
}

{
    "Partner": {
        "partner_code": "FFW-TEST",
        "reference": "1234210"
    },
    "Loan": {
        "loan_amount": 62350,
        "loan_term": 60,
        "loan_purpose": "CA1"
    },
    "Primary_Applicant": {
        "title": "Mr",
        "forename": "Example",
        "surname": "Example",
        "dob": "01/11/1990",
        "email": "test@test.com",
        "home_phone": "0161123456789",
        "mobile_phone": "07777777777",
        "marital_status": "L",
        "residential_status": "M",
        "no_of_dependents": 1,
        "dependent_ages": "12",
        "Current_Address": {
            "flat": null,
            "house_name": null,
            "house_number": "3",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 0,
            "months_lived": 5
        },
        "First_Previous_Address": {
            "flat": "APARTMENT 22",
            "house_name": null,
            "house_number": "3",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 1,
            "months_lived": 0
        },
        "Second_Previous_Address": {
            "flat": null,
            "house_name": "ROBIN LANE",
            "house_number": "56",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 0,
            "months_lived": 3
        },
        "Current_Employment": {
            "employment_status": "R",
            "gross_income": 0,
            "emp_years": 0,
            "emp_months": 0
        },
        "Expenditure": {
            "monthly_mortgage_rent": 500
        },
        "Other_Income": [
            {
                "income_description": "PIP",
                "income": 1000,
                "period": "M"
            }
        ],
        "Bank_Details": {
            "years_at_bank": 14,
            "months_at_bank": 1
        }
    }
}