Guide to migrate V1 to V2¶

Description¶

The following table compares the configuration variables from previous XpressID version with the current one:

Note that the following configuration variables are only those that fit the new ones. To check all configuration variables for the current XpressID Web, see the configuration documentation.

Content type¶

The Content-Type value has been modified. The updated version exclusively accepts the "application/json" value. Kindly revise and modify your token request to align with this modification.

Iframe integration¶

The iframe integration has changed. Please update the URL in the iframe to load the content correctly. You can verify the iframe integration here.

The new URL for the iframe in the WORK environment is: https://xpressid-web-work.eu.veri-das.com/v2/?access_token=YOUR_ACCESS_TOKEN

The events received from the iFrame have also changed. Please check the Receiving events from the iFrame to see the new events.

Setup Configuration Components¶

Loading¶

Old configuration parameters	New configuration parameters
iframeLoaderColor	setup.loading.progressIndicator.color
iframeLoaderBackgroundColor	setup.loading.progressIndicator.backgroundColor
iframeLoaderText	setup.loading.text
iframeLoaderTextColor	setup.loading.textColor
iframeBackgroundColor	setup.loading.backgroundColor

QR¶

Old configuration parameters	New configuration parameters
iframeQrTitle	flowSetup.options.qr.setup.title.text
iframeQrTitleLine1	flowSetup.options.qr.setup.subtitle.text
iframeQrTitleLine2	flowSetup.options.qr.setup.subtitle.text
iframeButtonQrOnboarding	flowSetup.options.qr.setup.buttons.continue.text
iframeTextColorQr	flowSetup.options.qr.setup.title.textColor flowsetup.options.qr.setup.subtitle.textColor
iframeQrButtonBackgroundColor	flowSetup.options.qr.setup.buttons.continue.backgroundColor
iframeQrButtonTextColor	flowSetup.options.qr.setup.buttons.continue.textColor
iframeQrInitialColor	does not apply (*)
iframeQrEndColor	does not apply (*)

Document¶

Autoclassification selector¶

Old configuration parameters	New configuration parameters
iframeAutoClassificationSelectorInitialColor	does not apply (*)
iframeAutoClassificationSelectorEndColor	does not apply (*)
iframeAutoClassificationSelectorTitleText	flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.title.text
iframeAutoClassificationBackgroundColor	flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.backgroundColor
iframeAutoClassificationMainColor	flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.title.textColor flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.textColor flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.borderColor flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.iconColor flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.secondaryTextColor
iframeAutoClassificationSecondaryColor	flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.textColor flowSetup.options.document.captures.[0-2].autoclassificationSelector.setup.optionChooser.buttons.secondaryTextColor

Document & country selector¶

Old configuration parameters	New configuration parameters
iframeSeldocTitleText	flowSetup.options.document.captures.[0-2].documentSelector.setup.title.text
iframeSeldocSelectCountryText	flowSetup.options.document.captures.[0-2].documentSelector.setup.countryChooser.title.text
iframeSeldocSelectDocumentTypeText	flowSetup.options.document.captures.[0-2].documentSelector.setup.documentChooser.title.text
iframeSeldocLoadingText	does not apply (*)
iframeSeldocBackgroundColor	flowSetup.options.document.captures.[0-2].documentSelector.setup.backgroundColor
iframeSeldocMainColor	flowSetup.options.document.captures.[0-2].documentSelector.setup.title.textColor flowSetup.options.document.captures.[0-2].documentSelector.setup.countryChooser.picker.borderColor flowSetup.options.document.captures.[0-2].documentSelector.setup.documentChooser.buttons.textColor flowSetup.options.document.captures.[0-2].documentSelector.setup.documentChooser.buttons.borderColor
iframeSeldocSecondaryColor	flowSetup.options.document.captures.[0-2].documentSelector.setup.countryChooser.title.textColor flowSetup.options.document.captures.[0-2].documentSelector.setup.countryChooser.picker.textColor flowSetup.options.document.captures.[0-2].documentSelector.setup.optionChooser.title.textColor
iframeSeldocInitialColor	does not apply (*)
iframeSeldocEndColor	does not apply (*)
iframeImageBackground	flowSetup.options.document.captures.[0-2].documentSelector.setup.logo.media

Document Capture¶

The following new configurations start with the following prefix: flowSetup.options.document.captures.[0-2].setup

