Authentication by email OTP

Authenticates the user with the given email. We send an OTP to the user's email address.

post

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

The request for the email OTP authentication.

emailAddressstring · min: 1Required

The email address.

Example: [e-mail]

Responses

200

The request was successful.

application/json

400

Request is invalid

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/auth/passwordless/email-otp HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "emailAddress": "[e-mail]"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "ojLdGCcokeTyaseHvSAJtQh3ho2ey5jf8IdOimzlOS/ObjKMCh0e/NWomcYddisNYVPUEs1XRCcdq5oBNPiHEXRrhf7LY7mrJsALH0KXGv+mWscLpCfSINMA/5wf5Tyw4wcRKPIKZTUtOX49zpVRpcaRpIk9NqTNKNK243fXEQmqAsIWYWO1MDXuonI123WWncNCnBzRbdqAzkd3hQzix+dYLMq4zO76HSNtkjVCZw2nS3+ZM=",
  "errors": []
}