Connect a User - Phone

post

https://sandbox-api.spinwheel.io/v1/users/connect/preverified/phoneNumber

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 of their Social Security number. One of the three is required. This API requires Spinwheel Support approval to enable it before it can be used.

For users that have already been pre-verified by phone number or SMS text — through your own OTP or an outbound call — this endpoint lets you connect them without sending a second, redundant code.

Provide the phone number, date of birth, and details on how and when that verification took place, and we'll treat it as pre-verified from there. A few audit fields are required alongside the basics; they exist to keep this shortcut compliant with our highest verification standards, not to slow you down.

Body Params

phoneNumber

string

required

The phone number in E.164 format.

dateOfBirth

string

The date of birth. Formatted as YYYY-MM-DD. Supply one of dateOfBirth, firstName + lastName, or ssnLastFourDigits. If more than one is provided, dateOfBirth is used to resolve the identity and the others narrow the match.

firstName

string

The user's legal first name, as it appears on their credit file. Must be sent together with lastName. One of dateOfBirth, firstName + lastName, or ssnLastFourDigits is required.

lastName

string

The user's legal last name, as it appears on their credit file. Must be sent together with firstName. One of dateOfBirth, firstName + lastName, or ssnLastFourDigits is required.

ssnLastFourDigits

string

The last four digits of the user's Social Security number. One of dateOfBirth, firstName + lastName, or ssnLastFourDigits is required.

userId

string

required

An existing userId to connect with. One of extUserId or userId is required.

extUserId

string

required

A unique external ID for the user. One of extUserId or userId is required.

audit

object

required

Verification and consent audit trail. Documents the client's identity verification of the user and the user's consent to the Spinwheel End User Agreement.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success

400Bad Request

429Concurrent Request Rejected