Skip to main content

Veritran Docs

Set UI Params

This function allows you to define texts and images to customize the UI for enrollment and authentication.

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. All parameters not defined in the JSON will keep their default values.

Note

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

To learn which parameters can be configured using this function, contact your admin.

Function ID

Register

Value

110

5

Input Registers

Register

Description

Mandatory

Value

390

UI Parameters

Yes

List of parameters in JSON format. See example below.

{ 
   'img_biometrics_face_action':'alert_v',
   'img_biometrics_voice_action':'tux',
   'txt_voice_enroll_instruction':'Please, repeat a phrase.'
}
Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

API_WRONG_PARAMETERS_ERROR

010

API_GENERIC_ERROR

020

ERR_CUSTOM_API_NOT_IMPLEMENTED

021

ERR_CUSTOM_API_WRONG_OUTPUT_PARAMETERS

101

ERR_STATUS_NOT_OS_SUPPORTED

103

ERR_STATUS_EXPIRED_LICENSE