API Reference

Enroll Borrowers

post
https://{baseUrl}/monitor/borrowers

Enroll a batch of Borrowers in one or more credit monitoring products. Results are returned per borrower and product — one invalid borrower does not fail the batch. Enrollment with the bureau is asynchronous; enrollments start in the pending status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
borrowerIds
array of strings
required

IDs of the Borrowers to enroll. Borrowers must belong to the calling customer's lender.

borrowerIds*
types
array of strings
required

The monitoring products to enroll each borrower in

types*
Allowed:
Headers
string
required

The environment specific API Key to access the API

Responses

403

The creditMonitoring module is not enabled for this customer

Updated 15 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago

Did this page help you?