v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Debt Profile

Request a Debt Profile

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

post/v1/users/{userId}/debtProfile

Path parameters

userIdstring required

Query parameters

liabilityType'STUDENT_LOAN' | 'CREDIT_CARD' | 'HOME_LOAN' | 'AUTO_LOAN' | 'PERSONAL_LOAN' | 'MISCELLANEOUS_LIABILITY'

Request body

Example request

{
  "creditReport": {
    "sourceBureau": "TransUnion",
    "type": "1_BUREAU.FULL"
  },
  "creditScore": {
    "sourceBureau": "TransUnion",
    "model": "VANTAGE_SCORE_3_0"
  }
}

Response

Successful response