Skip to content
Akedly
Tutorials

Add a gateway screen

Akedly hosts the whole verification screen. You embed it and read the result.

Add a gateway screen

Creating the integration, attaching a gateway screen, and embedding it.

Open the video in Google Drive


What you need

  • A gateway integration — a headless integration cannot have gateway screens
  • A page you can paste a snippet into

Steps

  1. Create a gateway integration.

    In Integrations, select New integration, then Verify users and Gateway. It comes with its first gateway screen; copy the screen's Gateway secret on the last step, because it is shown once. A new integration starts on, in Test mode, so you can try it right away; before it goes Live, add the Return URL and Server URL on its Webhooks tab.

  2. Check the screen.

    The gateway screen carries the branding, the bot checks and the rate limits. Open it from the integration's Gateway screens tab.

  3. Brand it.

    Company name, logo and colours come from the Branding Studio (the integration's Branding tab) and from your business details, not from code.

  4. Embed it.

    Your backend creates an attempt and your page opens the returned iframeUrl. The exact attributes are on the Gateway page.

  5. Read the result.

    Two ways, and you usually want both — the redirect back to your front end for the user's benefit, and the backend webhook for the truth.


When it breaks

  • The gateway screen refuses the integration — it is headless. Create a gateway integration; an integration's type cannot be changed afterwards.
  • Verification succeeds but nothing reaches your server — check the callback URL is set and answers a 2xx within 10 seconds, without redirecting. Failed deliveries are normally retried for about 8½ hours — see Retries.
  • Codes rejected at the last step — a fixed six-digit input. Gateway screens can issue 4, 5 or 6 digits.
  • The gateway screen says “Turn on cookies to continue” — the browser blocks website storage, which the gateway screen needs. The user follows the on-screen steps; in an iframe, add clipboard-write to allow so Copy link works. See When the browser blocks cookies.

Where to go next