API – Loan Checklist


This article covers modifying checklist items for existing loans. You can configure checklists in the UI or through the API, which this article covers. This is done through the API by sending a PUT request to the loan on which you wish to modify the checklist item value. It also assumes you already have an existing loan.

Modifying Checklist Items

To modify the checklist for a loan, you will need to send a PUT request to the URL of the desired loan. For example, to modify the loan with the id 515, the URL would be

If you don't have a loan yet, see Creating a Loan with the API. If you have a loan but don't know the loan ID, see our article on Finding Loan and Customer IDs

Request Body

  "ChecklistItemValues": {
    "results": [
        "checklistId": 1,
        "checklistItemId": "8",
        "checklistItemValue": 1
  • checklistId – The ID of the checklist
  • checklistItemId – The ID of the item on the checklist
  • checklistItemValue – The value to set the checklist item to (1 = checked, 0 = unchecked)

How did we do?

Powered by HelpDocs (opens in a new tab)