GuidesRecipesAPI Reference
Log In
API Reference

đźš§ Create a custom form request (BETA)

đźš§

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

This endpoint will create a custom form request for a loan and notify the borrower.
Company-level credentials can create requests for loans in their company. The form type's setting
(econsent_requests_enabled, credit_auth_requests_enabled or share_info_requests_enabled) must be enabled:
for company-level credentials and team members, on the loan's loan officer; for loan officers, on their own profile.
If an open request of the same type already exists for the borrower, that request is returned and the
borrower is notified again.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Loan ID.

Body Params

Available properties for creating a custom form request.

string
enum
required

Type of custom form request to create.

Allowed:
uuid
required

ID of the loan borrower to assign the request to.

Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json