Connect API - KBA
Connect your users via KBA auth flow
Before getting started
As you look to integrate with the Connect API, please note that you will be responsible for displaying the Spinwheel End User Agreement, along with capturing consent to proceed with a connection to the platform. This Connect API will trigger an OTP via SMS with an expiration. This is necessary to ensure that the user is still run through the proper confirmation checks, and validity scoring functions that Spinwheel performs natively within the Drop-in Modules.
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.
The steps are as follows:
- 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.
- 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
- The user's answers are submitted back to Spinwheel via /v1/users/{userId}/connect/kba
- Once the answers are sent, Spinwheel will verify and provide the status back of the newly connected user.
- 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}/creditReports/order
- Listen to the USER_LIABILITIES_CONNECTED webhook to know when the user's credit report has been successfully connected
The connected users will have their information pulled in to their user object which can be accessed from the /v1/users endpoint.
Sandbox User Data
For testing debt connect in sandbox, we have a test identity that you can use.
| User Attribute | Information |
|---|---|
| First Name | THOMAS |
| Last Name | DEVOS |
| Date of Birth | 1957-09-06 |
| SSN | 666023511 |
| Street Address Line 1 | 1206 BEAR CREEK RD APT 110 |
| City | TUSCALOOSA |
| State | AL |
| ZIP | 35405 |
Upon success with the user data entry, the API will respond with a number of security questions. Please select one of the following answers if it is available. If nothing in the following list is present, please select "None of the above" as the answer for the questions to authenticate.
Security Question Answers:
- Financial Plus Credit Union
- GEMB/JC Penny
- Veridian Credit Union
Updated 23 days ago