Set Extra Parameters

This function allows you to customize the theme of the user interface in the different flows of the Facetec SDK through metadata sent in JSON format. This metadata allow you to configure the images of the icons, the colors of the frames, and the fonts of the texts as well as their styles, colors and sizes.

The Facetec SDK also allows customization of the user interface texts by editing or adding text files in the app binary. Contact your Technical Account Manager for more information.

Parameter Configuration

This function requires you to send metadata in JSON format in the value of Register 390 (Input parameters). Once the parameters have been defined, they will remain active during the execution of the application. With each successful invocation of this function, all the parameters sent in the JSON are updated.

Refer to FaceTec documentation to learn more about the available customization parameters.

Note

To revert to the default parameters, invoke the function leaving the value of register 390 empty.

{
  "AndroidCustomization":{
    "cancelButtonCustomization":{
      "cancelButtonCustomImage":[Text with the image id],
      "cancelButtonLocation":[TOP_RIGHT|TOP_LEFT|DISABLED]
    },
    "frameCustomization":{
      "backgroundColor":[Color in Hexadecimal],
      "borderColor":[Color in Hexadecimal],
      "cornerRadius":[String with Integer value],
      "elevation":[String with Integer value]
    },
    "overlayCustomization":{
      "showBrandingImage":[true|false],
      "brandingImage":[Text with the image id],
      "backgroundColor":[Color in Hexadecimal]
    },
    "feedbackCustomization":{
      "backgroundColors":[Color in Hexadecimal],
      "cornerRadius":[String with Integer value],
      "textColor": [Color in Hexadecimal],
      "textFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "textSize":[String with Integer value]
    },
    "ovalCustomization":{
      "progressColor1":[Color in Hexadecimal],
      "progressColor2":[Color in Hexadecimal],
      "progressStrokeWidth":[String with Integer value],
      "strokeWidth":[String with Integer value],
      "strokeColor": [Color in Hexadecimal]
    },
    "guidanceCustomization":{
      "readyScreenHeaderTextColor":[Color in Hexadecimal],
      "readyScreenHeaderFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "readyScreenHeaderTextSize":[String with Integer value],
      "readyScreenSubtextTextColor":[Color in Hexadecimal],
      "readyScreenSubtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "readyScreenSubtextTextSize":[String with Integer value],
      "readyScreenTextBackgroundColor":[Color in Hexadecimal],
      "retryScreenHeaderTextColor":[Color in Hexadecimal],
      "retryScreenHeaderFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "retryScreenHeaderTextSize":[String with Integer value],
      "retryScreenSubtextTextColor":[Color in Hexadecimal],
      "retryScreenSubtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "retryScreenSubTextSize":[String with Integer value],
      "retryScreenImageBorderColor":[Color in Hexadecimal],
      "retryScreenOvalStrokeColor":[Color in Hexadecimal],
      "retryScreenSubtextTextSize":[String with Integer value],
      "enableRetryScreenBulletedInstructions":[true|false],
      "buttonBorderColor":[Color in Hexadecimal],
      "buttonBorderWidth":[String with Integer value],
      "buttonCornerRadius":[String with Integer value],
      "buttonRelativeWidth":[String with Float value],
      "buttonTextNormalColor":[Color in Hexadecimal],
      "buttonTextHighlightColor":[Color in Hexadecimal],
      "buttonTextDisabledColor":[Color in Hexadecimal],
      "buttonBackgroundNormalColor":[Color in Hexadecimal],
      "buttonBackgroundHighlightColor":[Color in Hexadecimal],
      "buttonBackgroundDisabledColor":[Color in Hexadecimal],
      "buttonFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "buttonTextSize":[String with Integer value],
      "backgroundColors":[Color in Hexadecimal],
      "foregroundColor":[Color in Hexadecimal],
      "headerFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "headerTextSize":[String with Integer value],
      "subtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "subtextTextSize":[String with Integer value]
    },
    "resultScreenCustomization":{
      "foregroundColor":[Color in Hexadecimal],
      "backgroundColors":[Color in Hexadecimal],
      "messageFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name]
      },
      "messageTextSize":[String with Integer value],
      "messageTextSpacing":[String with Float value],
      "activityIndicatorColor":[Color in Hexadecimal],
      "customActivityIndicatorImage":[Text with the image id],
      "customActivityIndicatorRotationInterval":[String with Integer value],
      "resultAnimationForegroundColor":[Color in Hexadecimal],
      "resultAnimationBackgroundColor":[Color in Hexadecimal],
      "resultAnimationSuccessBackgroundImage":[Text with the image id],
      "resultAnimationUnsuccessBackgroundImage":[Text with the image id],
      "animationRelativeScale":[String with Float value],
      "showUploadProgressBar":[true|false],
      "uploadProgressTrackColor":[Color in Hexadecimal],
      "uploadProgressFillColor":[Color in Hexadecimal]
    }
  },
  "iOSCustomization":{
    "cancelButtonCustomization":{
      "cancelButtonCustomImage":[Text with the image id],
      "cancelButtonLocation":[TOP_RIGHT|TOP_LEFT|DISABLED]
    },
    "frameCustomization":{
      "backgroundColor":[Color in Hexadecimal],
      "borderColor":[Color in Hexadecimal],
      "cornerRadius":[String with Integer value]
    },
    "overlayCustomization":{
      "showBrandingImage":[true|false],
      "brandingImage":[Text with the image id],
      "backgroundColor":[Color in Hexadecimal],
      "blurEffectOpacity":[String with Float value],
      "blurEffectStyle":[DARK|EXTRA_LIGHT|LIGHT|PROMINENT|REGULAR]
    },
    "feedbackCustomization":{
      "backgroundColors":[Color in Hexadecimal],
      "cornerRadius":[String with Integer value],
      "textColor":[Color in Hexadecimal],
      "textFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      }
    },
    "ovalCustomization":{
      "progressColor1":[Color in Hexadecimal],
      "progressColor2":[Color in Hexadecimal],
      "progressStrokeWidth":[Text with the font name],
      "strokeWidth":[String with Integer value],
      "strokeColor":[Color in Hexadecimal]
    },
    "guidanceCustomization":{
      "readyScreenHeaderTextColor":[Color in Hexadecimal],
      "readyScreenHeaderFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "readyScreenSubtextTextColor":[Color in Hexadecimal],
      "readyScreenSubtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "readyScreenTextBackgroundColor":[Color in Hexadecimal],
      "retryScreenHeaderTextColor":[Color in Hexadecimal],
      "retryScreenHeaderFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "retryScreenSubtextTextColor":[Color in Hexadecimal],
      "retryScreenSubtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "retryScreenImageBorderColor":[Color in Hexadecimal],
      "retryScreenOvalStrokeColor":[Color in Hexadecimal],
      "enableRetryScreenBulletedInstructions":[true@false],
      "buttonBorderColor":[Color in Hexadecimal],
      "buttonBorderWidth":[String with Integer value],
      "buttonCornerRadius":[String with integer value],
      "buttonRelativeWidth":[String with Float value],
      "buttonTextNormalColor":[Color in Hexadecimal],
      "buttonTextHighlightColor":[Color in Hexadecimal],
      "buttonTextDisabledColor":[Color in Hexadecimal],
      "buttonBackgroundNormalColor":[Color in Hexadecimal],
      "buttonBackgroundHighlightColor":[Color in Hexadecimal],
      "buttonBackgroundDisabledColor":[Color in Hexadecimal],
      "buttonFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "backgroundColors":[Color in Hexadecimal],
      "foregroundColor":[Color in Hexadecimal],
      "headerFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      },
      "subtextFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":[String with Float value]
      }
    },
    "resultScreenCustomization":{
      "foregroundColor":[Color in Hexadecimal],
      "backgroundColors":[Color in Hexadecimal],
      "messageFont":{
        "textFontStyle":[BOLD|BOLD_ITALIC|ITALIC|NORMAL],
        "textFontFamilyName":[Text with the font name],
        "fontSize":""
      },
      "messageTextSpacing":[String with Float value],
      "activityIndicatorColor":[Color in Hexadecimal],
      "customActivityIndicatorImage":[Text with the image id],
      "customActivityIndicatorRotationInterval":[String with Integer value],
      "resultAnimationForegroundColor":[Color in Hexadecimal],
      "resultAnimationBackgroundColor":[Color in Hexadecimal],
      "resultAnimationSuccessBackgroundImage":[Text with the image id],
      "resultAnimationUnsuccessBackgroundImage":[Text with the image id],
      "animationRelativeScale":[String with Float value],
      "showUploadProgressBar":[true|false],
      "uploadProgressTrackColor":[Color in Hexadecimal],
      "uploadProgressFillColor":[Color in Hexadecimal]
    }
  }
}

