GuidesRecipesAPI Reference
Log In
API Reference

Perform action on a loan borrower

This endpoint allows a variety of actions to be taken on a loan borrower

📌

Available actions

ORDER_VERIFICATION - order verification for the loan borrower (requires Verifications v2 feature be enabled)
DISCONNECT_BORROWER - disconnect loan borrower payroll and bank data connections for verification purposes (requires Verifications v2 feature be enabled)
SEND_VERIFICATION_REMINDER - send email reminder to loan borrower to complete the verification experience (requires Verifications v2 feature be enabled)
SET_PRIMARY_BORROWER - set loan borrower as the primary borrower on the loan.
LINK_BORROWER - link a borrower to a loan

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

Borrower ID.

uuid
required

Loan ID.

Body Params

Available properties for a borrower action

string
enum
required

Action to perform.

Allowed:
string
enum
required

Types of verification orders.

Allowed:
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