Overview

The Pre-Verified (Phone) endpoint allows you to connect a user who has already undergone pre-verification via a phone number or SMS in your own system. This endpoint is designed for situations where you have securely confirmed the user's identity and their provided phone number and date of birth, allowing for a streamlined connection process. In order to use this endpoint, please contact Spinwheel to have it enabled for use.

Before Getting Started

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 sharing the following language with the user:

"By continuing, 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/preverified/phoneNumber with the end user's phone number, date of birth, the verification date, the user consent date, the verification type, and a unique extUserId that represents that user in your system.
2. After sending the request, monitor the connectionStatus to ensure the connection is successfully established (i.e., connectionStatus is SUCCESS). If the connection did not succeed, make sure to handle the error responses accordingly. A list of responses can be found in the example responses in the Pre-Verified API.
3. 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]

Recipe

For a coded example of the implementation, please refer to the Connect API - Pre-Verified Recipe provided below: