SPspinwheel
Debt Profile

Request a Debt Profile

Changed on

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

post/v1/users/{userId}/debtProfile

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/{userId}/debtProfile
  • Auth
    API key in header Authorization

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

Changes

  • aa032469622fRevision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status