Old configuration parameters	New configuration parameters
borderColorCenteringAidDefault	does not apply (*)
borderColorCenteringAidDetectingSuccess	does not apply (*)
borderColorCenteringAidDetecting	does not apply (*)
borderColorCenteringAidInactive	does not apply (*)
borderThickness	does not apply (*)
buttonBackgroundColorDark	does not apply (*)
buttonBackgroundColorDarkRepeat	does not apply (*)
buttonBackgroundColorLight	does not apply (*)
buttonBackgroundColorLightRepeat	does not apply (*)
closeButton	generic.common.ui.buttons.close.show
confirmationColorTick	does not apply (*)
confirmationDialogBackgroundColor	does not apply (*)
confirmationDialogTextColor	does not apply (*)
continueButtonColor	does not apply (*)
continueText	sdkDocument.views.reviewImage.card.buttons.continue.text
customConfirmationImageTick	does not apply (*)
detectionMessageBackgroundColorSelfie	does not apply (*)
detectionMessageBorderRadius	does not apply (*)
detectionMessageFontFamily	does not apply (*)
detectionMessageFontWeight	does not apply (*)
detectionMessageLineHeight	does not apply (*)
detectionMessageTextColorSelfie	does not apply (*)
detectionTimeout	sdkDocument.views.capture.detectionTimeout
displayErrors	does not apply (*)
errorActionButtonBackgroundColor	does not apply (*)
errorActionButtonTextColor	does not apply (*)
errorDisplayBackgroundColor	does not apply (*)
errorDisplayHeaderBackgroundColor	does not apply (*)
errorDisplayHeaderTextColor	does not apply (*)
errorDisplayHeaderTitle	does not apply (*)
errorDisplayTextColor	does not apply (*)
errorDisplayUserActionShow	does not apply (*)
fontSize	does not apply (*)
infoAlertSingleSidedDocument	sdkDocument.views.instructions.card.subtitle.document
infoAlertTwoSidedDocument	sdkDocument.views.instructions.card.subtitle.document
infoAlertShow	does not apply (*)
infoAlertShowDocument	does not apply (*)
infoModalShow	sdkDocument.views.instructions.active
infoReviewImageText	sdkDocument.views.reviewImage.card.title
infoReviewImageTextDocument	sdkDocument.views.reviewImage.card.title
infoUserImagesPath	sdkDocument.pathAssets
isInfoModalShow	does not apply (*)
loadingSpinnerColor	does not apply (*)
logEventsToConsole	generic.common.behavior.web.logEvents
manualCaptureEnableDelay	sdkDocument.views.capture.manualCapture.manualCaptureButtonDelay
message_alive_bold	does not apply (*)
outerGlowCenteringAidDefault	does not apply (*)
outerGlowCenteringAidDetecting	does not apply (*)
repeatButtonColor	does not apply (*)
repeatText	sdkDocument.views.reviewImage.card.buttons.repeat.text
restartingErrorText	sdkDocument.views.feedback.errors.validation.card.title
reviewImage	sdkDocument.views.reviewImage.active
sdkBackgroundColorInactive	generic.theme.colorPrimaryLight
setLandscapeDeviceMessage	sdkDocument.views.deviceRotated.card.title
setMessageDisplayHeight	does not apply (*)
setMessageDisplayMargin	does not apply (*)
setMessageDisplayOpacity	does not apply (*)
setMessageDisplayPadding	does not apply (*)
setMessageDisplayPosition	does not apply (*)
setMessageDisplayWidth	does not apply (*)
setPortraitDeviceMessage	sdkDocument.views.deviceRotated.card.title
showLogo	generic.common.ui.logo.show
showSpinner	does not apply (*)
targetSelector	does not apply (*)
videoErrorConstraint	does not apply (*)
videoErrorConstraintActionLabel	does not apply (*)
videoErrorDefault	sdkDocument.views.feedback.errors.videoErrorDefault.card.title
videoErrorExternalInput	sdkDocument.views.feedback.errors.videoErrorExternalInput.card.title
videoErrorNotFound	sdkDocument.views.feedback.errors.videoErrorNotFound.card.title
videoErrorPermission	sdkDocument.views.feedback.errors.videoErrorPermission.card.title
videoErrorPermissionActionLabel	does not apply (*)
videoErrorUnavailable	does not apply (*)
videoErrorUnavailableActionLabel	does not apply (*)
webrtcUnsupportedText	does not apply (*)
borderColorCenteringAidDetecting	does not apply (*)
manualCaptureText	sdkDocument.views.capture.manualCapture.obverse.card.title and sdkDocument.views.capture.manualCapture.reverse.card.title
manualCaptureTextMobile	does not apply (*)
obverseNotFoundText	sdkDocument.views.capture.guidance.documentNotFound.card.title
reverseNotFoundText	sdkDocument.views.capture.guidance.documentNotFound.card.title
passportNotFoundText	sdkDocument.views.capture.guidance.documentNotFound.card.title
passportMRZError	does not apply (*)
confirmationDialogLinkTextColor	does not apply (*)
confirmationDialogButtonTextColor	does not apply (*)
confirmationDialogButtonBackgroundColor	does not apply (*)
confirmationRepeatButtonTextColor	does not apply (*)
confirmationRepeatButtonBackgroundColor	does not apply (*)
confirmationRepeatButtonPadding	does not apply (*)
confirmationCaptureButtonTextColor	does not apply (*)
confirmationCaptureButtonBackgroundColor	does not apply (*)
confirmationCaptureButtonPadding	does not apply (*)
detectionMessageBackgroundColor	does not apply (*)
detectionMessageTextColor	does not apply (*)
detectionMessageBackgroundColorDocument	does not apply (*)
detectionMessageTextColorDocument	does not apply (*)
errorActionButtonPadding	does not apply (*)
infoUserSliderButtonText	does not apply (*)
infoUserDocumentTitle	does not apply (*)
infoUserDocumentMedia	does not apply (*)
infoUserDocumentBackgroundColorTop	does not apply (*)
infoUserDocumentBackgroundColor	does not apply (*)
infoUserDocumentTextColor	does not apply (*)
infoUserDocumentFontSize	does not apply (*)
infoUserDocumentBackgroundColorButton	does not apply (*)
infoUserDocumentTextColorButton	does not apply (*)
infoUserDocumentPaddingButton	does not apply (*)
outerGlowCenteringAidDefault	does not apply (*)
firstArrow	sdkDocument.views.capture.positionGuides.colors is an array bond to the positionGuides.num property to config the arrows, please check the configuration secion to get more info.
secondArrow	sdkDocument.views.capture.positionGuides.colors is an array bond to the positionGuides.num property to config the arrows, please check the configuration secion to get more info.
thirdArrow	sdkDocument.views.capture.positionGuides.colors is an array bond to the positionGuides.num property to config the arrows, please check the configuration secion to get more info.
fourthArrow	sdkDocument.views.capture.positionGuides.colors is an array bond to the positionGuides.num property to config the arrows, please check the configuration secion to get more info.
fifthArrow	sdkDocument.views.capture.positionGuides.colors is an array bond to the positionGuides.num property to config the arrows, please check the configuration secion to get more info.
loadingSpinnerScreenBackgroundColor	does not apply (*)
permissionRefused	sdkDocument.views.feedback.errors.videoErrorPermission.card.title
permissionRefusedTitle	sdkDocument.views.feedback.errors.videoErrorPermission.card.header
tooFarText	sdkDocument.views.capture.tooFar.obverse.card.title and sdkDocument.views.capture.tooFar.reverse.card.title
tooCloseText	does not apply (*)

