Start Passwordless Authentication

Start a passwordless authentication flow by sending a verification code or magic link to the user’s email or phone.

Supported connection types:

• email - Send code or link via email
• sms - Send code via SMS

Send options:

• link - Send a magic link (email only)
• code - Send a one-time code

POST https://{yourDomain}/passwordless/start

cURL

emailCode

curl --request POST \ --url https://{yourDomain}/passwordless/start \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "connection": "email", "email": "[e-mail]", "send": "code" } '

200

{
  "_id": "<string>",
  "email": "<string>",
  "phone_number": "<string>"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

client_id · string · required

Your application's Client ID

connection · enum<string> · required

The connection type for passwordless authentication

Available options: email, sms

send · enum<string> · required

Whether to send a magic link or a code. Only 'code' is supported for SMS.

Available options: link, code

client_secret · string

Your application's Client Secret (required for confidential clients)

email · string<email>

The user's email address (required when connection is 'email')

phone_number · string

The user's phone number in E.164 format (required when connection is 'sms')

authParams · object

Additional authentication parameters to include (scope, state, etc.)

Response

200

application/json

Passwordless request sent successfully

_id · string

Request ID

email · string

Email address (for email connections)

phone_number · string

Phone number (for SMS connections)