Skip to content
Akedly
GatewayRECOMMENDED

Gateway

A gateway integration gives you a hosted verification screen, the gateway screen, that you embed in an iframe. Your backend creates an attempt, Akedly runs the code flow, captcha, device checks and rate limits in the gateway screen, and your server gets the result by redirect, postMessage and webhook. It is the recommended way to verify users with Akedly, and the shortest route to passkeys.


Why Choose Gateway

Gateway provide a fully-managed authentication interface that runs in an iframe with zero frontend complexity. Unlike the standard API (v1.0), you get a complete OTP flow with built-in security and fraud detection.

For a detailed comparison of Headless, Gateway, and V1.0, see the Authentication Methods overview.

When to choose Gateway

  • You want Akedly to run the verification screen, with your logo and colors.
  • You want the widest security tier, including a managed iframe defense layer and device identity.
  • You want passkeys with one iframe attribute.
  • You are a qualifying startup looking at pay-per-successful-authentication pricing (requirements apply).

Choose Headless instead if you cannot embed an iframe or open a system browser. In a native app the gateway screen must open in a system browser, not a WebView.

Page map

  1. Set up the gateway screen: create it in the dashboard.
  2. Create an attempt: sign and create it from your backend.
  3. Open the gateway screen: iframe, mobile, cookie handling and the browser-side result.
  4. Results and callbacks: the webhook payload your backend receives.
  5. Channels and security: channel choice and security features.
  6. Errors and troubleshooting: error codes, your own OTP and common fixes.

Next: after the first successful verification, turn on passkeys so the next sign-in is a biometric or screen lock. OTP once, Passkey forever.


How Gateway works

The authentication flow is simple and secure:

  1. Your User Initiates Authentication

    User clicks "Login" or "Verify Phone" in your application.

  2. Your Backend Creates Attempt

    Your backend calls Akedly API with HMAC signature:

    POST /api/v1/widget-sdk/create-attempt

  3. Akedly Returns Transaction URL

    Response includes:

    • Name
      attemptId
      Type
      string
      Description

      Unique attempt identifier

    • Name
      iframeUrl
      Type
      string
      Description

      URL to open in iframe for authentication

    • Name
      expiresAt
      Type
      string
      Description

      ISO 8601 timestamp when attempt expires

  4. Your Frontend Opens Gateway screen

    Display the gateway screen in an iframe (web), or open it in a system browser (mobile native — see Step 3):

    <iframe src={iframeUrl} />

  5. Your User Completes Authentication

    Inside the gateway screen (managed by Akedly):

    • Device fingerprinting and security checks
    • Bot protection
    • Rate limiting
    • Fraud detection
    • OTP delivery (WhatsApp → Telegram → SMS → Email) (depending on your integration setup)
    • User enters OTP code
  6. Receive Verification Result

    Akedly redirects user to your callback URL & sends webhook to your backend with verification status. The same backend URL receives selected signed channel events and Delivery receipts, with data.attemptId linking them to the gateway screen attempt.


Support & Resources

Getting Help

Additional Resources


Version: 2.0.0 Last Updated: October 8th, 2026 API Base URL: https://api.akedly.io/api/v1/widget-sdk