Start auth by phone number

Start auth by phone numberClient-side

post/login/phone/request

Starts authentication by the user phone number and sends a confirmation code to their phone number. The code lifetime is 3 minutes.

This call is used only with the Complete auth by phone number call.

The workflow of using this call:

The application opens an authentication form so the user can enter their phone number.
The user enters their phone number.
The application sends this request to the Xsolla Login server: a. If the parameter send_link is true, after this request, you should send the Get confirmation code request to make SMS contain the confirmation code and link. b. If the parameter send_link is false or not passed, the SMS will contain the confirmation code only.
The Xsolla Login server sends the SMS and returns the ID of the confirmation code.
The application shows a field so the user can fill in the confirmation code.
The user enters the received confirmation code or follows the link.
The application sends the Complete auth by phone number request with the received ID to the Xsolla Login server.
The user is considered as authorized.

Request

projectId required	string <uuid> Login project ID from Publisher Account.
login_url	string URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.
payload	string Your custom data. The value of the parameter will be returned in the `payload` claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.
with_logout	string Default: "0" Shows whether to deactivate the existing user JWT values and activate the one generated by this call. Can have the following values: `1` to deactivate the existing values and activate a new one, `0` to keep the existing values activated.

phone_number required	string^\+(\d){5,25}$ User phone number.
link_url	string <uri> URL to redirect the user to the status authentication page. Required if the parameter `send_link` is `true`.
send_link	boolean Shows whether a link is sent with the confirmation code in the SMS or not. The link can be used instead of the confirmation code to log in. If the parameter has the `true` value, the link is sent in the SMS.

Responses

200

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples

application/json

{"link_url": "http://example.com",
"phone_number": "string",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}