Add the V2 widget
Akedly hosts the whole verification screen. You embed it and read the result.
Creating the pipeline, attaching a widget, and embedding it.
Widget or REST — pick one deliberately
The widget means no UI work and no proof-of-work handling, at the cost of Akedly owning the screen your user sees. If you need your own design, use the V1.2 REST API instead.
What you need
- A pipeline created as V2 — a V1.2 pipeline is rejected when attached to a widget
- A page you can paste a snippet into
Steps
1. Create a V2 pipeline. Set the API Version to V2 at creation. Widgets accept V1 or V2; V1.2 is the one version they refuse.
2. Create a widget and attach it. The widget carries the branding, the security layers, and the rate limits.
View in dashboardAuthentication → Setup → WidgetsCreate a widget and attach it to your V2 pipeline.
3. Brand it. Company name, logo and colours come from the Branding Studio and from your company profile, not from code.
4. Embed it. Copy the snippet from the widget page into your own page. The exact attributes are on the V2.0 Widgets 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.
The widget's backend webhook is sent once, with no retry and no delivery record. If the verification matters, confirm it from the API rather than treating that one request as your only record.
When it breaks
- The widget refuses the pipeline — it is V1.2. Create a V2 pipeline; the version cannot be changed to V1.2 afterwards.
- Verification succeeds but nothing reaches your server — check the callback URL is set and answered a
2xxwithin 10 seconds. There is no second attempt. - Codes rejected at the last step — a fixed six-digit input. Widgets can issue 4, 5 or 6 digits.
Where to go next
- V2.0 Widgets — every attribute, event and error
- Passkeys — let returning users skip the code entirely
- Receive a webhook — handling the result properly