Get the current status of a OTP Code

Get the current status of an OTP Code pairing request.

get

Possible statuses: pending, approved, expired, rejected. This endpoint is usually polled every few seconds by the initiating device until the OTP Code is approved or expired.

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

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "5f20c0c6-87e5-41ce-b713-bcb08297416d",
    "status": "New",
    "approvedAt": null
  },
  "errors": []
}