To create your session, please start by configuring your preferences.
The method SdkConfigBuilder is explained below. If parameters are not defined, the default below will be set:
xxxxxxxxxx.withSdkConfig( new SdkConfigBuilder() .withAllowsCamera() .withPrimaryColour('#2d9fff') .withLocale('en-GB') .withPresetIssuingCountry('GBR') .withSuccessUrl(`${process.env.YOTI_APP_BASE_URL}/success`) .withPrivacyPolicyUrl(`${process.env.YOTI_APP_BASE_URL}/privacy`) .withErrorUrl(`${process.env.YOTI_APP_BASE_URL}/error`) .withAllowHandoff(true) .withIdDocumentTextExtractionGenericRetries(3) .withIdDocumentTextExtractionReclassificationRetries(3) .build())| Type | Parameter (examples) | Description | Optional |
|---|---|---|---|
| Allowed capture methods | withAllowsCamera withAllowsCameraAndUpload | Whether the user must only use the camera on their device to take a photo of their ID document, or whether they can also upload an existing image of the document from a file. Yoti's in-session feedback will still take place for uploaded images. This is an initial check for document image quality. A user may be asked to try again even with an uploaded image; in this case, they can either revert to live capture or submit a new image from their live system. Note: The uploading of document images is a well-documented attack vector for fraudsters, and with the emergence of Synthetic Documents, we recommend you discuss the use of this functionality with your Yoti representative. It remains a fast and inclusive way for you to process sessions with Yoti; however, it could increase the risk of Fraud. | ✅ |
| withPrimaryColour | #2d9fff(default), #ff0000 | Colours of the button are provided in the frontend client as a hexadecimal RGB value. | ✅ |
| withLocale | en-GB(default) | Force language locale for the frontend client. Full list shown below. Note: This property should be omitted in order for the UI to auto-detect the user's browser language settings. | ✅ |
| withPresetIssuingCountry | USA, GBR | The user must select the issuing country of the document they are uploading. This setting determines which issuing country is selected by default. Note: Must be a 3-letter ISO 3166 code. | ✅ |
| withSuccessUrl | https://yourdomain.com/success | If the upload/photo is successfully captured, redirect your users here. Yoti will then begin to carry out the requested checks and tasks. If undefined, the page will not redirect, and you can listen to Yoti's post messages on the same page. | ✅ |
| withPrivacyPolicyUrl | https://yourdomain.com/privacy | Configure the biometric consent privacy policy URL. We will ask each user for their biometric consent before their liveness check. | ✅ |
| withErrorUrl | https://yourdomain.com/error | If the upload/photo is unsuccessfully captured, redirect your users here. If undefined, the user view will display an error screen, with the error code as a query parameter, and won't redirect. (Details on the error codes can be found in Launch the user view) | ✅ |
| withAllowHandoff | true, false | If enabled, it will allow the user the option to transfer the flow from desktop to a mobile device by scanning a QR code. | ✅ |
| TextExtractionGenericAttempts | 3 | The number of attempts a user has to upload their document if we are unable to process it on their initial upload. | ✅ |
| TextExtractionReclassificationAttempts | 3 | The number of attempts a user has to upload their document if we deem the uploaded document was not the type the user selected. | ✅ |
Translated languages
Yoti offers the ability to force a language locale for the front end client - see the list here:
| Language | Parameter |
|---|---|
| Arabic (العربية) | ar |
| Bosnian (bosanski) | bs |
| Brazilian Portuguese (português brasileiro) | pt |
| Chinese (Singapore Simplified) (简体中文) | zh-SG |
| Czech (čeština) | cs |
| Danish (Dansk) | da |
| Dutch (Dutch) | nl |
| English (en-GB) | en-GB (default) |
| English (American) | en-US |
| English (Canadian) | en-CA |
| Finnish (Suomi) | fi |
| French (Français) | fr |
| German (Deutsch) | de |
| Greece (el-GR) | el-GR |
| Hindi (हिंदी) | hi |
| Hungarian (Magyar) | hu |
| Indonesian (Bahasa Indonesia) | id |
| Italian (Italiano) | it |
| Japan (日本) | ja |
| Netherlands (Nederlands) | nl |
| Norwegian (Norsk) | nb |
| Polish (polski) | pl |
| Romanian (România) | ro |
| Russian (русский) | ru |
| Serbia (српски) | sr |
| Spanish (Español) | es |
| Spanish for Latin American (es-419) | es-419 |
| Swedish (Svenska) | sv |
| Tamil (தமிழ்) | ta |
| Thai (ภาษาไทย) | th |
| Turkish (Türkçe) | tr |
| Vietnamese (Tiếng Việt) | vi |
Mobile handoff
To optimise results, Yoti has implemented a mobile handoff feature. This allows a user to transfer flow from a desktop to a mobile device by scanning a QR code. The user will be guided through the session on their mobile until completed, then Yoti will return the user to the desktop.
User flow
The flow is documented below:
Mobile handoff screen 1
At this point, the user can continue on the computer. If they press continue, they will see this screen:
Mobile handoff screen 2
The user still has the option to use the desktop. If they scan the QR code, the session will be continued on their mobile. If they scan the QR code and continue their session correctly, the following screen will show on the web until the session is completed:
Mobile handoff screen 3