FYfynoio
Fyno Verify

Verify OTP

Changed on

This API enables you to validate the OTP entered by the user using either request_id (received in response of the Fire an Event API) or destination (such as phone number, email).

Note: By default, OTPs are not tied to a specific notification event. If you validate using destination, an OTP sent to the same destination by another event that also uses destination validation can override the earlier OTP. To avoid this, pass the optional event_name parameter to validate the OTP against a specific event.

post/{WSID}/{version}/verify/validate

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/{version}/verify/validate
  • Auth
    HTTP bearer

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

versionstring required

Specify the version for which you would like to manage the user profile.

Query parameters

request_idstring

Specify the request id of the triggered notification event that sent the OTP to the user. You must use this query parameter if you've disabled "Use destination as id" in the Fyno Verify setting.

destinationstring

Enter the destination where the OTP is sent. It can be either mobile no or email id. You must use this query parameter if you've enabled "Use destination as id" in the Fyno Verify setting.

event_namestring

(Optional) Enter the name of the notification event that sent the OTP, for example login_otp. Use this parameter along with destination to validate the OTP for a specific event. Without it, an OTP sent to the same destination by another event that also uses destination validation can override the OTP you are validating.

otpstring required

Enter the OTP which you want to validate.

Response

OTP successfully validated

_messagestring required
statusstring required

Example response

{
  "_message": "verified",
  "status": "ok"
}

Changes

  • 4007bf338a0bRevision changes
    • info

      added the new optional query request parameter event_name

  • f620f85db863Revision changes
    • breaking

      removed the enum value live from the path request parameter version

    • breaking

      removed the enum value test from the path request parameter version