Auth with an approved OTP code

Log in using an approved OTP Code pairing request.

post

This endpoint is called by the initiating device after the OTP Code status is "Approved" to retrieve the authentication key (AuthKey) for the paired account.

After a successful authentication, the following headers must be included to register or update the user’s device:

• X-Device-Code: A unique identifier for the device.
• X-Device-Token: The Firebase device token used for push notifications.
• X-Device-Name: The name/model of the device.
• X-App-Version-Number: The version of the application.
• X-Os-Device: The operating system of the device (iOS, Android).

Path parameters

otpCodestringRequired

The OTP code value.

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

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/auth/passwordless/otp/{otpCode}/auth-with-otp

HTTPcURLJavaScriptPython

POST /api/v1/users/auth/passwordless/otp/{otpCode}/auth-with-otp HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "asdasdcwAqrNxIT0xQdkMvR",
    "username": "user",
    "emailAddress": "[e-mail]",
    "phoneNumber": "[phone]",
    "authKey": "8mgBXMwMchIWWlLmvEL9RasdasdcwAqrNxIT0xQdkMvRndmSjh4YmtOcjdZb2taUT09N1J5bVdzRDlUUWhhRFFwdlRhemk4ZDFuaFdHajYzVXlYLy9valkwYXpuQT0=",
    "refreshAuthKey": "Li48YUZxXkS52eNwx5D2yA4axptAvd1IWGxCZndDODFQTTZ5VnNoOVFLb1RGdz09cmlLTXQ4c1Y0RENDSHQ1QWtMU2I4a0tOem05QmtNd0pTUlpGenpsc0hBOD0=",
    "expiresIn": "2026-02-25T01:03:23.921108Z"
  },
  "errors": []
}