🚧

Debt Profile Subscription Billing

Please be aware that establishing a subscription for a user via this endpoint will initiate billable events whenever a new credit report is fetched. Utilize your best judgement when calling this endpoint given that information.

Overview

To support the most up-to-date information for a user, we provide a function that will refresh the credit report data that is provided back with each /v1/users endpoint call. This endpoint is typically leveraged to evaluate if there are new tradelines for a user or to fetch the latest credit report-based information set, such as statementBalance, credit limit, credit score, etc.

Requesting a Debt Profile Subscription

To request a Debt Profile refresh, there are two endpoints you should be aware of. One to subscribe a user, and one to determine the details of a user's subscription v1/users/{userId}/creditProfile/equifax/subscriptions.

1. Subscribe to User Refresh - This endpoint will allow you to subscribe to Equifax credit reports to refresh the report information for a user and set the frequency of the refreshes.
2. User Subscription Details - To check if a user is subscribed to credit report refreshes, you can get the subscription specifics with this endpoint.
3. Retrieve User - Once the refresh request has been completed for an individual user, you will call the retrieve user endpoint and any data that was available to be updated will be updated at that point. Be aware that creditors typically only report once per month to the credit bureaus.

Recommended Refresh Cadence

As a general rule, we recommend refreshing the user once per month for use cases with an ongoing need for up-to-date user liabilities. As noted, the creditors only report to the bureaus once per month and at different intervals.

If your use case has a need for ad-hoc refreshes intra-month, this can be supported but please reach out to your Spinwheel contact to review best practices before you proceed with this.