User Statuses

Key Status Properties


Defines the authentication status of the last communicated login credentials of the end user. Here you want to look at either the isValid flag for isValid: true or the statusCode: 2000 which will give you the successful value. Otherwise, you’ll be looking for a 5000 status code.


Tells us the current state of the data available on the user and how up to date it is (the last time the user’s account was refreshed successfully with Spinwheel). You will want to look for the statusCode here as well. 2000 being successful, 2001 meaning the update is in progress, and 5000 which will denote an error. If there is an error you will want to look for the errorDescription.

Here you can see both the lastSuccessfulSyncOn and lastSyncAttemptOn in epoch timestamp. Ideally, these will always be equal.

studentLoanAccounts.loanAccounts.summary.isPaidOff: true

Means that the loanAccount of that particular user has been paid off or paid in full (we can find this on the loan level as well via the loan.status). studentLoanAccounts.dataSyncStatus.errorDescription will also give you some insight if the loan is paid off or migrated.

Within the dataSyncStatus, you can listen for a 2001 or a 5000 statusCode to determine if you need to look in further on the user.


Will also give you a look into accounts we have been able to confirm were migrated to a new servicer from their original

To learn more about our debt APIs and 1-click solutions, visit

What’s Next