Enable monitoring

Enable monitoring for a funded business to continuously evaluate its financial health using updated transaction data. When monitoring is enabled, Ocrolus establishes the underwriting and monitoring periods using the business's funding date and begins processing eligible post-underwriting data.

The Book enters PENDING_ACTIVATION when monitoring is enabled and becomes ACTIVE after eligible monitoring data is successfully processed.

📘

Early access

This API is in early access. Functionality, behavior, and availability might change before general release. To request access or learn more, contact your Account Manager.

After monitoring is enabled:

  • If eligible post-underwriting Plaid data already exists on the Book, Ocrolus initiates Monitoring processing using the existing data.
  • If eligible data is not available, the Book remains PENDING_ACTIVATION until eligible Plaid data is subsequently processed.
  • Monitoring becomes ACTIVE after Monitoring data is successfully processed.
  • If initial Monitoring processing fails, the Book remains PENDING_ACTIVATION.
  • Only one Book can be actively monitored for a business at a time.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID of the business for which Monitoring is being enabled.

Body Params
string

UUID of the funded Book to enable Monitoring.

string
required

Date the business was funded, in YYYY-MM-DD format. The funding date is used to establish the underwriting and Monitoring periods and cannot be a future date.

Responses

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