Send Magic Auth Code via SMS

POST

https://api.ssojet.com/api/v1/auth/passwordless/phone-otp/send

Send Magic Auth Code via SMS

This endpoint is used to send a one-time password (OTP) to the user's phone for passwordless authentication.

Request Body

phone (string, required): The phone number of the user to whom the OTP will be sent.

Response

state (string): The state parameter return in the response, it is used to track the status of a user authencation in the REST API. It helps in maintaining the user authencation context and monitoring its progress throughout the request lifecycle

Response Status Code

200 OK: Magic link sent successfully.

400 Bad Request: Invalid email format.

500 Internal Server Error: An error occurred while processing the request.

Request

Query Params

client_id

string

required

This identifies the application making the request to the SSOJET server. You can find your client ID on the API Keys page in the dashboard

Example:

string

Header Params

Content-Type

string

required

Example:

application/json

User-Agent

string

required

Example:

SSOJET API

Body Params application/json

phone_id

string

required

Example

{
  "phone_id": "<The user phone number is used to send a one-time OTP (One-Time Password) for passwordless authentication>"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ssojet.com/api/v1/auth/passwordless/phone-otp/send?client_id=string&client_id=' \
--header 'User-Agent: SSOjet/1.0.0 (https://ssojet.com)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_id": "<The user phone number is used to send a one-time OTP (One-Time Password) for passwordless authentication>"
}'

Responses

🟢200Send Magic Auth Code via SMS

application/json

Body

state_id

string

required

Example

{
  "state_id": "646616daf9a276fa9a6446a1"
}

Verify Magic Auth Code

Resend Magic Auth Code via SMS

Send Magic Auth Code via SMS