Add/Edit Customer References

This request allows you to add, edit, or delete a customer reference.

   Click here to learn more about this request

References can help lenders contact their borrowers and provide additional information during the underwriting and servicing steps of a loan's life. Here's what you need to know about this request:

  • The References object is nested within the Customers entity. Thus, this request is sent through the Customers endpoint.
  • Each customer can have multiple references.
  • A valid customer ID is required to update reference information. You can find a customer's ID by using a GET Customer Information request.
  • View our sample payloads below for examples of updating and removing references.

For an example of how reference information is saved within the UI, take a look at our Intro to References article.

Database

For information regarding reference database tables, see the following articles:

{
     "References": {
          "results": [
               {
                    "name": "Tim Whitaker",
                    "relation": "customerReference.Relation.father",
                    "primaryPhone": "8992163320",
                    "Address": {
                         "address1": "2600 Sheridan Road",
                         "city": "Evanston",
                         "state": "geo.state.IL",
                         "zipcode": "60602",
                         "country": "company.country.USA"
                    }
               }
          ]
     }
}
{
    "References": {
        "results": [
            {
                "name": "Tim Whitaker",
                "relation": "customerReference.relation.brother",
                "primaryPhone": "2024456655",
                "Address": {
                    "country": "company.country.usa",
                    "address1": "2608 Sheridan Road",
                    "zipcode": "60201",
                    "city": "Evanston",
                    "state": "geo.state.IL",
                    "__update": true,
                    "__id": 3506
                },
                "__update": true,
                "__id": 199
            }
        ]
    }
}
{
    "References": {
        "results": [
            {
                "__id": 199,
                "__destroy": "true"
            }
        ]
    }
}
Language
Authorization
Click Try It! to start a request and see the response here!