SPspinwheel
Connect

Verify an SMS Connection

Changed on

Complete an SMS connection using the passcode sent to the user's device. Identification against the identity attributes sent to POST /v1/users/connect/sms happens on this call, so identification failures are reported here rather than at connect.

post/v1/users/{userId}/connect/sms/verify

Request

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

Path parameters

userIdstring required

Request body

codestring required

The 6 digit code that was sent to the user's device

Example request

{
  "code": "123456"
}

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",
    "profile": {
      "addresses": [
        {
          "addressLine1": "123 Main Street",
          "addressLine2": "Unit 208",
          "city": "San Francisco",
          "state": "CA",
          "zip": "90211",
          "zipExtension": "1234"
        }
      ]
    }
  }
}

Changes

  • aa032469622fRevision changes
    • breaking

      the response property ////// became optional for the status

    • breaking

      the response property ////// became optional for the status

    • warning

      added the new FAILED enum value to the / response property for the response status

    • warning

      added the new IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SUCCESS enum value to the / response property for the response status