SPspinwheel
User Management

Disconnect Liabilities

Occasionally, circumstances may arise when you'd like to disconnect a User's liability. Whether your user was abducted by aliens or they won the Powerball jackpot (the likeliest scenarios we can envision), this API provides that functionality. Simply send a POST request with a body containing the loanAccountIds that you'd like to disconnect to the above url. Sadly, we don't retain user information, so if a User returns from their alien abduction and still needs to manage their loans they'll have to start from square one when they reconnect.

post/v1/users/{userId}/disconnect

Request

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

Path parameters

userIdstring required

Request body

Example request

{
  "studentLoanAccounts": [
    {
      "loanAccountId": "1dacd5a2-daa7-4812-9e2a-dc5ad00e17d5",
      "accountId": "1dacd5a2-daa7-4812-9e2a-dc5ad00e17d5"
    }
  ]
}

Response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.