SPspinwheel
Debt Profile

Get a Debt Profile - Equifax

Changed on

This endpoint allows you to order an Equifax credit report for a User. The report includes detailed information on the user's liabilities, credit score, and other relevant financial data.

post/v1/users/{userId}/creditProfile/equifax

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/{userId}/creditProfile/equifax
  • 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": {
    "type": "FULL"
  },
  "creditScore": {
    "model": "EquifaxVantageScore3.0"
  }
}

Response

Successful response

Changes