{
  "AndroidCustomization":{
    "cancelButtonCustomization":{
      "cancelButtonCustomImage":"facetec_cancel_button",
      "cancelButtonLocation":"TOP_RIGHT"
    },
    "frameCustomization":{
      "backgroundColor":"#FFFFFF",
      "borderColor":"",
      "cornerRadius":"20",
      "elevation":"20"
    },
    "overlayCustomization":{
      "showBrandingImage":"false",
      "brandingImage":"",
      "backgroundColor":"#AA000000"
    },
    "feedbackCustomization":{
      "backgroundColors":"#32AFDE",
      "cornerRadius":"20",
      "textColor":"#FFFFFF",
      "textFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "textSize":"25"
    },
    "ovalCustomization":{
      "progressColor1":"#32AFDE",
      "progressColor2":"#32AFDE",
      "progressStrokeWidth":"4",
      "strokeWidth":"4",
      "strokeColor":"#32AFDE"
    },
    "guidanceCustomization":{
      "readyScreenHeaderTextColor":"#32AFDE",
      "readyScreenHeaderFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "readyScreenHeaderTextSize":"25",
      "readyScreenSubtextTextColor":"#017894",
      "readyScreenSubtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "readyScreenSubtextTextSize":"16",
      "readyScreenTextBackgroundColor":"#00000000",
      "retryScreenHeaderTextColor":"#32AFDE",
      "retryScreenHeaderFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "retryScreenHeaderTextSize":"22",
      "retryScreenSubtextTextColor":"#017894",
      "retryScreenSubtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "retryScreenSubTextSize":"",
      "retryScreenImageBorderColor":"#32AFDE",
      "retryScreenOvalStrokeColor":"#32AFDE",
      "retryScreenSubtextTextSize":"25",
      "enableRetryScreenBulletedInstructions":"false",
      "buttonBorderColor":"",
      "buttonBorderWidth":"",
      "buttonCornerRadius":"40",
      "buttonRelativeWidth":"",
      "buttonTextNormalColor":"#FFFFFF",
      "buttonTextHighlightColor":"#FFFFFF",
      "buttonTextDisabledColor":"#FFFFFF",
      "buttonBackgroundNormalColor":"#F39655",
      "buttonBackgroundHighlightColor":"#F39655",
      "buttonBackgroundDisabledColor":"#F39655",
      "buttonFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "buttonTextSize":"",
      "backgroundColors":"",
      "foregroundColor":"25",
      "headerFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "headerTextSize":"",
      "subtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "subtextTextSize":""
    },
    "resultScreenCustomization":{
      "foregroundColor":"#32AFDE",
      "backgroundColors":"",
      "messageFont":{
        "textFontStyle":"",
        "textFontFamilyName":""
      },
      "messageTextSize":"25",
      "messageTextSpacing":"25",
      "activityIndicatorColor":"#32AFDE",
      "customActivityIndicatorImage":"",
      "customActivityIndicatorRotationInterval":"",
      "resultAnimationForegroundColor":"#FFFFFF",
      "resultAnimationBackgroundColor":"#32AFDE",
      "resultAnimationSuccessBackgroundImage":"#32AFDE",
      "resultAnimationUnsuccessBackgroundImage":"#32AFDE",
      "animationRelativeScale":"#32AFDE",
      "showUploadProgressBar":"false",
      "uploadProgressTrackColor":"false",
      "uploadProgressFillColor":"false"
    }
  },
  "iOSCustomization":{
    "cancelButtonCustomization":{
      "cancelButtonCustomImage":"facetec_cancel_button",
      "cancelButtonLocation":"TOP_RIGHT"
    },
    "frameCustomization":{
      "backgroundColor":"",
      "borderColor":"#00000000",
      "cornerRadius":""
    },
    "overlayCustomization":{
      "showBrandingImage":"false",
      "brandingImage":"",
      "backgroundColor":"",
      "blurEffectOpacity":"0.35",
      "blurEffectStyle":"DARK"
    },
    "feedbackCustomization":{
      "backgroundColors":"#32AFDE",
      "cornerRadius":"20",
      "textColor":"#FFFFFF",
      "textFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":"30"
      }
    },
    "ovalCustomization":{
      "progressColor1":"",
      "progressColor2":"",
      "progressStrokeWidth":"",
      "strokeWidth":"",
      "strokeColor":"#32AFDE"
    },
    "guidanceCustomization":{
      "readyScreenHeaderTextColor":"",
      "readyScreenHeaderFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "readyScreenSubtextTextColor":"",
      "readyScreenSubtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "readyScreenTextBackgroundColor":"#00000000",
      "retryScreenHeaderTextColor":"",
      "retryScreenHeaderFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "retryScreenSubtextTextColor":"",
      "retryScreenSubtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "retryScreenImageBorderColor":"",
      "retryScreenOvalStrokeColor":"#32AFDE",
      "enableRetryScreenBulletedInstructions":"false",
      "buttonBorderColor":"",
      "buttonBorderWidth":"",
      "buttonCornerRadius":"40",
      "buttonRelativeWidth":"",
      "buttonTextNormalColor":"#FFFFFF",
      "buttonTextHighlightColor":"",
      "buttonTextDisabledColor":"",
      "buttonBackgroundNormalColor":"#F39655",
      "buttonBackgroundHighlightColor":"",
      "buttonBackgroundDisabledColor":"",
      "buttonFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "backgroundColors":"#32AFDE",
      "foregroundColor":"",
      "buttonTextSize":"25",
      "headerFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "subtextFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      }
    },
    "resultScreenCustomization":{
      "foregroundColor":"#32AFDE",
      "backgroundColors":"",
      "messageFont":{
        "textFontStyle":"",
        "textFontFamilyName":"",
        "fontSize":""
      },
      "messageTextSize":"25",
      "messageTextSpacing":"",
      "activityIndicatorColor":"#32AFDE",
      "customActivityIndicatorImage":"",
      "customActivityIndicatorRotationInterval":"",
      "resultAnimationForegroundColor":"#FFFFFF",
      "resultAnimationBackgroundColor":"#32AFDE",
      "resultAnimationSuccessBackgroundImage":"#32AFDE",
      "resultAnimationUnsuccessBackgroundImage":"#32AFDE",
      "animationRelativeScale":"#32AFDE",
      "showUploadProgressBar":"false",
      "uploadProgressTrackColor":"false",
      "uploadProgressFillColor":"false"
    }
  }
}

Function ID

Register	Value
110	5

Input Registers

Register	Description	Mandatory	Value
390	Theme customization metadata in JSON format	No	[Paste customized JSON into this field]

Output Registers

Description

Value

112

Call Result

000	API_NO_ERROR
001	API_WRONG_PARAMETERS_ERROR
010	API_GENERIC_ERROR
020	ERR_CUSTOM_API_NOT_IMPLEMENTED
021	ERR_CUSTOM_API_WRONG_OUTPUT_PARAMETERS
100	ERR_INVALID_MODE
101	ERR_STATUS_NOT_OS_SUPPORTED
103	ERR_STATUS_EXPIRED_LICENCE
312	INVALID_CUSTOMIZATION_JSON

In this section:

Veritran Docs