Connect a User via SMS

post

https://sandbox-api.spinwheel.io/v1/users/connect/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.

To connect a user via SMS, please provide the following for the user:

US mobile phone number
Challenge Data (One of the following challenge data sets at minimum is required. Our standard use case suggestion is using DOB as the challenge data.)
- Date of birth
- First/Last Name
- Last four SSN
One unique identifier:
- If it is the first time connecting the user: extUserId
- If you are connecting an existing user: userId

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

Consent metadata captured at the time of the connect request.

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

429Too Many Requests