Generate a new OTP Code

Generate a new OTP Code for pairing authentication between two devices.

post

Similar to QR Code pairing but uses a numeric or alphanumeric code instead. The OTP Code should have a short TTL (e.g., 60 seconds).

Header parameters
Brand-URLstringRequired

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

Example: YOUR_BRAND_URL
Responses
200

The request was successful.

application/json
post
POST /api/v1/users/auth/passwordless/otp/generate HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "code": "123456",
    "id": "929df596-5a71-40ee-8336-6cf883745df7",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}

Last updated

Was this helpful?