Guides
API Keys

Welcome to Spinwheel!

We are your partner for embedded debt solutions!

To simplify your experience and integration, we have created a number of guides and recipes for key use cases, and are continually adding to our developer portal with new features and capabilities.

To start off, there are a couple of key sections to highlight around the Spinwheel platform.

🤖

As you come up with questions or navigate our APIs for your integration, don't hesitate to ping our chat bot. It has been specifically trained on our APIs and use cases and should be able to give quick assistance to most items.

Retrieve Your API Keys

Accessing the Spinwheel platform requires a developer account with credentials. To get your Spinwheel secret key:

  1. Navigate to https://developer.spinwheel.io
  2. Create an account using your email, or existing Google account.
  3. At the bottom of the key management section under the heading Sandbox API Keys you will find your new secret key, which can be used to access all Spinwheel sandbox services.

📘

Production Access

If you are ready to proceed with a production integration, please contact your Spinwheel representative.

Endpoints

All of our endpoints and functionality are accessible via Sandbox, and align to our Production functionality.

The following endpoints are the base URLs for your use with the APIs:

Secure Endpoints

There are specific functionalities that require an additional layer of security. For those use cases the following URLs are required to be used. These will be called out in the documentation if necessary, but they are listed here for your convenience:

Getting Started!

Once you have retrieved your secret key, you can start working with the Spinwheel APIs!

As you get started, it is important to understand that certain functions have pre-requisite steps to enable the capability you are trying to leverage.

Connect a User

For nearly all of the APIs, you must first connect a user. A connected user in our system enables you to connect their debt, set them up for different features, subscribe them to recurring functionality and so on.

To support multiple business cases of our partners, we provide options for how to authenticate/connect a user. As you review your use case, please touch base with your Spinwheel point of contact to align on the best connection strategy.

📘

Important Note

Once a user is connected to the Spinwheel platform, their userId is the unique key used for accessing most of our APIs.

Connect a User's Debt Profile

Following a user connection, to start working with the user's debt profile and liabilities you will want to call our Debt Profile endpoint. There are a number of ways to enroll in recurring debt profile updates and specific features, but this typically kicks off with a first time Debt Profile pull/connection based on the target features you are looking for - followed by a subscription enrollment.

It's helpful to note that a debt profile is treated as a snapshot in time. Depending on your use case you will have a number of additional data enrichment and liability action endpoints which will allow you to fetch real time data, request payoff quotes, initiate payment requests, and more.

Liability Action and Data Enrichment

For an authenticate user with a debt profile connection, you are now able to access enhanced functions such as payments, real time data, and more.

Most of these endpoints operate at a liability level opt-in, where you will choose the liabilities you want to take action on, update data for, or request unique elements for. Below are a few examples for endpoints you can utilize.

Glossary

Our guides make use of some terminology that you may be unfamiliar with. We suggest taking a look at our glossary before getting started!

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

Updated 24 days ago