Add/Edit Customer Employer

General

Employer information helps lenders contact their borrowers and provides vital background information during the underwriting process. Here's what you need to know about this request:

• The Employer object is nested within the Customers entity. Thus, this request is sent through the Customers endpoint as a PUT.
• Each customer can only have current employer information saved. In other words, only one employer's information is available.
• You will need a valid customer ID to update employer information. You can find a customer's ID by using a GET Customer Information request.

For an example of how employer information is saved within the UI, take a look at our Update Employer Information article.

Database

For information on Customer database tables, see the following articles:

• Database – Customer Employer Entity (customer_employer_entity)
• Database – Customer Main Table (customer_entity)

{
    "Employer": {
        "phone": "5555555555",
        "payDate": "2015-11-30",
        "Address": {
            "address1": "123 Oak Lane",
            "city": "San Diego",
            "state": "geo.state.CA",
            "zipcode": "145245498",
            "country": "company.country.usa"
        },
        "hireDate": "2015-11-11",
        "incomeFrequency": "customerEmployer.incomeFrequency.annually",
        "payDateFrequency": "customerEmployer.payDateFrequency.weekly",
        "income": "150000.00",
        "companyName": "Merrill Lynch",
        "title": "Shift Manager"
    }
}

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.