Skip to main content

KYC Redirect WEB UI and iFrame

personalisation and flow

How to personalise UI, and verification flow adjustments can be found in Help center

Redirect and iFrame Integration​

To integrate our identity verification process into your website, we highly recommend using an iFrame integration. This method keeps the user on your site throughout the verification flow, creating a seamless user experience. If an iFrame isn't suitable, you can also use a redirect to send the user to our web interface.

iFrame Integration​

To use an iFrame, embed https://ui.idenfy.com/ in your iframe tag with the authToken query parameter. You can get the authToken by generating an identification token.

To get started, simply embed the URL in an iframe tag and append the authToken as a query parameter.

Best Practices for User Experience (UX)
  • Dimensionality For the smoothest user journey, the iFrame requires sufficient screen space. If the container is too small, users may struggle with internal scrolling or obscured instructions. Desktop: We strongly recommend setting the iFrame dimensions to at least 670px in width and 800px in height. This ensures the entire verification flow is visible without unnecessary scrolling.
  • Mobile: For mobile devices, it is recommended to fully fit the iFrame to the screen (100% width and height) without any fixed pixel restrictions. This ensures the responsive design adapts perfectly to smaller touchscreens.
  • Handling Verification Completion Your application should listen for the message event emitted by the iFrame.
  • Recommendation: Upon receiving the event data indicating a final status (e.g., verification submitted or success), you should immediately hide the iFrame and refresh your application's interface. This ensures the user instantly sees their updated status without being stuck on a finished screen.
caution
  • The allowfullscreen attribute is required if you are using our 3D liveness feature.
  • Do not use successUrl, errorUrl, or unverifiedUrl when generating the token, as this may break the iFrame flow.
  • After verification, you can close the iFrame and display the next page for your client.
<!DOCTYPE html>
<html>
  <body>
    <!-- 
    Recommended styles for optimal UX: 
    Desktop: Width: ~670px, Height: ~800px 
    Mobile: Width: 100%, Height: 100% (avoid fixed pixels)
  -->
    <iframe
      id="iframe"
      allowfullscreen
      style="width: 670px; height: 800px; border: none;"
      src="[https://ui.idenfy.com/?authToken=YOUR_GENERATED_TOKEN](https://ui.idenfy.com/?authToken=YOUR_GENERATED_TOKEN)"
      allow="camera">
    </iframe>

    <script>
      window.addEventListener('message', receiveMessage, false);

      function receiveMessage(event) {
        // 1. Check if the event contains your verification data
        const data = event.data;
        console.log('Verification Status:', data);

        // 2. Logic to detect success/completion
        // Example: If the automated check is approved or manual review is waiting
        if (data.status === 'APPROVED' || data.manualStatus === 'WAITING') {
          // 3. UX Best Practice:
          // Hide the iframe and refresh the parent app to show new status
          document.getElementById('iframe').style.display = 'none';
          location.reload();
        }
      }
    </script>
  </body>
</html>

Query Parameters​

NameExample ValueDescription
authToken3FA5TFPA2ZE3LMPGGS1EGOJNJEAuthentication token for the verification session.
langenOptional. Forces a specific iFrame language (e.g., lang=en). Overrides the locale set during token generation.

Verification Status​

Monitor verification progress via the data object in the console.

PropertyValuesMeaning
statusAPPROVED / FAILED / UNVERIFIEDAutomated check result: approved, denied, or unfinished (timeout/cancel).
manualStatusAPPROVED / FAILED / WAITINGManual review result: approved, denied, or pending.
autoSuspected / manualSuspectedtrue / falseFlags whether suspicion was raised during automated or manual checks.

Redirect to Web UI​

To start a verification, redirect your client to:

https://ivs.idenfy.com/api/v2/redirect?authToken=authToken

Where authToken is the value generated from verification session.

Example: https://ivs.idenfy.com/api/v2/redirect?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE

After the redirect, the user will see the iDenfy verification web UI.

Flow

Web SDK​

We often get asked if we provide a Web SDK. The short answer: No - and that’s by design.
Instead of adding the extra complexity of maintaining SDK packages, version upgrades, and dependency issues, we provide a superior integration option:

iFrame
  • With iFrame you get always up-to-date verification flow (no SDK updates required).
  • Seamless branding with full control over the surrounding page and layout.
  • Lighter integration — no additional packages, no breaking changes, no maintenance burden.
  • Future-proof stability — your integration won’t be affected by SDK lifecycle or compatibility issues.

This means you can integrate identity verification into your web app quickly, keep the user on your site, and avoid the long-term headaches of SDK management.
If an iFrame isn't suitable for your use case, you can also use a redirect to send the user to our web interface.