SPspinwheel
Connect

Connect a User via SMS

Changed on

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.

post/v1/users/connect/sms

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/connect/sms
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Request body

phoneNumberstring required

The phone number in E.164 format.

dateOfBirthstring

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.

firstNamestring

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.

lastNamestring

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.

ssnLastFourDigitsstring

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

userIdstring required

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

extUserIdstring required

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

Example request

{
  "phoneNumber": "+14155552671",
  "dateOfBirth": "2000-01-01",
  "firstName": "Christy",
  "lastName": "Jenoval",
  "ssnLastFourDigits": "1234",
  "userId": "7519c55d-68aa-4b21-b580-d70d4fb4f2ab",
  "extUserId": "1166d9a1-5718-4443-a677-cc40627c5575",
  "audit": {
    "consentTimestamp": "2025-03-15T14:30:00Z",
    "tosVersion": "v1.1",
    "tosLanguage": "en",
    "consentType": "WRITTEN"
  }
}

Response

Success

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "userId": "9226245b-4a4c-48e2-a8cb-9a0e114ed4af",
    "extUserId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionStatus": "IN_PROGRESS",
    "sms": {
      "codeExpiresAt": 1614602485926,
      "codeTimeoutSeconds": 300
    }
  }
}

Changes

  • aa032469622fRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional