Connect a User via SMS

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. One of the three is required. The connection will complete once the user has been verified using the sms verify endpoint. Identification runs on the verify call, so an identity that cannot be resolved is reported there; you may then start a new connect supplying dateOfBirth instead, and nothing in the response indicates whether a date of birth would have resolved it.

This is the flow most organizations leverage with Spinwheel. This streamlined input requirement consistently shows up as a lift in conversion, since there's no form to abandon and nothing to remember.

Submitting this request texts the user a one-time passcode. The connection completes once that code is submitted to the Verify an SMS Connection endpoint.

Body Params
string
required

The phone number in E.164 format.

string

The date of birth. Formatted as YYYY-MM-DD. Supply one of dateOfBirth, firstName + lastName, or ssnLastFourDigits. If more than one is provided, only the highest-priority one is used to identify the user, in the order ssnLastFourDigits, dateOfBirth, then firstName + lastName, and the others are ignored. To identify the user with a lower-priority value, send the request again without the higher-priority ones.

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.

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.

string

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

string
required

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

string
required

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

audit
object

Consent metadata captured at the time of the connect request.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json