Generate and upload Dynamic Template

ℹ️

This request performs two actions.

This request generates a Dynamic Template and uploads it to a loan account as a document. These actions can be performed individually, if preferred. View Generate Dynamic Templates ↗ or Add Loan Document ↗ to learn more.

Dynamic Templates are a powerful tool used to communicate with borrowers and generate agreement documents. Each template can include LoanPro's context engine variables to dynamically reflect the loan's information. Note the following when using this request:

This request generates a Dynamic Template and converts it to a PDF. Once converted, it's added as a document stored within the loan account.

The ID of the Dynamic Template is required to generate it. Dynamic Template IDs can be found within the UI by navigating to Settings > Loan > Dynamic Templates > Dynamic Template Management. To pull Dynamic Template IDs via the API, send a GET request to the CustomForms endpoint:

https://loanpro.simnang.com/api/public/api/1/odata.svc/CustomForms?$select=id,fileName

For an example of how generating a Dynamic Template works within the UI, read our Dynamic Templates – Next Steps article.

Database

(Please note: Dynamic Templates are referred to as Custom Forms within the database.)

For information on Dynamic Templates database tables, see the following articles:

• Database – Custom Form Entity (custom_form_entity)
• Database – Custom Form Tool to Loan Map (custom_form_tool__loan)
• Database – Custom Form Tool Entity (custom_form_tool_entity)
• Database – Custom Form Section Entity (custom_form_section_entity)

Sample Payloads

{
    "id": 9,
    "convertAsDocument": true,
    "documentSectionId": 3,
    "documentTitle": "Loan Agreement",
    "isVisible": true
}