Retrieve a user

Returns a user object

User objects are a robust representation of the data associated with a user, including details about all of their liabilities. A User is created the first time a customer is taken through a User Connect module to authenticate. Once authenticated, all of a customer's loans will be available on the User object.

Following any successful User connection, it is recommended to fetch the User object and save the Spinwheel userId for any subsequent API interaction.

User Debt

Following a successful user connection as detailed in the User Connect guide, you will be able to use this API to fetch all information related to a users liabilities. Please note that all liabilities will be represented in the following standard format, with some unique data elements within specific loans as defined in the user response examples.


Follow the recipes below for step-by-step guides on authentication and connecting your first user.

Click Try It! to start a request and see the response here!