API Reference
API Keys

Connect a User via SMS

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

Connect a User using SMS verification. The connection will complete once the user has been verified using the sms verify endpoint.

👀

You must capture the end user's consent and clearly display the Spinwheel End User Agreement in order to connect the user.

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
string
required

The phone number in E.164 format.

string
required

The date of birth. Formatted as YYYY-MM-DD.

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

Updated 2 days ago

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

Updated 2 days ago