Subscribe to Debt Profile Refresh

Subscribe to updates for a user.

Enroll a user in automatic Debt Profile refreshes so their liabilities, balances, and scores stay current without you ordering a new report each time.

The subscriptions array takes up to 50 subscriptions per request, defining what to refresh and on what cadence. Each time a refresh completes, Spinwheel fires the USER_CREDIT_PROFILE_TRANSACTION webhook to signal that a new Debt Profile is available — or USER_CREDIT_PROFILE_TRANSACTION_FAILED if the credit report pull didn't succeed.

The webhook is the signal, not the data. Call Retrieve a User to pull the refreshed Debt Profile itself.

Note: A user needs at least one completed Debt Profile pull before a subscription can be created, and refreshes use the bureau the user was originally connected with.

Path Params
string
required
Body Params
subscriptions
array of objects
required
length ≤ 50

Array of subscriptions to create.

subscriptions*
Responses

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