Selfie Capture¶

The following new configurations start with the following prefix: flowSetup.options.selfie.setup

Old configuration parameters	New configuration parameters
aliveChallenge	sdkSelfie.views.capture.head.token
borderColorCenteringAidDefault	does not apply (*)
borderColorCenteringAidDetectingSuccess	does not apply (*)
borderColorCenteringAidFaceDetecting	does not apply (*)
borderColorCenteringAidInactive	does not apply (*)
borderThickness	does not apply (*)
buttonBackgroundColorDark	does not apply (*)
buttonBackgroundColorDarkRepeat	does not apply (*)
buttonBackgroundColorLight	does not apply (*)
buttonBackgroundColorLightRepeat	capture_repeat_button, review_image_message_buttons_repeat PARTS
center_face	sdkSelfie.views.capture.guidance.notCentered.card.title
closeButton	generic.common.ui.buttons.close.show
confirmationColorTick	capture_success_tick, capture_success_tick_img, capture_success_tick_svg, capture_success_tick_circle, capture_success_tick_path PARTS
confirmationDialogBackgroundColor	review_image_container PART
confirmationDialogTextColor	review_image_message_text PART
continueButtonColor	review_screen_message_buttons_continue PART
continueText	sdkSelfie.views.reviewImage.card.buttons.continue.text
customConfirmationImageTick	does not apply (*)
customOval	does not apply (*)
customOvalBorderRadius	does not apply (*)
detectionMessageBackgroundColorSelfie	does not apply (*)
detectionMessageBorderRadius	does not apply (*)
detectionMessageFontFamily	does not apply (*)
detectionMessageFontWeight	does not apply (*)
detectionMessageLineHeight	does not apply (*)
detectionMessageTextColorSelfie	does not apply (*)
detectionTimeout	sdkSelfie.views.capture.detectionTimeout
displayErrors	does not apply (*)
errorActionButtonBackgroundColor	does not apply (*)
errorActionButtonTextColor	does not apply (*)
errorDisplayBackgroundColor	does not apply (*)
errorDisplayHeaderBackgroundColor	does not apply (*)
errorDisplayHeaderTextColor	does not apply (*)
errorDisplayHeaderTitle	does not apply (*)
errorDisplayTextColor	does not apply (*)
errorDisplayUserActionShow	does not apply (*)
fitYourFace	sdkSelfie.views.capture.selfie.card.title
fontSize	does not apply (*)
infoAlertShow	does not apply (*)
infoAlertShowSelfie	does not apply (*)
infoAlertShowSelfieAlive	does not apply (*)
infoModalShow	sdkSelfie.views.instructions.active
infoReviewImageText	sdkSelfie.views.reviewImage.card.title
infoReviewImageTextSelfieAlive	sdkSelfie.views.reviewImage.card.title
infoReviewImageTextSelfie	sdkSelfie.views.reviewImage.card.title
infoUserAliveBackgroundColor	does not apply (*)
infoUserAliveButtonText	does not apply (*)
infoUserAliveColorButton	does not apply (*)
infoUserAliveHeader	sdkSelfie.views.instructions.header.title
infoUserAliveHeaderColor	does not apply (*)
infoUserAliveMedia	sdkSelfie.views.instructions.card.media
infoUserAliveNextButtonColor	does not apply (*)
infoUserAliveNextButtonText	sdkSelfie.views.instructions.card.buttons.next.text
infoUserAlivePrevButtonColor	does not apply (*)
infoUserAlivePrevButtonText	sdkSelfie.views.instructions.card.buttons.previous.text
infoUserAliveSubTitle	sdkSelfie.views.instructions.card.subtitle
infoUserAliveSubTitleColor	does not apply (*)
infoUserAliveTitle	sdkSelfie.views.instructions.card.title
infoUserAliveTitleColor	does not apply (*)
isInfoModalShow	does not apply (*)
loadingSpinnerColor	does not apply (*)
logEventsToConsole	generic.common.behavior.web.logEvents
message_alive_bold	does not apply (*)
message_alive_light	sdkSelfie.views.capture.head.card.title.movement
message_finish_challenge	sdkSelfie.views.capture.head.card.title.finish
message_middle_center	sdkSelfie.views.capture.head.card.title.back
not_move	does not apply (*)
outerGlowCenteringAidDefault	does not apply (*)
outerGlowCenteringAidDetecting	does not apply (*)
repeatButtonColor	does not apply (*)
repeatText	sdkSelfie.views.reviewImage.card.buttons.repeat.text
restartingErrorText	sdkSelfie.views.feedback.errors.validation.card.title
reviewImage	sdkSelfie.views.reviewImage.active
sdkBackgroundColorInactive	generic.theme.colorPrimaryLight
setLandscapeDeviceMessage	sdkSelfie.views.deviceRotated.card.title
setMessageDisplayHeight	does not apply (*)
setMessageDisplayMargin	does not apply (*)
setMessageDisplayOpacity	does not apply (*)
setMessageDisplayPadding	does not apply (*)
setMessageDisplayPosition	does not apply (*)
setMessageDisplayWidth	does not apply (*)
setPortraitDeviceMessage	sdkSelfie.views.deviceRotated.card.title
showLogo	generic.common.ui.logo.show
showSpinner	does not apply (*)
smileRequestSerious	sdkSelfie.views.capture.smile.card.title.serious
smileRequestSmile	sdkSelfie.views.capture.smile.card.title.smile
stepChallenge	sdkSelfie.views.capture.head.card.footer
stepOfChallenge	does not apply (*)
stepsChallengeColor	does not apply (*)
targetSelector	does not apply (*)
videoErrorConstraint	does not apply (*)
videoErrorConstraintActionLabel	does not apply (*)
videoErrorDefault	sdkSelfie.views.feedback.errors.videoErrorDefault.card.title
videoErrorExternalInput	sdkSelfie.views.feedback.errors.videoErrorExternalInput.card.title
videoErrorNotFound	sdkSelfie.views.feedback.errors.videoErrorNotFound.card.title
videoErrorPermission	sdkSelfie.views.feedback.errors.videoErrorPermission.card.title
videoErrorPermissionActionLabel	does not apply (*)
videoErrorUnavailable	does not apply (*)
videoErrorUnavailableActionLabel	does not apply (*)
webrtcUnsupportedText	does not apply (*)
borderColorCenteringAidDetecting	does not apply (*)

