Request a Debt Profile

Requests the most recent available debt profile for a given user using the provided configuration options.

Order a Debt Profile for a connected user. This is the starting point for nearly everything else in the Profile API. The response carries the consumer's liabilities, the capabilities matrix that governs real-time data and payments, and the credit file itself.


Include the creditReport and creditScore objects, and set sourceBureau to pin the request to TransUnion or Equifax. Omit sourceBureau and Spinwheel routes to your configured default with automatic failover (recommended).

Note: A Debt Profile pull is capped at one request per user per day. Read the cached profile with Retrieve a User instead, and use the secure API URL to order unmasked account numbers or other secure data.

Path Params
string
required
Query Params
string
enum
Allowed:
Body Params
creditReport
object

Defines the credit report specific configuration.

creditScore
object

Defines the credit score specific configuration.

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