Approve a OTP code

Approve an OTP Code pairing request.

post

This endpoint is called by the target device after receiving the OTP code generated by POST api/v1/users/auth/passwordless/otp/generate. Once approved, the OTP Code's status changes to "Approved".

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}/approve

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "53d037ef-10ce-49af-88bb-7ce7b89f7be3",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}