Video Capture¶

The following new configurations start with the following prefix: flowSetup.options.video.setup

Old configuration parameters	New configuration parameters
borderColorCenteringAidDetecting	does not apply (*)
borderColorCenteringAidInactive	does not apply (*)
borderThickness	does not apply (*)
closeButton	generic.common.ui.buttons.close.show
infoFaceRecording	sdkVideo.views.instructions.card.title
infoFaceRecordingRandomNumber	sdkVideo.views.instructions.card.title
infoReverseRecording	sdkVideo.views.capture.guidance.preCapture.reverse.card.title
infoObverseRecording	sdkVideo.views.capture.guidance.preCapture.obverse.card.title
confirmationColorTick	does not apply (*)
customConfirmationImageTick	does not apply (*)
detectionTimeout	sdkVideo.views.capture.detectionTimeout
continueText	does not apply (*)
displayErrors	does not apply (*)
errorActionButtonBackgroundColor	does not apply (*)
errorActionButtonTextColor	does not apply (*)
errorDisplayBackgroundColor	does not apply (*)
errorDisplayTextColor	does not apply (*)
errorDisplayUserActionShow	does not apply (*)
errorDisplayIconColor	does not apply (*)
fontSize	does not apply (*)
infoAlertShow	does not apply (*)
infoAlertShowVideo	does not apply (*)
infoModalShow	sdkVideo.views.instructions.active
isInfoModalShow	does not apply (*)
infoAlertVideoSelfie	does not apply (*)
logEventsToConsole	generic.common.behavior.web.logEvents
sdkBackgroundColorInactive	generic.theme.colorPrimaryLight
dataSaveMode	does not apply (*)
setLandscapeDeviceMessage	sdkVideo.views.deviceRotated.card.title
setPortraitDeviceMessage	sdkVideo.views.deviceRotated.card.title
showLogo	generic.common.ui.logo.show
customLogo	generic.common.ui.logo.media
targetSelector	does not apply (*)
videoErrorConstraint	does not apply (*)
videoErrorConstraintActionLabel	does not apply (*)
videoErrorDefault	sdkVideo.views.feedback.errors.videoErrorDefault.card.title
videoErrorExternalInput	sdkVideo.views.feedback.errors.videoErrorExternalInput.card.title
videoErrorNotFound	sdkVideo.views.feedback.errors.videoErrorNotFound.card.title
videoErrorPermission	sdkVideo.views.feedback.errors.videoErrorPermission.card.title
videoErrorPermissionActionLabel	does not apply (*)
videoErrorUnavailable	does not apply (*)
videoErrorUnavailableActionLabel	does not apply (*)
webrtcUnsupportedText	does not apply (*)
borderColorCenteringAidDetecting	does not apply (*)
detectionMessageBackgroundColor	does not apply (*)
detectionMessageTextColor	does not apply (*)
detectionMessageBackgroundColorVideo	does not apply (*)
detectionMessageTextColorVideo	does not apply (*)
infoUserSliderButtonText	does not apply (*)
forceAlternativeVideoRecorder	sdkVideo.views.capture.alternativeVideoRecorder
infoUserVideoMedia	sdkVideo.views.instructions.card.media
infoUserVideoBackgroundColor	does not apply (*)
infoUserVideoBackgroundColorTop	does not apply (*)
infoUserVideoBackgroundColorButton	does not apply (*)
infoUserVideoTextColor	does not apply (*)
infoUserVideoFontSize	does not apply (*)
infoUserVideoTextColorButton	does not apply (*)
infoUserVideoPaddingButton	does not apply (*)
infoUserButtonTextColor	does not apply (*)
infoUserButtonBackgroundColor	does not apply (*)
infoUserVideoTitle	sdkVideo.views.instructions.card.title
videoErrorExternalInputLabel	sdkVideo.views.feedback.errors.videoErrorDefault.card.title
customOval	does not apply (*)
customOvalBorderRadius	does not apply (*)
errorBoxBackgroundColor	does not apply (*)
errorBoxTextColor	does not apply (*)
errorBoxTitle	does not apply (*)
errorBoxButtonColor	does not apply (*)
errorBoxButtonText	does not apply (*)
errorBoxButtonTextColor	does not apply (*)
obverseDocumentErrorBoxSubTitle	does not apply (*)
reverseDocumentErrorBoxSubTitle	does not apply (*)
resetVideoBoxSubTitle	does not apply (*)
recordingTimeStates	does not apply (*)
smartRecordingTimeStates	does not apply (*)
faceDetectionTime	does not apply (*)
faceWarningDelayTime	does not apply (*)
videoRecordingMaxTime	does not apply (*)
faceErrorBoxSubTitle	does not apply (*)
obverseDocumentWarningDelayTime	does not apply (*)
reverseDocumentWarningDelayTime	does not apply (*)
videoToken	does not apply (*)
enableVideoToken	does not apply (*)
ovalFaceDetectionColor	does not apply (*)
confirmationDialogBackgroundColor	does not apply (*)
confirmationDialogTextColor	does not apply (*)
confirmationDialogButtonPadding	does not apply (*)
confirmationDialogLinkTextColor	does not apply (*)
confirmationDialogButtonBackgroundColor	does not apply (*)
detectionStageCustomLogo	does not apply (*)
backgroundColorEffectMessage	does not apply (*)

