This request allows you to pull the Checklists values for a loan.
General
Lenders use Checklists to track their loan servicing practices. Here's what you need to know about checklists:
-
Checklists are created at the entity-level and then apply to each loan individually.
-
Users can manually complete checklist items; or, users can use Rules Applied to automatically complete them when rule criteria is met.
-
This request displays which checklists within a loan have been completed. The payload will show IDs instead of checklist names, and here is a breakdown of what each ID parameter means:
id: This is the database entity ID of the checklist (essentially, this is the primary key for the table)
checklistId: This is the ID of the checklist itself.
checklistItemId: This is the ID of the item within the checklist.
checklistItemValue: This is a boolean value that determines whether a checklist item has been completed.
For an example of how checklists work within the UI, take a look at our Checklists article.
Database
For more information on checklist database tables, see the following articles:
- Database – Checklist Entity (checklist_entity)
- Database – Tenant Checklist Entity (tenant_checklist_entity)
- Database – Tenant Checklist Category Entity (tenant_checklist_category_entity)
- Database – Checklist item Entity (checklist_item_entity)
- Database – Checklist Item To Checklist Entity Map (checklist_item__entity)
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.