Skip to main content

KYC Redirect to iFrame

Redirect action​

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

Unlike a redirect, iFrame keeps the user on your site during verification.

Please note

  • Do not use successUrl, errorUrl, unverifiedUrl in token generation for iframe implementation. Using the mentioned parameters may break the flow.

  • Locale parameter in token generation will have no effect in iFrame.

  • To force the iFrame to use a locale, append "lang=<alpha-2-country-code>" URL parameter.

  • The company's logo does not show up inside the verification session's UI.

  • After verification, you may close the iframe and display a desired page to your client.

Examples​

Query string parameter nameExample value
authToken3FA5TFPA2ZE3LMPGGS1EGOJNJE

An example redirect url:
https://ui.idenfy.com/?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE

An example redirect url with english locale:
https://ui.idenfy.com/?authToken=3FA5TFPA2ZE3LMPGGS1EGOJNJE&lang=en

Example code​

<!DOCTYPE html>
<html>
  <body>
    <iframe
      id="iframe"
      allowfullscreen
      style="width:80%; height:800px;"
      src="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>
info

The data object can be found in the console.log message. The allowfullscreen attribute is mandatory if you're using our 3D liveness feature.

Possible values to check auto and manual review statuses:​

Information about the identity verification statuses can be found in the console, under the data object.

Automatic check status:

NameDescription
APPROVEDThe user completed a verification flow and is APPROVED
FAILEDThe user completed a verification flow and is DENIED
UNVERIFIEDThe user did not finish verification (did not finish in time or canceled verification)

Manual review check manualStatus:

NameDescription
APPROVEDThe user completed a verification flow and the ID verification is APPROVED
FAILEDThe user completed a verification flow and the ID verification is DENIED
WAITINGThe user completed the verification flow and manual verification review is ongoing.
Statuses to check whether verification is suspected

By default, autoSuspected and manualSuspected are false.

autoSuspected:true means suspicion arose from automated checks.
manualSuspected:true means suspicion arose from manual review.