SPspinwheel
Debt Profile

Subscribe to Debt Profile Refresh

Changed on

This endpoint allows you to subscribe to Equifax credit report for a User.

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

Request

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

Path parameters

userIdstring required

Request body

refreshFrequency'MONTHLY' | 'WEEKLY' required

Frequency of the subscription refresh

Example request

{
  "creditReport": {
    "type": "FULL"
  },
  "creditScore": {
    "model": "EquifaxVantageScore3.0"
  },
  "refreshFrequency": "MONTHLY"
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "subscriptionId": "99364039-e0c0-4413-a113-55723af6ad11",
    "userId": "3fef7131-71ae-4204-a8bd-3fc3ad6b4b82",
    "creditReport": {
      "type": "FULL"
    },
    "creditScore": {
      "model": "EquifaxVantageScore3.0"
    }
  }
}

Changes