Skip to main content

Account Monitoring API Reference Beta

Overview​

Introduction​

Account Monitoring allows you to periodically refresh a consumer's bank data without requiring the consumer to re-authenticate each time. Once a consumer grants long-term consent through the NovaConnect widget, Nova Credit retains access to their bank connections for up to 12 months, enabling you to call the refresh endpoint on-demand to obtain an updated report. The connection will be automatically revoked after 12 months or on request.

Enablement​

Account Monitoring is currently in beta and is supported for Cash Atlas v2 only.

To enable and configure Account Monitoring functionality, please contact your Nova Credit representative. Our support team will assist you in setting up the necessary configurations to use this functionality.

How It Works​

1. Initial Widget Report​

When Account Monitoring is enabled, completing the standard NovaConnect widget flow grants Nova Credit ongoing access to the consumer's bank connections for a consent duration of up to 12 months, after which the consumer must reauthorize. The authorization disclosure shown in the widget covers the Account Monitoring scope and duration.

This step must be completed once before a refresh can be initiated. After that, multiple refreshes can be initiated without the consumer needing to go through the widget again.

2. Initiating a Refresh​

To request a refreshed report, call POST /connect/cash-atlas/v2/refresh with the consumer's identifier. Nova Credit will fetch the latest bank data and generate a new Cash Atlas report. The endpoint returns a new public token for this report.

3. Retrieving a Refreshed Report​

Tracking the status of a refreshed report and retrieving it works the same way as a standard Cash Atlas report. Track the status via webhooks or by polling GET /connect/status, and retrieve the report with GET /connect/cash-atlas/v2/json using the public token returned by the refresh endpoint.

4. Revocation​

Call POST /connect/consumers/:consumerId/revoke to revoke a consumer's bank connections in the case that the consumer requests it or you no longer need access. Nova Credit will revoke all active connections for that consumer and send a REVOCATION_SUCCEEDED webhook once complete.

5. Re-credentialing​

If a consumer's bank connections become unusable or their 12-month consent period expires, the consumer will need to complete the NovaConnect widget flow again to re-establish access. You can tell when this is required by subscribing to the RECREDENTIAL_REQUIRED and CONNECTION_EXPIRING webhooks — see the Webhooks section for details. Re-credentialing will reset the 12-month expiry window.

OpenAPI Specification​

Nova Credit Account Monitoring API documentation is also available as an OpenAPI Specification you can download using the link below.

Endpoints​

Webhooks​

Account Monitoring introduces a new webhook event type, CONSUMER_CONNECTION, with four new event statuses. Subscribe to these in the Developer tab of the Nova Credit Dashboard alongside your existing webhook subscriptions.

Nova Credit makes a POST request to your configured callback URL when one of these events occurs.

Changelog​

October 2026

  • API references for endpoints and webhooks are now rendered from the OpenAPI Specification
  • Various updates to the OpenAPI Specification:
    • 404 INVALID_TOKEN response for POST /connect/cash-atlas/v2/refresh
    • 403 and 404 response schemas now accept either error response shape
    • Additional response and webhook descriptions

May 2026

  • POST /connect/consumers/:consumerId/revoke documentation updated to use Basic auth

April 2026

  • Initial documentation ahead of beta feature readiness
    • Includes endpoints:
      • POST /connect/account-monitoring/refresh
      • POST /connect/account-monitoring/revoke
    • Includes webhooks:
      • CONNECTION_EXPIRING
      • RECREDENTIAL_REQUIRED
      • REVOCATION_FAILED
      • REVOCATION_SUCCEEDED