Connect a User via SMS

post

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

Connect a User using SMS verification. Identify the user either by date of birth or by legal first and last name as it appears on their credit file, at least one of the two is required. The connection will complete once the user has been verified using the sms verify endpoint. Identification runs on the verify call, so a legal name 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
Date of birth
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. At least one of dateOfBirth or firstName + lastName is required. If both are provided, dateOfBirth is used to resolve the identity and the name narrows the match.

firstName

string

The user's legal first name, as it appears on their credit file. Required when dateOfBirth is not supplied, and must be sent together with lastName.

lastName

string

The user's legal last name, as it appears on their credit file. Required when dateOfBirth is not supplied, and must be sent together with firstName.

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