v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Connect

Connect a User via SMS

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

post/v1/users/connect/sms

Request body

phoneNumberstring required

The phone number in E.164 format.

dateOfBirthstring required

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

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",
  "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
    }
  }
}

All 59 operations