Link Customer To Loan

This request allows you to link a customer to a loan.

General

Loans and customers are "linked" when they become associated with each other. Here's what you need to know about linking loans and customers:

  • This request is sent through the Loans endpoint. Thus, the Customers object is included in the payload.
  • Both loans and customers can be created without being associated to each other.
  • Similar to the UI, you can link multiple customers to a loan in a single request.
  • Like we've mentioned in other requests, many users tend to want to simultaneously link a customer when they create a new loan within one request. Although we don't have a request here on ReadMe displaying how to do this specifically, it is definitely possible. If this is the case for you, you will need to create a new customer first. Here's why:

    When you create a new loan and link a customer all within the same request, you send it through the Loans endpoint. Therefore, you will need a valid customer ID since you can't create a customer through the Loans endpoint.

For more information, take a look at our API – Linking and Unlinking Customers and Loans article.

And for an example of how linking works within the UI, read Link a Customer to a Loan.

Database

For information on loans and customers database tables, see the following articles:

{
    "Customers": {
        "results": [
            {
                "__id": 873,
                "__setLoanRole": "loan.customerRole.primary"    
            }
        ]
    }
}

📘

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—hit Try It to send the request.

However, 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.

Language
Authentication
Click Try It! to start a request and see the response here!