The Mobile number with OTP authentication allows your client to authenticate using OTP method. The endpoints are pre-built and are easy to manage your authentication flow and users. To get your {auth_base_url}, check it out here - Get started with base url.

Note: APP-KEY to be passed in Headers can be obtained from the settings in the project dashboard

Sending SMS OTP - Currently, we send SMS OTP via Twilio. It is necessary for configure your twilio integration in the dashboard. Click here for twilio integration

1. Signup API

This endpoints allows you to create a new user using the mobile number and otp method.

POST
{auth_base_url}/mobile-otp-signup

Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/mobile-otp-signup 
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "country_code" : "+91",
   "mobile": "9876543211"
}
Response
HTTP/1.1 
201 CREATED

{
   "user_id": "1",
   "mobile": "9876543211"
}

2. Login API

This endpoints allows you to login a user using the mobile number and otp method.

Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/mobile-otp-login 
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "mobile": "9876543211"
}
Response
HTTP/1.1 
200 OK

{
   "user_id": "1",
   "mobile": "9876543211"
}

3. Verify OTP API

This endpoints allows you to verify the otp of the respective mobile number.

Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/mobile-otp-login 
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "mobile": "9876543211",
   "otp_code" : 1234
}
Response
HTTP/1.1 
200 OK

{
   "user_id": "1",
   "mobile": "9876543211",
   "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTIzNDU2Nzg5LCJuYW1lIjoiSm9zZXBoIn0.OpOSSw7e485LOP5PrzScxHb7SR6sAOMRckfFwi4rp7o",
   "token_type" :"bearer",
   "expires_in" : null
}

Supported Country Codes

Below are the list of country codes supported currently. Please, reach out to our support team,if your country code is not listed.

CountryCountry Code
India+91