Esign¶

The following new configurations start with the following prefix: flowSetup.options.esign.setup

Old configuration parameters	New configuration parameters
iframeEsignWidth	does not apply (*)
iframeEsignHeight	does not apply (*)
iframeEsignMainColor	backgroundColor
iframeEsignTitleText	title.text
iframeEsignSignInputDefaultText	textInput.placeHolder.text
iframeEsignTermsAndConditionsAcceptText	checkbox.text
iframeEsignSignButtonText	buttons.sign.text
iframeEsignRefuseButtonText	buttons.refuse.text
iframeEsignTermsAndConditionsText	modal.title.text, modal.description.text
iframeEsignAcceptPopupButtonText	modal.buttons.accept.text
iframeEsignClosePopupButtonText	modal.buttons.close.text
iframeEsignInitialColor	does not apply (*)
iframeEsignEndColor	does not apply (*)

Success¶

Old configuration parameters	New configuration parameters
iframeCheckText	setup.success.text
iframeCheckTextColor	setup.success.textColor
iframeCheckBorderColor	setup.success.iconColor
iframeCheckTickColor	setup.success.iconColor
iframeLoadFinal	setup.success.show

Old configuration parameters	New configuration parameters
iframeErrorDocumentAnversoText	setup.errorModal.document.obverse.message
iframeErrorDocumentReverseText	setup.errorModal.document.reverse.message
iframeErrorSelfieText	setup.errorModal.selfie.message
iframeErrorVideoText	setup.errorModal.video.message
iframeErrorConnectionText	setup.errorModal.connection.message
iframeShowErrorAlert	setup.errorModal.show

