跳到主要内容

FaceReconOptions 对象

startFaceRecon 参数​

参数类型作用必填
environmentCAAS_ENVIRONMENT用于将运行环境设置为 SANDBOX 或 PRODUCTION 的枚举。是。
client_session_keystring通过服务器到服务器请求向人脸识别 API 获取的临时认证密钥。参见实现。是。
optionsFaceReconOptions包含 SDK 视觉、文案和行为自定义项的可选对象。否。

FaceReconOptions​

所有字段均为可选。未提供某个字段时，原生 SDK 会使用其默认值。

type FaceReconOptions = {
  session_id?: string;
  document_number?: string;
  font_color?: string;
  background_color?: string;
  font_family?: CAAS_FONT_FAMILY;
  show_introduction_screens?: boolean;
  show_success_screen?: boolean;
  show_invalid_token_screen?: boolean;
  audio_configuration?: FACE_RECON_AUDIO_CONFIGURATION;
  onboarding_text_configuration?: OnboardingTextConfiguration;
  log_level?: CAAS_LOG_LEVEL;
};
参数类型作用默认值
session_idstring标识 SDK 中启动的会话的密钥，用于通过日志追踪用户完成的完整流程。最多接受 255 个字符。内部生成。
document_numberstring用户的证件号（CPF），仅用于反欺诈识别。不发送。
font_colorstringSDK 界面的字体和图标颜色，十六进制格式（例如 "#FFFFFF"）。"#000000"
background_colorstringSDK 界面的背景颜色，十六进制格式（例如 "#000000"）。"#FFFFFF"
font_familyCAAS_FONT_FAMILYSDK 界面使用的字体。CAAS_FONT_FAMILY.OPEN_SANS
show_introduction_screensboolean设为 false 时，关闭活体检测前的介绍页。true
show_success_screenboolean设为 false 时，关闭采集完成后的成功页。true
show_invalid_token_screenboolean设为 false 时，关闭 client_session_key 无效或过期时显示的页面。true
audio_configurationFACE_RECON_AUDIO_CONFIGURATION配置语音引导，实时播报采集指引。FACE_RECON_AUDIO_CONFIGURATION.DISABLE
onboarding_text_configurationOnboardingTextConfiguration自定义引导页文案。SDK 默认文案。
log_levelCAAS_LOG_LEVELSDK 日志的详细级别。CAAS_LOG_LEVEL.DEBUG
注意

document_number 字段不会触发人脸注册——它仅用于反欺诈识别。

OnboardingTextConfiguration​

type OnboardingTextConfiguration = {
  onboarding_title?: string;
  onboarding_first_label?: string;
  onboarding_second_label?: string;
  onboarding_third_label?: string;
};
参数类型作用
onboarding_titlestring引导页标题。
onboarding_first_labelstring展示给用户的第一条说明。
onboarding_second_labelstring展示给用户的第二条说明。
onboarding_third_labelstring展示给用户的第三条说明。

枚举​

CAAS_ENVIRONMENT​

enum CAAS_ENVIRONMENT {
  PRODUCTION = 'production',
  SANDBOX = 'sandbox',
}

CAAS_FONT_FAMILY​

enum CAAS_FONT_FAMILY {
  JAKARTA = 'jakarta',                // 仅 iOS
  FUTURA = 'futura',                  // iOS 和 Android
  VERDANA = 'verdana',                // iOS 和 Android
  TREBUCHET_MS = 'trebuchetms',       // 仅 iOS
  TAMILSANGAM_MN = 'tamilsangammn',   // 仅 iOS
  OPEN_SANS = 'open_sans',            // iOS 和 Android
  HELVETICA = 'helvetica',            // 仅 Android
  POPPINS = 'poppins',                // 仅 Android
  ROBOTO = 'roboto',                  // 仅 Android
  SYSTEM_FONT = 'system_font',        // 仅 iOS
}
注意

字体的可用性因平台而异。如果传入平台不支持的字体，将使用该平台的默认字体。为保证跨平台一致性，请使用 FUTURA、VERDANA 或 OPEN_SANS。

FACE_RECON_AUDIO_CONFIGURATION​

enum FACE_RECON_AUDIO_CONFIGURATION {
  ENABLE = 'enable',               // 显示音频开关，播报默认关闭
  DISABLE = 'disable',             // 关闭播报并隐藏开关
  ACCESSIBILITY = 'accessibility', // 当设备启用无障碍功能时，显示开关且播报默认开启
}

CAAS_LOG_LEVEL​

enum CAAS_LOG_LEVEL {
  TRACE = 'trace',
  DEBUG = 'debug',
  LOG = 'log',
  INFO = 'info',
  WARN = 'warn',
  ERROR = 'error',
}