To start a verification session in "on-boarding" mode, use the string "onboarding".

To start a verification session in "returning user" mode, use the string "returningUser".

For details of the different modes, please refer to the section The Verification Process.

apiCode

This will be provided by VIX Verify.

accountId 

This will be provided by VIX Verify.

ruleId

If no value is provided, the server will use the default ruleId set on the account.

If a ruleId value is provided, the server will use this instead of the default.

RuleIds are set in the skin file when multiple rules are added to an account. If you do not know the ruleID of a rule set you intend to use then please contact support@vixverify.com for assistance. 

baseUrl 

Test environment = https://simpleui-test-au.vixverify.com

Australian Production environment = https://simpleui-au.vixverify.com 

South Africa Production environment = https://simpleui-za.vixverify.com 

countryCode

One of the following strings, each corresponding to the ISO 3166 Alpha-2 country code for a country.

"AU", "MY", "NZ", "SG", "US".

The string "license" if the size and orientation of the ID document that is to be scanned is a licence or ID card. The string "passport" if the size and orientation of the ID document that is to be scanned is a passport.
Default value: Determined by server

The user friendly name of the document type that the user will be prompted to scan.

Default value: Determined by server

selectedDocumentType

String

A boolean that should be set to true if an overview screen should be displayed by the SDK before the data capture process starts. Otherwise, set the value to false.

Default value: true

enableSkipBackOfCard

A boolean that overrides the server setting for back of card capture.  Set to true to ensure that the back of card will be captured, or false to skip the back of card capture.  Leaving this parameter undefined will mean that the server value for your customer setup will be used.  

Default value: Determined by server

customCssPath

A string that corresponds to a fully qualified URL that resolves to a CSS file that can be used to style the SDK screens. Note that the CSS must be served via HTTPS to avoid cross-domain content issues.

Default value: “”

A session token to be used when greenID is being used in "returning user" mode. If the mode parameter has the value "returningUser" then this parameter is mandatory.

For details of the different modes, please refer to the section The Verification Process.

Amount of seconds after the selfie scan process commences before using manual capture.

Valid values: 0 or more

Default value: 10

Note: Setting this value to zero, starts the selfie scan process in Manual mode instead of Semi-Automatic.

errorModalHeading

String

The heading for the "unexpected error" modal.

Default value: "Unexpected error"

errorModalText

String

The body text for the "unexpected error" modal.

Default value: "<p>An unexpected error has occurred</p>"

errorModalButton

String

The button text for the "unexpected error" modal.

Default value: "Continue"

globalTimeout

String

The amount of time in milliseconds the SDK will wait for a response from the server before returning a Network Error result for all requests other than extractOCRData, getToken and getConfig.

Default value: 0 (No timeout)

extractOCRDataTimeout

String

The amount of time in milliseconds the SDK will wait for a response from the server for extractOCRData requests before returning a Network Error result.

Default value: 10000 (10 Seconds)

getTokenTimeout

String

The amount of time in milliseconds the SDK will wait for a response from the server for getToken requests before returning a Network Error result.

Default value: 4000 (4 Seconds)

getConfigTimeout

String

The amount of time in milliseconds the SDK will wait for a response from the server for getConfigTimeout requests before returning a Network Error result.

Default value: 4000 (4 Seconds)

The amount of time the SDK will allow for inactivity during non-capture screens, before sending back an INACTIVITY result to the calling application.

Default value: 300 (5 minutes)

handoffNotDocumentSelect

If this parameter is set to true then when the user would normally be asked to select another document, instead the SDK will perform a handoff to the client application. This is designed to be used in conjunction with selectedDocumentType to bypass the SDKs own document selection screen and allow the client application to select the document. Please note that it is wise to ensure that your account is configured to return the total completed attempts for a given source in webService requests if you plan to use this feature, as this is not turned on by default for customers and will almost certainly be required for this workflow. If it is not then please contact: support@vixverify.com to have it enabled.

Default value: false

The number of seconds after which the document scanning process will failover to manual capture mode, allowing the user to frame the document themselves, and manually tap the capture button.

Valid values: 0 or more

Default value: 15

Note: Setting this value to zero starts the document capture scan process in Manual mode instead of Semi-Automatic.

When capturing a driver's licence, the number of seconds after which the document scanning process will failover to manual capture mode, allowing the user to frame the document themselves, and manually tap the capture button.

Valid values: 0 or more

Default value: If not set, then the more generic documentCaptureResetTimeout value is used for capturing licences. 

Note: Setting this value to zero starts the document capture scan process in Manual mode instead of Semi-Automatic.

When capturing a passport, the number of seconds after which the document scanning process will failover to manual capture mode, allowing the user to frame the document themselves, and manually tap the capture button.

Valid values: 0 or more

Default value: If not set, then the more generic documentCaptureResetTimeout value is used for capturing passports. 

Note: Setting this value to zero starts the document capture scan process in Manual mode instead of Semi-Automatic.

When capturing a South African Green ID booklet, the number of seconds after which the document scanning process will failover to manual capture mode, allowing the user to frame the document themselves, and manually tap the capture button.

Valid values: 0 or more

Default value: If not set, then the more generic documentCaptureResetTimeout value is used for capturing Green ID booklets. 

Note: Setting this value to zero starts the document capture scan process in Manual mode instead of Semi-Automatic.

The business unit the verification should be assigned to, this is an entirely optional setting which is only required if business units are both configured for your account and you wish to assign the verification to be created by the SDK to a business unit. Please note that when registering the customer using the returning user workflow then the business unit should be sent as an extraData parameter in the initial registerVerification call from the API (eg: <extraData><name>business_unit</name><value>whateverBusinessUnitYouWantToSend</value></extraData>) rather then as an SDK parameter. If you would like to use business units but they are not configured on your account then please contact: support@vixverify.com to have them configured.

Valid values: Dependant on customer configuration.

Default value: none