(*) does not apply. It means that the element no longer exists or has been remapped to another property that encompasses multiple elements. For example, color elements have been moved to themes.

DEPRECATED¶

iframeErrorBrowserNotSupported, iframeInitialColor, iframeEndColor

Example¶

XpressID v1¶

Document capture¶

{
    "documentType": "ES2_ID",
    "flowId": "document",
    "configData": {
      "iframeLoaderColor": "#FF7777",
      "iframeLoaderBackgroundColor": "#FFFFFF",
      "iframeLoaderTextColor": "#FFFFFF",
      "iframeBackgroundColor": "#000D44",
      "iframeErrorDocumentAnversoText": "The front of the document is not valid",
      "iframeErrorDocumentReverseText": "The back of the document is not valid",      
      "iframeCheckText": "Process completed successfully",
      "iframeCheckTextColor": "#000D44",
      "iframeCheckBorderColor": "#078B3C",
      "iframeCheckTickColor": "#078B3C",
      "continueText": "Continue",
      "repeatText": "Repeat",
      "infoReviewImageTextDocument": "Check that all data in the document is clearly readable and that there are no glares"
    }    
}

Document Selector + document capture + selfie passive capture¶

{
    "documentType": "ES2_ID",
    "flowId": "seldoc_document_selfie",
    "configData": {
      "iframeLoaderColor": "#FF7777",
      "iframeLoaderBackgroundColor": "#FFFFFF",
      "iframeLoaderTextColor": "#FFFFFF",
      "iframeBackgroundColor": "#000D44",
      "iframeErrorDocumentAnversoText": "The front of the document is not valid",
      "iframeErrorDocumentReverseText": "The back of the document is not valid",
      "iframeErrorSelfieText": "The selfie is not valid",
      "iframeCheckText": "Process completed successfully",
      "iframeCheckTextColor": "#000D44",
      "iframeCheckBorderColor": "#078B3C",
      "iframeCheckTickColor": "#078B3C",
      "iframeQrTitle": "Scan the QR code",
      "iframeButtonQrOnboarding": "Continue",
      "iframeQrButtonBackgroundColor": "#FF7777",
      "iframeSeldocTitleText": "Document selector",
      "iframeSeldocSelectCountryText": "Select your country",
      "iframeSeldocMainColor": "#000D44",
      "continueText": "Continue",
      "repeatText": "Repeat",
      "infoReviewImageTextDocument": "Check that all data in the document is clearly readable and that there are no glares"
    },
    "mobileQrRedirect": "https://yourDomain.com",
    "mobileQrParams": {
        "sessionid": "1672632",
        "language": "es"
    }
}

