Initiate Custom Form Generation

General

Custom Forms are used by lenders to communicate with their borrowers. The forms typically include context variables that update to reflect the loan's information. Here's what you need to know about this request:

• This request simply generates one or more forms for a single loan.
• This request does not download the generated form. You can download your generated forms with a Check Download Status request.
• You will need to know the ID of your custom form to generate it. To find custom form IDs, you will need to send a GET request to the CustomForms endpoint. The response from this request can be lengthy. Thus, if you'd like to pull only the custom forms' IDs, names, and entity that they're associated with, you can use a $select parameter. Here is an example of both endpoints:

https://loanpro.simnang.com/api/public/api/1/odata.svc/CustomForms()

https://loanpro.simnang.com/api/public/api/1/odata.svc/CustomForms()?$select=id,name,entityType

• If you are generating multiple forms in one request, the payload will be formatted a bit differently. Instead of using the id parameter, the payload will look sort of like an index. Here's an example of how a payload with multiple forms is formatted:

{
    "0": 63,
    "1": 68,
    "2": 69,
    "3": 70,
    "4": 71,
    "5": 74
}

For more information regarding generating custom forms via the API, take a glance at our API – Custom Forms article on our help site.

And for an example of how generating forms works within the UI, read our Custom Forms – Next Steps article.

Database

For information on custom form 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)

{
"id": 71
}

📘

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.