# Embedded Debt Solutions API Docs Documentation > Welcome to Spinwheel. We are your partner for embedded debt solutions. ## Guides: Getting Started - [Overview](https://docs.spinwheel.io/docs/getting-started-guide.md) - [Why User Consent Is Critical](https://docs.spinwheel.io/docs/user-consent.md) - [Spinwheel Products Overview](https://docs.spinwheel.io/docs/spinwheel-products-overview.md) - [Who We Serve](https://docs.spinwheel.io/docs/who-we-serve.md) - [Common Use Cases](https://docs.spinwheel.io/docs/common-use-cases.md) - [Quick Start](https://docs.spinwheel.io/docs/quick-start.md) - [Get API Keys](https://docs.spinwheel.io/docs/get-api-keys.md) - Credit Data AI Lab - [Overview](https://docs.spinwheel.io/docs/building-with-ai-1.md): A guide to help you get started utilizing AI application building tools. To learn more about Spinwheel's Credit Data AI Lab, visit https://spinwheel.io/credit-data-ai-lab. - [Connect - SMS UI Prompt](https://docs.spinwheel.io/docs/connect-ai-ui.md): Paste this prompt into the AI coding tool of your choice to help create the UI for your integration. - [Debt Profile UI Prompt](https://docs.spinwheel.io/docs/debt-profile-ai-ui.md): Paste this prompt into the AI coding tool of your choice to help create the UI for your integration. ## Guides: Glossary - [Key Terms](https://docs.spinwheel.io/docs/key-terms.md) - [Account Ratings](https://docs.spinwheel.io/docs/account-ratings-1.md) - [Bankruptcy Codes](https://docs.spinwheel.io/docs/bankruptcy-codes.md) - [Collection Status Codes](https://docs.spinwheel.io/docs/collection-status-codes.md) - [Credit Score Details & Factors - VantageScore 3.0](https://docs.spinwheel.io/docs/credit-score-factors.md): The below codes represent the credit score factors object provided within the creditReports object. - [Industry Codes and Types](https://docs.spinwheel.io/docs/industry-codes-and-types.md) - [Liability Subtypes](https://docs.spinwheel.io/docs/liability-subtypes.md) - [Narrative Codes](https://docs.spinwheel.io/docs/narrative-codes.md) - [Payment History Codes](https://docs.spinwheel.io/docs/payment-history-codes.md) ## Guides: Products - [Connect](https://docs.spinwheel.io/docs/connect-overview.md) - [Risk Layer Reason Codes](https://docs.spinwheel.io/docs/reason-codes.md) - [Profile](https://docs.spinwheel.io/docs/profile.md) - [Using Multi-Bureau Support](https://docs.spinwheel.io/docs/multi-bureau-support.md) - [Debt Profile Refresh Subscriptions](https://docs.spinwheel.io/docs/user-refresh-subscriptions.md): Updating a user's tradelines and data in their Profile by subscribing them to Debt Profile Refreshes. - [Profile Enhancements](https://docs.spinwheel.io/docs/profile-enhancements.md) - [Pay](https://docs.spinwheel.io/docs/pay-overview.md) - [Payment Process](https://docs.spinwheel.io/docs/payments-process.md): Get started with bill pay, to make payments towards liabilities. - [Error Description Superset](https://docs.spinwheel.io/docs/error-description-superset.md): an errorDescription may be returned for a FAILED/RETURNED payment - [Verify a Payer Using a Plaid Token](https://docs.spinwheel.io/docs/verify-a-payer-using-a-plaid-token.md) ## Guides: Implementation Guides - Sandbox - [Overview](https://docs.spinwheel.io/docs/overview.md) - [Test Users](https://docs.spinwheel.io/docs/test-users.md) - [Test Error Cases](https://docs.spinwheel.io/docs/test-error-cases.md) - [Connect a User](https://docs.spinwheel.io/docs/user-connect.md): Authenticate a user, and connect their liabilities - all with a phone number and date of birth. - Connect API - [SMS](https://docs.spinwheel.io/docs/connect-api-sms.md): The following guide will provide guidance on connecting users with our SMS OTP flow via API. - [Pre-Verified (Phone)](https://docs.spinwheel.io/docs/connect-api-pre-verified.md): The following guide will best practices on connecting users that have been pre-verified via SMS or phone call. - [KBA](https://docs.spinwheel.io/docs/connect-api-kba.md): The following guide will provide guidance on connecting users with our KBA auth flow via API. - [Network Token](https://docs.spinwheel.io/docs/spinwheel-network-token.md) - [Accessing Unmasked Data](https://docs.spinwheel.io/docs/accessing-unmasked-data.md) - [Risk Layer: Enhanced Fraud Protection & User Corrections](https://docs.spinwheel.io/docs/enhanced-fraud-protection-user-corrections.md) - Debt Profiles - [Account Number Update](https://docs.spinwheel.io/docs/credit-card-account-number-update.md) - [Refreshing Data](https://docs.spinwheel.io/docs/refreshing-data.md): Updating of your user's report and liability data. - [Real-Time Liability Data](https://docs.spinwheel.io/docs/real-time-balance.md): This guide explains how to determine eligibility, request a refresh, and retrieve updated real-time liability data, including credit card balances, credit card APRs, and payoff quotes for auto and… - [Credit Card APR Refresh](https://docs.spinwheel.io/docs/credit-card-apr-refresh.md): This guide walks through how to request a refreshed Annual Percentage Rate (APR) for a credit card and read the updated value back from Spinwheel. - [Bank Account Real-Time Balances](https://docs.spinwheel.io/docs/bank-account-real-time-balances.md) - [Webhooks](https://docs.spinwheel.io/docs/webhooks.md) ## API Reference: Overview - [Introduction](https://docs.spinwheel.io/reference/introduction.md) - [API Authentication](https://docs.spinwheel.io/reference/api-authentication.md) - [API Environments](https://docs.spinwheel.io/reference/api-environments.md) - [Rate Limits](https://docs.spinwheel.io/reference/rate-limits.md) ## API Reference: Managing Users - [Overview](https://docs.spinwheel.io/reference/overview.md) - [Retrieve a User](https://docs.spinwheel.io/reference/get-user-profile.md): Returns a User object - [Delete a User](https://docs.spinwheel.io/reference/delete.md): This API allows you to delete a User. We do not retain user information, so you must re-authenticate as a new user if you need to connect again. - Bank Accounts - [Add a Bank Account](https://docs.spinwheel.io/reference/create-bank-account.md): Create a bank account for the user - [Update a Bank Account](https://docs.spinwheel.io/reference/update-bank-account.md): Update a bank account for the user - [Delete a Bank Account](https://docs.spinwheel.io/reference/delete-bank-account.md): Delete a bank account for the user - [Create a Payable Bank Account](https://docs.spinwheel.io/reference/create-payable-bank-account.md): Create a payable bank account for the user - Update Liability Details - [Update an Auto Loan](https://docs.spinwheel.io/reference/update-auto-loan.md): This API updates user records with accurate auto loan account numbers. - [Update a Credit Card Profile](https://docs.spinwheel.io/reference/update.md): Supply card details Spinwheel could not resolve. Send an account number, an expiration date, or both. At least one of `cardProfile.accountNumber` and `cardProfile.expirationDate` must be present; an… - [Update a Home Loan](https://docs.spinwheel.io/reference/update-home-loan.md): This API updates user records with accurate home loan account numbers. - [Update a Personal Loan](https://docs.spinwheel.io/reference/update-personal-loan.md): This API updates user records with accurate personal loan account numbers. - [Update a Student Loan](https://docs.spinwheel.io/reference/update-student-loan.md): This API updates user records with accurate student loan account numbers and correct billing addresses to ensure proper payments to institutions. - [Update a Miscellaneous Liability](https://docs.spinwheel.io/reference/update-miscellaneous-liability.md): This API updates user records with accurate miscellaneous liability account numbers. ## API Reference: Connect - [Overview](https://docs.spinwheel.io/reference/overview-2.md) - SMS - [Connect a User via SMS](https://docs.spinwheel.io/reference/connect-with-sms.md): Connect a User using SMS verification. Identify the user by date of birth, by legal first and last name as it appears on their credit file, or by the last four digits of their Social Security number.… - [Verify an SMS Connection](https://docs.spinwheel.io/reference/verify-code.md): Complete an SMS connection using the passcode sent to the user's device. Identification against the identity attributes sent to POST /v1/users/connect/sms happens on this call, so identification… - Pre-Verified - [Connect a User - Phone](https://docs.spinwheel.io/reference/connect-preverified-phone-number.md): Connect a User that has already been pre-verified by phone number/SMS. Identify the user by date of birth, by legal first and last name as it appears on their credit file, or by the last four digits… - [Connect a User - User Profile](https://docs.spinwheel.io/reference/connect-preverified-user-profile.md): Connect a User that has already been verified using another credit bureau. This API requires Spinwheel Support approval to enable it before it can be used. - KBA - [Connect a User via KBA](https://docs.spinwheel.io/reference/connect-with-kba.md): Connect a User using a set of personal questions provided by a credit bureau. - [Submit Answers for KBA](https://docs.spinwheel.io/reference/verify-kba-answers.md): Complete a connect KBA flow by providing the users's answers to the previously returned security questions. - Network Token - [Connect a User via Network Token](https://docs.spinwheel.io/reference/create-network-user.md): Create user from Spinwheel network token. - [Verify a User](https://docs.spinwheel.io/reference/connect-verification.md): Run an enhanced verification or make corrections to a given identity. On success, the stored profile is replaced with the submitted values. Submit the user's complete profile. Only the first address… ## API Reference: Profile - [Overview](https://docs.spinwheel.io/reference/overview-3.md) - [Request a Debt Profile](https://docs.spinwheel.io/reference/fetch-debt-profile.md): Requests the most recent available debt profile for a given user using the provided configuration options. - [Get a PDF Credit Report](https://docs.spinwheel.io/reference/get-credit-report-pdf.md): Returns a PDF of the user's credit report - Refresh Subscriptions - [Subscribe to Debt Profile Refresh](https://docs.spinwheel.io/reference/subscribe-to-debt-profile-refresh.md): Subscribe to updates for a user. - [Delete Refresh Subscriptions](https://docs.spinwheel.io/reference/delete-refresh-subscriptions.md): Delete a subscription for a user. By default, all subscriptions are deleted unless specific filters are provided. - [Get Refresh Subscriptions](https://docs.spinwheel.io/reference/get-refresh-subscriptions.md): Get a list of all subscriptions for a user. Optional query parameters allow filtering by status or subscription type. - [Match partner liabilities to a credit report](https://docs.spinwheel.io/reference/match.md): Validates partner-submitted liabilities so they can be matched to the user's credit report to enable payments. Rejects the request if the user has not completed Connect, a match is already in… ## API Reference: Profile Enhancements - [Real-Time Data Overview](https://docs.spinwheel.io/reference/real-time-liability-data-overview.md) - [Request Liability Data](https://docs.spinwheel.io/reference/refresh.md): This API will trigger the process of refreshing liabilities given in the POST body. This process is asynchronous and you can either poll results by using API GET… - [Poll Request Status](https://docs.spinwheel.io/reference/get-refresh-status.md): Polling API to get status of refresh transactions based on the extRequestId - [Retrieve extended card profile](https://docs.spinwheel.io/reference/extended-profile.md): Returns the data you need to display and transact on a connected user's credit cards: card brand name, card art and, on the secure host, the expiration date. This endpoint is synchronous. You get… - [Vehicle Data](https://docs.spinwheel.io/reference/vehicles.md) - Vehicle Lookup - [Get Details from VIN](https://docs.spinwheel.io/reference/parse-vin.md): Get vehicle details - [Get Details From License Plate and State](https://docs.spinwheel.io/reference/parse-license-plate.md): Get vehicle details from a license plate and state - Vehicle Attributes - [Get a List of Trims](https://docs.spinwheel.io/reference/get-trims.md): Get a list of trims for vehicles - [Get a List of Models](https://docs.spinwheel.io/reference/get-models.md): Get a list of models for vehicles - [Get a List of Makes](https://docs.spinwheel.io/reference/get-makes.md): Get a list of makes for vehicles - [Get a List of Years](https://docs.spinwheel.io/reference/get-years.md): Get a list of years for vehicles ## API Reference: Pay - [Payers](https://docs.spinwheel.io/reference/payers-overview.md) - [Create a Partner Payer](https://docs.spinwheel.io/reference/create-partner-payer.md): To fund your FBO account, you must first link an external bank account by creating a Payer object. This object acts as the designated source of funds for all Payment to Platform transactions. You may… - [Verify a Payer](https://docs.spinwheel.io/reference/execute-verification.md): This API will allow payer to verify their bank account. - [Delete a Payer](https://docs.spinwheel.io/reference/delete-payer.md): Should you or your customers want to remove a Payer, you can do so using this API. In your DELETE request, simply add the PayerId as a slug. Please note that when a Payer is deleted, we will keep a… - [Get a List of Payers](https://docs.spinwheel.io/reference/get-payers.md): You can retrieve a list of the Payers you've created by sending a GET request to: /v1/payments/payers A successful response returns an array that contains identifying information for each of the… - [Get Single Payer Details](https://docs.spinwheel.io/reference/get-payer-account-details.md): This API will allow you to get a single payer account details with a given payerId if it exists. - [Transactions](https://docs.spinwheel.io/reference/transactions.md) - [Get a List of Transactions](https://docs.spinwheel.io/reference/get-transaction-list-1.md): This API will allow you to get list of the transactions created for a user with a userId or by a requestId or an extRequestId. - [Get Single Transaction Details](https://docs.spinwheel.io/reference/get-transaction-1.md): This API will allow you to get a single transactions with a transactionsId if it exists. - [Simulate Transaction Flow in Sandbox](https://docs.spinwheel.io/reference/post-simulate-transaction-flow.md): This API will allow you to simulate through different transaction statuses in sandbox environment - [Look Up Transactions by Creation Window](https://docs.spinwheel.io/reference/lookup-transactions.md): This API will allow you to get the current status of all transactions created after a timestamp, optionally filtered by status. Results are returned in pages of 100. Pass the nextCursor from a… - [Payment Requests](https://docs.spinwheel.io/reference/payment-requests.md) - [Create a Payment](https://docs.spinwheel.io/reference/create-request-1.md): This API will allow you to create a Payment request for a user. - [Get a List of Payments](https://docs.spinwheel.io/reference/get-request-1.md): This API will allow you to get list of the Payment requests created for a user with a provided userId, extRequestId or requestId. One of userId, extRequestId or requestId is required. - [Get Single Payment Details](https://docs.spinwheel.io/reference/get-request-by-id-1.md): This API will allow you to get a single Payment request with a provided requestId if it exists. - [Delete a Payment](https://docs.spinwheel.io/reference/delete-payment-request-1.md): This API will allow you to delete one of the Payment request with a provided requestId if it exists. - [Request Payment Rail Details](https://docs.spinwheel.io/reference/resolve-payment-rails.md) - [Payments to Platform](https://docs.spinwheel.io/reference/payment-to-platform.md) - [Make a Payment to Platform](https://docs.spinwheel.io/reference/payment-to-platform-1.md): This API will allow you to make a payment to platform. - [Reverse a Payment to Platform](https://docs.spinwheel.io/reference/reverse-payment-to-platform.md): This API will allow you to reverse a payment to platform. The original external requestId (extRequestId) from the original payment to platform request is needed to match the original transaction.… - [Get Account Balance](https://docs.spinwheel.io/reference/get-payment-to-platform-balance.md): This API will allow you to get the balance of your master payment to platform account. - [Get Settlement Account Balance](https://docs.spinwheel.io/reference/get-settlement-account-balance.md): Returns the balance for a specific settlement account identified by settlementAccountId. ## API Reference: Webhooks - [Overview](https://docs.spinwheel.io/reference/overview-1.md) - Managing Webhooks - [Create a Webhook](https://docs.spinwheel.io/reference/create-webhook.md) - [Update a Webhook](https://docs.spinwheel.io/reference/update-webhook.md): This API allows you to update a specified webhook - [Delete a Webhook](https://docs.spinwheel.io/reference/delete-webhook.md) - [Update a Webhook Header](https://docs.spinwheel.io/reference/update-headers.md) - Reviewing Webhooks - [Get a List of Webhooks](https://docs.spinwheel.io/reference/get-webhooks-list.md) - [Get Webhook Details](https://docs.spinwheel.io/reference/get-webhooks-by-id.md) ## Recipes - [Authentication & Retrieve User Info](https://docs.spinwheel.io/recipes/authentication-retrieve-user-info-draft.md) - [Connect – SMS and Equifax Debt Profile](https://docs.spinwheel.io/recipes/connect-sms-and-equifax-debt-profile-draft.md) - [Connect – SMS and TransUnion Debt Profile](https://docs.spinwheel.io/recipes/connect-sms-and-transunion-debt-profile-draft.md) ## Release Notes - [May 2026](https://docs.spinwheel.io/changelog/may-2026.md) - [Q1 2026](https://docs.spinwheel.io/changelog/q1-20226.md) - [October 2025](https://docs.spinwheel.io/changelog/october-2025.md) - [August 2025](https://docs.spinwheel.io/changelog/august-2025.md) - [November 2024](https://docs.spinwheel.io/changelog/november-2024-changes.md) - [October 2024](https://docs.spinwheel.io/changelog/october-2024-changes.md) - [September 2024](https://docs.spinwheel.io/changelog/september-2024-changes.md) - [August 2024](https://docs.spinwheel.io/changelog/august-2024-changes.md) - [July 2024](https://docs.spinwheel.io/changelog/july-2024-changes.md) - [June 2024](https://docs.spinwheel.io/changelog/june-2024-changes.md)