Document capture + selfie active capture¶

{
    "documentType": "ES2_ID",
    "flowId": "document_selfiealive",
    "configData": {
      "iframeLoaderColor": "#FF7777",
      "iframeLoaderBackgroundColor": "#FFFFFF",
      "iframeLoaderTextColor": "#FFFFFF",
      "iframeBackgroundColor": "#000D44",
      "iframeErrorDocumentAnversoText": "The front of the document is not valid",
      "iframeErrorDocumentReverseText": "The back of the document is not valid",      
      "iframeCheckText": "Process completed successfully",
      "iframeCheckTextColor": "#000D44",
      "iframeCheckBorderColor": "#078B3C",
      "iframeCheckTickColor": "#078B3C",      
      "continueText": "Continue",
      "repeatText": "Repeat",
      "infoReviewImageTextDocument": "Check that all data in the document is clearly readable and that there are no glares",
      "message_finish_challenge": "Great!",
      "infoUserAliveNextButtonText": "Next",                        
    }    
}

XpressID v2¶

Document capture¶

{
    "platform": "web",
    "operationMode": "idv",
    "flowSetup": {
        "stages": ["document"],
        "core": {
            "confirmProcess": true
        },
        "options": {
            "document": {
                "captures": [
                    {
                        "documentTypes": ["ES2_ID"],
                        "setup": {
                            "sdkDocument": {
                                "views": {
                                    "reviewImage": {
                                        "card": {
                                            "title": "Check that all data in the document is clearly readable and that there are no glares",
                                            "buttons": {
                                                "continue": {
                                                    "text": "Continue"
                                                },
                                                "repeat": {
                                                    "text": "Repeat"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }                        
                    }

                ]
            }                       
        }
    },
    "setup": {
        "success": {
            "text": "Process completed successfully",
            "textColor": "#000D44",
            "iconColor": "#078B3C"
        },
        "errorModal": {
            "document": {
                "obverse": {
                    "message": "The front of the document is not valid"
                },
                "reverse": {
                    "message": "The back of the document is not valid"
                }
            }            
        },
        "loading": {
            "progressIndicator": {
                "color": "#FF7777",
                "backgroundColor": "#FFFFFF"
            },
            "textColor": "#000D44",
            "backgroundColor": "#000D44"
        }
    }
}

Document selector + document capture + selfie passive capture¶

{
    "platform": "web",
    "operationMode": "idv",
    "flowSetup": {
        "stages": ["qr","document","selfie"],
        "core": {
            "confirmProcess": true
        },
        "options": {
            "document": {
                "captures": [
                    {
                        "documentTypes": ["SelectedByUser"],
                        "setup": {
                            "sdkDocument": {
                                "views": {
                                    "reviewImage": {
                                        "card": {
                                            "title": "Check that all data in the document is clearly readable and that there are no glares",
                                            "buttons": {
                                                "continue": {
                                                    "text": "Continue"
                                                },
                                                "repeat": {
                                                    "text": "Repeat"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "documentSelector": {
                            "setup": {
                                "title": {
                                    "text": "Document selector",
                                    "textColor": "#000D44"
                                },
                                "countryChooser": {
                                    "title" : {
                                        "text" : "Select your country"
                                    },
                                    "picker": {
                                        "borderColor": "#000D44"
                                    }
                                },
                                "documentChooser": {
                                    "buttons": {
                                        "textColor": "#000D44",
                                        "borderColor": "#000D44"
                                    }
                                }
                            }
                        }
                    }

                ]
            },
            "selfie": {
                "liveness": "passive",
                "setup": {
                    "sdkSelfie": {
                        "views": {
                            "reviewImage": {
                                "card": {
                                    "buttons": {
                                        "continue": {
                                            "text": "Continue"
                                        },
                                        "repeat": {
                                            "text": "Repeat"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }

            },
            "qr": {
                "redirectionUrl": "https://yourDomain.com/?sessionid=1672632&language=es",
                "setup": {
                    "title": {
                        "text": "Scan the QR code"
                    },
                    "buttons": {
                        "continue": {
                            "text": "Continue",
                            "backgroundColor": "#FF7777"
                        }
                    }
                }
            }
        }
    },
    "setup": {
        "success": {
            "text": "Process completed successfully",
            "textColor": "#000D44",
            "iconColor": "#078B3C"
        },
        "errorModal": {
            "document": {
                "obverse": {
                    "message": "The front of the document is not valid"
                },
                "reverse": {
                    "message": "The back of the document is not valid"
                }
            },
            "selfie": {
                "message": "The selfie is not valid"
            }
        },
        "loading": {
            "progressIndicator": {
                "color": "#FF7777",
                "backgroundColor": "#FFFFFF"
            },
            "textColor": "#000D44",
            "backgroundColor": "#000D44"
        }
    }
}

Document capture + selfie active capture¶

{
    "platform": "web",
    "operationMode": "idv",
    "flowSetup": {
        "stages": ["document","selfie"],
        "core": {
            "confirmProcess": true
        },
        "options": {
            "document": {
                "captures": [
                    {
                        "documentTypes": ["ES2_ID"],
                        "setup": {
                            "sdkDocument": {
                                "views": {
                                    "reviewImage": {
                                        "card": {
                                            "title": "Check that all data in the document is clearly readable and that there are no glares",
                                            "buttons": {
                                                "continue": {
                                                    "text": "Continue"
                                                },
                                                "repeat": {
                                                    "text": "Repeat"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }                        
                    }

                ]
            },
            "selfie": {
                "liveness": "active",
                "challengeLength": 2,
                "setup": {
                    "sdkSelfie": {
                        "views": {
                            "reviewImage": {
                                "card": {
                                    "buttons": {
                                        "continue": {
                                            "text": "Continue"
                                        },
                                        "repeat": {
                                            "text": "Repeat"
                                        }
                                    }
                                }
                            },
                            "instructions": {
                                "card": {
                                    "buttons": {
                                        "previous": {
                                            "text": "Next"
                                        }
                                    }
                                }
                            },
                            "capture": {
                                "head": {
                                    "card": {
                                        "title": {
                                            "finish": "Great!"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }

            }           
        }
    },
    "setup": {
        "success": {
            "text": "Process completed successfully",
            "textColor": "#000D44",
            "iconColor": "#078B3C"
        },
        "errorModal": {
            "document": {
                "obverse": {
                    "message": "The front of the document is not valid"
                },
                "reverse": {
                    "message": "The back of the document is not valid"
                }
            }           
        },
        "loading": {
            "progressIndicator": {
                "color": "#FF7777",
                "backgroundColor": "#FFFFFF"
            },
            "textColor": "#000D44",
            "backgroundColor": "#000D44"
        }
    }
}

Guide to migrate V1 to V2¶

Description¶

Content type¶

Iframe integration¶

Setup Configuration Components¶

Loading¶

QR¶

Document¶

Autoclassification selector¶

Document & country selector¶

Document Capture¶

Selfie Capture¶

Video Capture¶

Esign¶

Success¶

Error Modal¶

DEPRECATED¶

Example¶

XpressID v1¶

Document capture¶

Document Selector + document capture + selfie passive capture¶

Document capture + selfie active capture¶

XpressID v2¶

Document capture¶

Document selector + document capture + selfie passive capture¶

Document capture + selfie active capture¶