A Flutter plugin for integrating Authyo – a powerful multi-channel MFA service supporting WhatsApp, SMS, Email, and Call for OTP verification.This plugin enables developers to implement OTP-based authentication for both legacy systems and modern, passwordless solutions with minimal configuration.Overview#
Authyo SDK accepts the user’s identity (phone number or email), authenticates through multiple channels, and returns a secure token upon success. The merchant app sends this token to its backend, which verifies it with the Authyo Server before proceeding with the user journey.Integration Steps#
Step 1: Installation#
Add the following to your pubspec.yaml:Please find the latest version of the SDK here Step 2: Initialize the SDK#
1.
Import SDK in your Dart code:
2.
Then, create an instance of the SDK:
3.
Initialize AuthyoService using your Authyo credentials
Important:
You must initialize AuthyoService with your clientId and clientSecret before making any requests.
API Reference#
to: (required) The destination address for the authentication message. The format depends on the selected authway:
For SMS or Voice: a valid phone number with country code (e.g., 15551234567)
For Email: a valid email address (e.g., user@example.com)
For WhatsApp: a valid phone number with country code linked to a WhatsApp account otpLength: (optional) Specifies the number of digits in the generated One-Time Password (OTP).
Defaults to: the value defined in the application settings if not explicitly provided.
Example:
otplength: 6 generates a 6-digit OTP like 483921.
expiry: (optional) Time (in seconds) until the authentication code or message expires. Determines how long the code remains valid after being sent.
Defaults to: the value set in the application-level configuration if not provided.
Example:
expiry: 300 means the code is valid for 5 minutes.
authWay: (optional) Specifies the preferred authentication channel. Acceptable values include: "SMS", "Email", "WhatsApp", "VoiceCall" etc.
If not provided, the system will use the default method configured in the application settings.
onVerificationComplete: Optional callback function which provide if authentication is successful or not. Only required when plugin's default OTP verification dialog is being used.
maskId: (required) Unique identifier returned by the sendotp API. It is used to reference the OTP session during verification in the verifyotp API.
otp: (required) The One-Time Password (OTP) entered by the user for verification. This value should match the OTP that was sent via the selected authway (e.g., SMS, Email, WhatsApp, Voice).
AuthyoResult#
A wrapper for API responses.AuthyoBaseResponse
For sendOtp:Error Handling#
All errors are subclasses of AuthyoError.
To handle all the verification/initiation error codes for android and iOS, refer to the following code:TooManyRequestsError (429)
InternalServerError (500)
ServiceUnavailableError (503)
