KBA

Before Getting Started

This Connect API will trigger a series of questions used to validate who the user is. As you look to integrate with the Connect API, please note that you will be responsible for capturing consent to proceed with a connection to the platform along with displaying the following language with the user:

"By clicking “Continue” you agree to the Spinwheel End User Agreement.
Further, you are providing “written instructions” to Spinwheel Solutions, Inc.
authorizing it to obtain your credit profile from any consumer reporting
agency."

Steps

We have designed this API to enable flexibility and customization to the process, all while ensuring we can securely connect users with the highest connection rates. The process of connecting users is broken out into the following key steps as noted below.

1. Send a connect request via a POST to /v1/users/connect/kba with the end user's first name, last name, social security number, address, and a unique extUserId which represents that user in your system.
2. Upon the submission of the information at the first step and a match with the submitted user, you will return a series of KBA questions that will require the user's input/answers
3. The user's answers are submitted back to Spinwheel via /v1/users/{userId}/connect/kba
4. Once the answers are sent, Spinwheel will verify and provide the status back of the newly connected user.
5. If you are looking to pull a user's liability information, you will need to call to order a credit report via /v1/users/{userId}/creditProfile/equifax
   1. Listen to the USER_LIABILITIES_CONNECTED and USER_LIABILITIES_CONNECTION_FAILED webhooks to know when the user's credit report has been successfully connected or not if using the old /v1/users/{userId}/creditReport/order endpoint.

The connected users will have their information pulled into their user object which can be accessed from the /v1/users endpoint.

Sandbox User Data

For testing KBA in sandbox, we have a test identity that you can use.