Client redirect to WEB UI iFrame
Redirect action
If you wish to have an iFrame implementation – there is a slightly different approach. You will have to directly insert verification platform URL (https://ui.idenfy.com/ ) with authToken query string parameter into your iframe tag. The authToken can be retrieved after generating a token.
The main difference between the regular redirect and iframe implementation is that in iframe, the user can remain in your webpage and complete the verification without opening any additional browser windows.
The company's logo does not show up inside the verification session's UI in iframe.
After the process is finished, you may close the iframe and display a desired page to your client.
-
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.
Please find the available locales and examples below.
Available locales
Values:
-lt
(Lithuanian)
-en
(English)
-ru
(Russian)
-pl
(Polish)
-lv
(Latvian)
-et
(Estonian)
-ro
(Romanian)
-it
(Italian)
-de
(German)
-fr
(French)
-sv
(Swedish)
-es
(Spanish)
-hu
(Hungarian)
-ja
(Japanese)
-bg
(Bulgarian)
-cs
(Czech)
-nl
(Dutch)
-pt
(Portuguese)
-uk
(Ukrainian)
-vi
(Vietnamese)
-sk
(Slovak)
-th
(Thai)
-hi
(Hindi)
-id
(Indonesian)
Examples
Query string parameter name | Example value |
---|---|
authToken | 3FA5TFPA2ZE3LMPGGS1EGOJNJE |
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>
The data object can be found in the console.log message. The allowfullscreen attribute is mandatory if you're using our 3D liveness feature.
Posssible values to check auto and manual review statuses:
Information about the identity verification statuses could be found in console, on data object.
Information about the verification auto status status:
Name | Description |
---|---|
APPROVED | The user completed a verification flow and the verification status, provided by an automated platform, is APPROVED. |
FAILED | The user completed a verification flow and the verification status, provided by an automated platform, is FAILED. |
UNVERIFIED | The user did not complete a verification flow and the verification status, provided by an automated platform, is UNVERIFIED. |
Information about the identity verification manual status manualStatus:
Name | Description |
---|---|
APPROVED | The user completed a verification flow and was verified manually while waiting for the manual verification results. The verification status, provided by a manual review, is APPROVED. |
FAILED | The user completed a verification flow and was verified manually while waiting for the manual verification results. The verification status, provided by a manual review, is FAILED. |
WAITING | The user completed the verification flow and started waiting for the manual verification results. The manual verification review is still ongoing. |
Statuses to check whether verification is suspected:
Information about the verification auto and manual suspected statuses. By default, both autoSuspected
& manualSuspected
are false.
If verification is suspected after automatic check, expect autoSuspected: true
, if verification is suspected after manual review, then expect manualSuspected: true
.