v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Debt Profile

Subscribe to Debt Profile Refresh

Subscribe to updates for a user.

post/v1/users/{userId}/subscriptions

Path parameters

userIdstring required

Request body

Example request

{
  "subscriptions": [
    {
      "subscriptionType": "DEBT_PROFILE.REFRESH",
      "configuration": {
        "refreshFrequency": "MONTHLY",
        "creditReport": {
          "type": "1_BUREAU.FULL",
          "sourceBureau": "TransUnion"
        }
      }
    }
  ]
}

Response

List of subscription creation results

Example response

[
  {
    "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "subscriptionType": "DEBT_PROFILE.REFRESH",
    "userId": "1c9d0f64-1234-4562-b3fc-2c963f66afad",
    "status": "ACTIVE",
    "configuration": {
      "refreshFrequency": "MONTHLY",
      "creditReport": {
        "type": "1_BUREAU.FULL",
        "sourceBureau": "TransUnion"
      },
      "creditScore": {
        "model": "VANTAGE_SCORE_3_0",
        "sourceBureau": "TransUnion"
      }
    },
    "createdOn": 1757055616000,
    "updatedOn": 1757055616000
  }
]