The Managing Users endpoints let you retrieve and delete users, manage their bank accounts, and update account details for their liabilities.
| Endpoint | What It Does | When to Use It |
|---|---|---|
| Retrieve a User | Returns the latest cached data for a user, including their liabilities and bank accounts. | Retrieving a user's current Profile information without requesting fresh credit data. |
| Delete a User | Deletes a user and their associated data from Spinwheel. | Offboarding a user or removing their data entirely. |
| Bank Accounts | ||
| Add a Bank Account | Adds a checking or savings account to a user. | Connecting a new bank account to an existing user so it can be used for Real-Time Balances or included in a user’s Profile. |
| Update a Bank Account | Updates an existing bank account's account number, account type, or telephone banking PIN. | Correcting or changing bank account details without deleting and recreating the account. |
| Delete a Bank Account | Removes a bank account from a user. | Removing an account that should no longer be associated with the user. |
| Create a Payable Bank Account | Creates a payable bank account for a user. | Adding bank account details that can be used to make payments on the user's behalf. |
| Update Liability Details | ||
| Auto Loans | Updates the account details for a user's auto loan. | Correcting an auto loan account number or ensuring the user has a full account number before making payments. |
| Credit Cards | Updates the account details for a user's credit card. | Correcting a credit card account number or ensuring the user has a full account number before making payments. |
| Home Loans | Updates the account details for a user's home loan. | Correcting a home loan account number or ensuring the user has a full account number before making payments. |
| Personal Loans | Updates the account details for a user's personal loan. | Correcting a personal loan account number or ensuring the user has a full account number before making payments. |
| Student Loans | Updates the account number and creditor details for a user's student loan. | Correcting student loan payment details, including the account number or billing information needed to route payments to the right institution. |
| Miscellaneous Liabilities | Updates the account details for a user's miscellaneous liability. | Correcting a misc. liability account number or ensuring the user has a full account number before making payments. |
📘 For information on retrieving fresh liability data rather than cached user data, see the Profile Overview and Real-Time Liability Data Overview.