Send SMS code

POST 
{baseUrl}/api/2.0/authentication/sendsms

Sends SMS with an authentication code.

Request

application/json

Body

userNamestringnullable
Username / email
Example: some text
passwordstringnullable
Password
Example: vfmf2vO1Kp
passwordHashstringnullable
Password hash
Example: some text
providerstringnullable
Provider type
Example: some text
accessTokenstringnullable
Provider access token
Example: some text
serializedProfilestringnullable
Serialized user profile
Example: some text
codestringnullable
Two-factor authentication code
Example: some text
codeOAuthstringnullable
Code for getting a token
Example: some text
sessionboolean
Session based authentication or not
Example: true
confirmData object
emailemailnullable
Email address
Example: Sydney_Roberts4@hotmail.com
firstbooleannullable
Access an account for the first time or not
Example: true
keystringnullable
Key
Example: some text
recaptchaType object
oneOf
MOD1
string
[Default - Default, AndroidV2 - AndroidV2, iOSV2 - iOSV2, hCaptcha - hCaptcha]
Possible values: [Default, AndroidV2, iOSV2, hCaptcha]
Example: Default
MOD2
integer
[0 - Default, 1 - AndroidV2, 2 - iOSV2, 3 - hCaptcha]
Possible values: [0, 1, 2, 3]
Example: 0
recaptchaResponsestringnullable
reCAPTCHA response
Example: some text
culturestringnullable
Culture
Example: some text

Responses

200

Authentication data

application/json

Schema

Schema

tokenstringnullable
Authentication token
Example: abcde12345
expiresdate-time
Token expiration time
Example: 2008-04-10T06:30:00.0000000+04:00
smsboolean
Specifies if the authentication code is sent by SMS or not
Example: false
phoneNoisestringnullable
Phone number
Example:
tfaboolean
Specifies if the two-factor application is used or not
Example: false
tfaKeystringnullable
Two-factor authentication key
Example:
confirmUrlurinullable
Confirmation email URL
Example: some text

Example (auto)

{
  "token": "abcde12345",
  "expires": "2008-04-10T06:30:00.0000000+04:00",
  "sms": false,
  "phoneNoise": "",
  "tfa": false,
  "tfaKey": "",
  "confirmUrl": "some text"
}

400

userName, password or passworHash is empty

429

Too many login attempts. Please try again later

• curl
• python
• javascript
• php
• csharp
• java

• CURL

curl -L '/api/2.0/authentication/sendsms' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "userName": "some text",
  "password": "vfmf2vO1Kp",
  "passwordHash": "some text",
  "provider": "some text",
  "accessToken": "some text",
  "serializedProfile": "some text",
  "code": "some text",
  "codeOAuth": "some text",
  "session": true,
  "confirmData": {
    "email": "Sydney_Roberts4@hotmail.com",
    "first": true,
    "key": "some text"
  },
  "recaptchaType": "Default",
  "recaptchaResponse": "some text",
  "culture": "some text"
}'

Request Collapse all

Base URL

Body

{
  "userName": "some text",
  "password": "vfmf2vO1Kp",
  "passwordHash": "some text",
  "provider": "some text",
  "accessToken": "some text",
  "serializedProfile": "some text",
  "code": "some text",
  "codeOAuth": "some text",
  "session": true,
  "confirmData": {
    "email": "Sydney_Roberts4@hotmail.com",
    "first": true,
    "key": "some text"
  },
  "recaptchaType": "Default",
  "recaptchaResponse": "some text",
  "culture": "some text"
}

ResponseClear

Click the Send API Request button above and see the response here!