Introduction of customization
It is possible to configure the verification process completely according to your preferences. This section contains all configuration options for the front-end and the OTP. On the remaining pages we highlight some special configuration options.
Front-end configuration
The front-end configuration can be applied as part of the config in Verifai front-end. More information on where to apply these variables can be found here.
Key | Type | Required | Description | Default |
---|---|---|---|---|
token | str | ✔️ | The OTP token | - |
assetsUrl | str | ❌ | URL to the assets | CDN |
customAssetsUrl | str | ❌ | URL to the custom assets | link |
onSuccess | fn | ❌ | Callback for when the flow finishes | link |
onCanceled | fn | ❌ | Callback for when the flow is canceled | link |
show | bool | ❌ | Bool that shows and closes the flow | false |
closable | bool | ❌ | Flow can always be closed | false |
showGreeting | bool | ❌ | Will show a greeting at beginning of flow | true |
showInstruction | bool | ❌ | Bool that inserts screens in the flow with instructions on uploading a travel document correctly | false |
uploadTypes | array | ❌ | Restrict upload types | ["phone", "file"] |
backendUrl | str | ❌ | The URL to the Verifai back-end | SaaS |
theme | object | ❌ | Theme of the sdk | link |
faceMatchMobileOnly | bool | ❌ | Allow the Face Match feature only on Mobile Flow | false |
nonce | str | ❌ | Nonce for inline styles CSP | undefined |
display | str | ❌ | Show the flow in a modal or inline | modal |
OTP configuration
The OTP configuration can be applied as part of the config in your back-end. More information on where to apply these variables can be found here.
Key | Type | Required | Example | Default | API link |
---|---|---|---|---|---|
allow_edit_privacy_filters | bool | ❌ | true | false | link |
cors_allowed_origin | str | ❌ | See link | * | link |
country_choices_blacklist | array | ❌ | ["BE"] | [] | link |
country_choices_whitelist | array | ❌ | ["NL"] | All | link |
document_type_whitelist | array | ❌ | ["P"] | ["P", "I", "D", "RP", "R"] | link |
handover_base_url | str | ❌ | See link | "" | link |
internal_reference | str | ❌ | "Customer1" | "" | link |
locale | str | ❌ | "en_US" | "en_US" | link |
enable_facematch | bool | ❌ | false | false | link |
enable_viz | bool | ❌ | false | false | link |
validators | array | ❌ | See link | [] | link |