Xsolla-logo

Start auth by phone number

post/oauth2/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:

  1. The application opens an authentication form so the user can enter their phone number.
  2. The user enters their phone number.
  3. 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.
  4. The Xsolla Login server sends the SMS and returns the ID of the confirmation code.
  5. The application shows a field so the user can fill in the confirmation code.
  6. The user enters the received confirmation code or follows the link.
  7. The application sends the Complete auth by phone number request with the received ID to the Xsolla Login server.
  8. The user is considered as authorized.
Request
query Parameters
response_type
required
string

Grant type used in your project that has the enabled OAuth 2.0 protocol. Must be code to get the user authentication code in the response. The received code must be exchanged to a JWT via the Generate JWT call to finish user authentication.

client_id
required
integer

Your application ID. Get it after creating an OAuth 2.0 client.

state
required
string

Value used for additional user verification. Often used to mitigate CSRF Attacks. The value will be returned in the response. Must be longer than 8 symbols.

scope
string

Scope is a mechanism in OAuth 2.0 to limit an application’s access to a user’s account.

Can be:

  • offline to use refresh_token from the Generate JWT call to refresh the JWT when it is expired.
  • playfab to write SessionTicket to the session_ticket claim of the JWT if you store user data at PlayFab.

If you process your own values of the scope parameter, that are not mentioned above, you can set them when using this call. The Xsolla Login server does not process these values, but returns them in the received JWT.

redirect_uri
string

URL to redirect the user to after account confirmation, successful authentication, or password reset confirmation. To set up this parameter, please contact your Account Manager.

Request Body schema: application/json
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

OK

400

Bad Request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{}
Response samples
application/json
{
  • "operation_id": "string"
}