ftos.identity.otp.getStatus
IMPORTANT!
Starting with v24.3.0, this is renamed from server.otp.getOtpRequestStatus to ftos.identity.otp.getStatus.
Starting with v24.3.0, this is renamed from server.otp.getOtpRequestStatus to ftos.identity.otp.getStatus.
Returns the status of the one-time password request.
This is a business logic method for business service components.
Syntax
Copy
function ftos.identity.otp.getStatus("requestId": string)
| Parameter | Type | Description |
|---|---|---|
requestId
|
string | Obtained as the result of the ftos.identity.otp.send method. |
Return Value
Returns values can be:
| Value | Description |
|---|---|
| 0 | Unknown -a request with the ID equal to requestId is not found. |
| 1 | Incomplete- a request with the ID equal to requestId was created but is not completed yet.
|
| 2 | Successful- a request with the ID equal to requestId was completed successfully. |
| 3 | Failed - a request with the id equal to requestId was not completed successfully |
| 4 | Expired - a request with the id equal to requestId is expired. |