A Debt Profile is a snapshot of a consumer's liabilities, pulled from a credit report. The endpoints below cover the full lifecycle of that data: ordering it, keeping it current, and retrieving it in different forms.
| Endpoint | What It Does | When to Use It |
|---|---|---|
| Request a Debt Profile | Orders a fresh credit report, credit score, or both, from the bureau of your choice. | The starting point for any user — onboarding, a one-off check, or the required first pull before a user can be enrolled in a subscription. |
| Subscribe to Debt Profile Refresh | Enrolls a user in automatic weekly or monthly Debt Profile refreshes. | Ongoing use cases where you need a user's profile to stay current without making repeat ad hoc calls yourself. Requires an initial Debt Profile pull first. |
| Get Refresh Subscriptions | Returns the subscription details for a given user — whether they're subscribed, and at what cadence. | Confirming a user's current refresh cadence, or checking subscription status before making a change. |
| Delete Refresh Subscriptions | Cancels a user's existing refresh subscription. | Changing a user's refresh cadence (delete, then re-subscribe) or offboarding a user from recurring refreshes entirely. |
| Get a PDF Credit Report | Returns a PDF version of the user's credit report. | Consumer-facing display, dispute or compliance review, or anywhere you need a human-readable, shareable copy rather than structured JSON. |
📘 For the fuller picture on bureaus, the capabilities matrix, data types, and error handling, see the Debt Profile intro guide.