Skip to main content

KYC Redirect WEB UI and iFrame

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. Unlike a redirect, an iFrame keeps the user on your site during verification.

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

<!DOCTYPE html>
<html>
  <body>
    <iframe
      id="iframe"
      allowfullscreen
      style="width:80%; height:800px;"
      src="[https://ui.idenfy.com/?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE](https://ui.idenfy.com/?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE)"
      allow="camera"
    ></iframe>

    <p id="display"></p>

    <script>
      window.addEventListener("message", receiveMessage, false);
      function receiveMessage(event) {
        console.log(event);
        // ...
      }
    </script>
  </body>
</html>
caution

The allowfullscreen attribute is required if you are using our 3D liveness feature.

Query Parameters​

Parameter NameExample ValueDescription
authToken3FA5TFPA2ZE3LMPGGS1EGOJNJEThe authentication token for the verification session.
langenOptional. Forces the iFrame to use a specific language (e.g., lang=en). The locale parameter in the token generation will not affect the iFrame.

Important notes for iFrame integration:

  • Do not use successUrl, errorUrl, or unverifiedUrl when generating the token, as this may break the iFrame flow.
  • The company's logo will not be displayed inside the verification session's UI.
  • After verification, you can close the iFrame and display the next page for your client.

Check Verification Status​

You can monitor the status of the identity verification process by checking the data object in the console.

Automated Check Status​

The status property indicates the result of the automated verification checks.

NameDescription
APPROVEDThe user completed the flow and is approved.
FAILEDThe user completed the flow and is denied.
UNVERIFIEDThe user did not finish the verification (e.g., they timed out or canceled).

Manual Review Status​

The manualStatus property reflects the status of any manual review.

NameDescription
APPROVEDThe user completed the flow, and the ID verification has been approved during manual review.
FAILEDThe user completed the flow, and the ID verification has been denied during manual review.
WAITINGThe user completed the flow, and a manual review is currently in progress.

Suspicion Status​

autoSuspected and manualSuspected are false by default.

  • autoSuspected: true means a suspicion was flagged during the automated checks.
  • manualSuspected: true means a suspicion was flagged during the manual review.

Redirect to Web UI​

You may initiate a HTTP redirect action for your client to https://ivs.idenfy.com/api/v2/redirect by appending a generated token from verification session as a URL query string parameter.

Query string parameter nameExample value
authTokentSfnDiNBT16iP7ThpP6K8QfF2maTK0Vvkxfvq4YV
Flow

Examples​

An example redirect URL looks like this: https://ivs.idenfy.com/api/v2/redirect?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE

And after the redirection, the user will see our identity verification WEB UI.

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.