全部产品
Search
文档中心

ID Verification:iOS SDK UI自定义配置说明

更新时间:Dec 04, 2025

ID Verification iOS SDK提供自定义UI颜色、icon图标的接口,开发者可以通过编写自定义UI配置,以文件或JSON数据格式通过传入setCustomUI接口实现UI的自定义效果。本文为您介绍UI自定义接口说明以及相关的代码示例。

说明

部分自定义配置可能需要依赖SDK升级,建议您在使用之前将SDK升级至最新版本。如用户界面自定义设置与验证接口的扩展参数存在冲突,优先使用用户界面自定义设置。请确保 UI 自定义设置优先于任何验证接口参数,以提供一致且直观的用户体验。

接口说明

接口定义

iOS SDK中提供了自定义UI颜色和icon图标的接口:setCustomUI。您可以通过调用此方法并传入对应参数来实现自定义UI的效果。

/** 
 * 设置自定义UI颜色和icon图标
 *
 * Set custom UI
 * @param configuration - Input JSON string
 * @param completeBlock - Callback for the configuration results
*/
- (void)setCustomUI:(nonnull NSString *)configuration
           complete:(void(^_Nullable)(BOOL success, NSError * _Nullable error))completeBlock;

入参说明

名称

类型

说明

configuration

NSString

配置自定义UI传入JSON字符串。

completeBlock

block

结果信息回调:

  • success = YES:设置成功。

  • success = NO:设置的内容存在问题,具体请查看对应返回的error说明。

示例代码

NSString *jsonString = @"{\"faceConfig\":{\"exitIconBase64\":\"data:image/png;base64,iVBORw0..\"}}";
[[AliyunIdentityPlatform sharedInstance] setCustomUI:@"" complete:^(BOOL success, NSError * _Nullable error) {
     	NSLog(@"%@",error.localizedDescription);       
}];

自定义UI配置内容

完整配置示例

{
  "faceConfig": {
    "exitIconBase64": "exit_icon_base64",
    "faceBGColor": "#FFFFFF",
    "faceTitleColor": "#000000",
    "faceTipColor": "#000000",
    "opFailedTitleColor": "#000000",
    "opFailedTipColor": "#000000",
    "opFailedConfirmColor": "#4FA3EC",
    "faceProgressEndColor": "#E3824C",
    "exitAlertTitleColor": "#000000",
    "exitAlertMessageColor": "#000000",
    "exitAlertCancelColor": "#4FA3EC",
    "exitAlertConfirmationColor": "#4FA3EC",
    "timeoutAlertTitleColor": "#000000",
    "timeoutAlertMessageColor": "#000000",
    "timeoutAlertConfirmationColor": "#4FA3EC",
    "tooManyRetriesAlertTitleColor": "#000000",
    "tooManyRetriesAlertMessageColor": "#000000",
    "tooManyRetriesAlertConfirmColor": "#4FA3EC",
    "interruptedAlertTitleColor": "#000000",
    "interruptedAlertMessageColor": "#000000",
    "interruptedAlertConfirmColor": "#4FA3EC",
    "permissionFailedAlertTitleColor": "#000000",
    "permissionFailedAlertMessageColor": "#000000",
    "permissionFailedAlertConfirmColor": "#4FA3EC",
    "verifyNetworkErrorAlertTitleColor": "#000000",
    "verifyNetworkErrorAlertMessageColor": "#000000",
    "verifyNetworkErrorAlertConfirmColor": "#4FA3EC",
    "verifyNetworkErrorAlertCancelColor": "#4FA3EC",
    "verifyLoadingColor": "#585858"
  },
  "ocrConfig": {
    "exitIconBase64": "exit_icon_base64",
    "albumBase64": "album_base64",
    "takePhotoBase64": "take_photo_base64",
    "submitBase64": "submit_base64",
    "ocrResultExitIconBase64": "ocr_result_exit_icon_base64",
    "ocrResultTipIconBase64": "ocr_result_tip_icon_base64",
    "ocrTitleColor": "#FFFFFF",
    "ocrBorderColor": "#E3824C",
    "ocrSubmitTitleColor": "#FFFFFF",
    "ocrLoadingColor": "#FFFFFF",
    "failedAlertTitleColor": "#000000",
    "failedAlertMessageColor": "#000000",
    "failedAlertCancelColor": "#4FA3EC",
    "failedAlertConfirmationColor": "#4FA3EC",
    "timeoutAlertTitleColor": "#000000",
    "timeoutAlertMessageColor": "#000000",
    "timeoutAlertConfirmationColor": "#4FA3EC",
    "exitAlertTitleColor": "#000000",
    "exitAlertCancelColor": "#4FA3EC",
    "exitAlertConfirmationColor": "#4FA3EC",
    "ocrResultTitleColor": "#000000",
    "ocrResultTipBGColor": "#DFDFDF",
    "ocrResultTipColor": "#000000",
    "ocrResultInfoTitleColor": "#000000",
    "ocrResultInfoContentColor": "#F6F6F6",
    "ocrResultInfoBorderColor": "#E3824C",
    "ocrResultTipTitleColor": "#D59F9E",
    "ocrResultErrorTipBGColor": "#F6DAD5",
    "ocrResultConfirmBtnDisabledBGColor": "#DADADA",
    "ocrResultConfirmBtnDisabledTitleColor": "#FFFFFF",
    "ocrResultConfirmBtnEnabledBGColor": "",
    "ocrResultConfirmBtnEnabledTitleColor": "#FFFFFF",
    "ocrResultExitAlertTitleColor": "#000000",
    "ocrResultExitAlertCancelColor": "#000000",
    "ocrResultExitAlertConfirmationColor": "#4FA3EC",
    "restrictionsAlertTitleColor": "#000000",
    "restrictionsAlertMessageColor": "#000000",
    "restrictionsAlertConfirmationColor": "#4FA3EC",
    "permissionFailedAlertTitleColor": "#000000",
    "permissionFailedAlertMessageColor": "#000000",
    "permissionFailedAlertConfirmColor": "#4FA3EC",
    "ocrNetworkErrorAlertTitleColor": "#000000",
    "ocrNetworkErrorAlertMessageColor": "#000000",
    "ocrNetworkErrorAlertCancelColor": "#4FA3EC",
    "ocrNetworkErrorAlertConfirmColor": "#4FA3EC",
    "docErrorAlertTitleColor": "#000000",
    "docErrorAlertMessageColor": "#000000",
    "docErrorAlertCancelColor": "#4FA3EC",
    "docErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultNetworkErrorAlertTitleColor": "#000000",
    "ocrResultNetworkErrorAlertMessageColor": "#000000",
    "ocrResultNetworkErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultInfoErrorAlertMessageColor": "#000000",
    "ocrResultInfoErrorAlertConfirmColor": "#4FA3EC",
    "ocrResultLoadingColor": "#FFFFFF"
  }
}

字段配置效果

faceModule

faceBGColor

faceBGColor

exitIconBase64

exitIconBase64

faceTitleColor

faceTitleColor

faceTipColor

faceTipColor

interruptedAlertTitleColor

interruptedAlertTitleColor

interruptedAlertMessageColor

interruptedAlertMessageColor

interruptedAlertConfirmColor

interruptedAlertConfirmColor

permissionFailedAlertTitleColor

permissionFailedAlertTitleColor

permissionFailedAlertMessageColor

permissionFailedAlertMessageColor

permissionFailedAlertConfirmColor

permissionFailedAlertConfirmColor

tooManyRetriesAlertTitleColor

tooManyRetriesAlertTitleColor

tooManyRetriesAlertMessageColor

tooManyRetriesAlertMessageColor

tooManyRetriesAlertConfirmColor

tooManyRetriesAlertConfirmColor

faceProgressEndColor

faceProgressEndColor

exitAlertTitleColor

exitAlertTitleColor

exitAlertMessageColor

exitAlertMessageColor

exitAlertCancelColor

exitAlertCancelColor

exitAlertConfirmationColor

exitAlertConfirmationColor

timeoutAlertTitleColor

timeoutAlertTitleColor

timeoutAlertMessageColor

timeoutAlertMessageColor

timeoutAlertConfirmationColor

timeoutAlertConfirmationColor

verifyLoadingColor

verifyLoadingColor

verifyNetworkErrorAlertTitleColor

verifyNetworkErrorAlertTitleColor

verifyNetworkErrorAlertMessageColor

verifyNetworkErrorAlertMessageColor

verifyNetworkErrorAlertCancelColor

verifyNetworkErrorAlertCancelColor

verifyNetworkErrorAlertConfirmColor

verifyNetworkErrorAlertConfirmColor

ocrModule

exitIconBase64
exitIconBase64

ocrTitleColor
ocrTitleColor

ocrBorderColor
ocrBorderColor

albumBase64
albumBase64

takePhotoBase64
takePhotoBase64

submitBase64
submitBase64

ocrSubmitTitleColor
ocrSubmitTitleColor

ocrLoadingColor
ocrLoadingColor

ocrNetworkErrorAlertTitleColor
ocrNetworkErrorAlertTitleColor

ocrNetworkErrorAlertMessageColor
ocrNetworkErrorAlertMessageColor

ocrNetworkErrorAlertCancelColor
ocrNetworkErrorAlertCancelColor

ocrNetworkErrorAlertConfirmColor
ocrNetworkErrorAlertConfirmColor

permissionFailedAlertTitleColor
permissionFailedAlertTitleColor

permissionFailedAlertMessageColor
permissionFailedAlertMessageColor

permissionFailedAlertConfirmColor
permissionFailedAlertConfirmColor

docErrorAlertTitleColor
docErrorAlertTitleColor

docErrorAlertMessageColor
docErrorAlertMessageColor

docErrorAlertCancelColor
docErrorAlertCancelColor

docErrorAlertConfirmColor
docErrorAlertConfirmColor

failedAlertTitleColor
failedAlertTitleColor

failedAlertMessageColor
failedAlertMessageColor

failedAlertConfirmationColor
failedAlertConfirmationColor

failedAlertCancelColor
failedAlertCancelColor

restrictionsAlertTitleColor
restrictionsAlertTitleColor

restrictionsAlertMessageColor
restrictionsAlertMessageColor

restrictionsAlertConfirmationColor
restrictionsAlertConfirmationColor

timeoutAlertTitleColor
timeoutAlertTitleColor

timeoutAlertMessageColor
timeoutAlertMessageColor

timeoutAlertConfirmationColor
timeoutAlertConfirmationColor

exitAlertTitleColor
exitAlertTitleColor

exitAlertCancelColor
exitAlertCancelColor

exitAlertConfirmationColor
exitAlertConfirmationColor

ocrResultExitIconBase64
ocrResultExitIconBase64

ocrResultTitleColor
ocrResultTitleColor

ocrResultTipBGColor
ocrResultTipBGColor

ocrResultTipColor
ocrResultTipColor

ocrResultInfoTitleColor
ocrResultInfoTitleColor

ocrResultInfoContentColor
ocrResultInfoContentColor

ocrResultConfirmBtnEnabledBGColor
ocrResultConfirmBtnEnabledBGColor

ocrResultConfirmBtnEnabledTitleColor
ocrResultConfirmBtnEnabledTitleColor

ocrResultTipTitleColor
ocrResultTipTitleColor

ocrResultTipIconBase64
ocrResultTipIconBase64

ocrResultErrorTipBGColor
ocrResultErrorTipBGColor

ocrResultInfoborderColor
ocrResultInfoborderColor

ocrResultConfirmBtnDisabledBGColor
ocrResultConfirmBtnDisabledBGColor

ocrResultConfirmBtnDisabledTitleColor
ocrResultConfirmBtnDisabledTitleColor

ocrResultExitAlertTitleColor
ocrResultExitAlertTitleColor

ocrResultExitAlertCancelColor
ocrResultExitAlertCancelColor

ocrResultExitAlertConfirmationColor
ocrResultExitAlertConfirmationColor

ocrResultNetworkErrorAlertTitleColor
ocrResultNetworkErrorAlertTitleColor

ocrResultNetworkErrorAlertMessageColor
ocrResultNetworkErrorAlertMessageColor

ocrResultNetworkErrorAlertConfirmColor
ocrResultNetworkErrorAlertConfirmColor

ocrResultInfoErrorAlertMessageColor
ocrResultInfoErrorAlertMessageColor

ocrResultInfoErrorAlertConfirmColor
ocrResultInfoErrorAlertConfirmColor

ocrResultLoadingColor
ocrResultLoadingColor

ocrGuideExitIconBase64
ocrGuideExitIconBase64

ocrGuideTitleColor
ocrGuideTitleColor

ocrGuideContentColor
ocrGuideContentColor

ocrGuideStartBtnTextColor
ocrGuideStartBtnTextColor

ocrGuideStartBtnBGColor
ocrGuideStartBtnBGColor

ocrGuideIndicatorUnSelectedColor
ocrGuideIndicatorUnSelectedColor

ocrGuideIndicatorSelectedColor
ocrGuideIndicatorSelectedColor

nfcTitleColor
nfcTitleColor

nfcContentColor
nfcContentColor

nfcConfirmBtnBGColor
nfcConfirmBtnBGColor

nfcConfirmBtnTextColor
nfcConfirmBtnTextColor

nfcInputCheckAlertMessageColor
nfcInputCheckAlertMessageColor

nfcInputCheckAlertConfirmColor
nfcInputCheckAlertConfirmColor

nfcInputPassportEditHintColor
nfcInputPassportEditHintColor

nfcInputBirthdayEditHintColor
nfcInputBirthdayEditHintColor

nfcInputValidityEditHintColor
nfcInputValidityEditHintColor

nfcInputPassportLabelColor
nfcInputPassportLabelColor

nfcInputBirthdayLabelColor
nfcInputBirthdayLabelColor

nfcInputValidityLabelColor
nfcInputValidityLabelColor

nfcInputBirthdayEditColor
nfcInputBirthdayEditColor

nfcInputValidityEditColor
nfcInputValidityEditColor

nfcInputPassportEditColor
nfcInputPassportEditColor

nfcInputTitleColor
nfcInputTitleColor

nfcInputBackAlertTitleColor
nfcInputBackAlertTitleColor

nfcInputBackAlertCancelColor
nfcInputBackAlertCancelColor

nfcInputBackAlertConfirmColor
nfcInputBackAlertConfirmColor

nfcInputNextBtnTextSelectColor
nfcInputNextBtnTextSelectColor

nfcInputNextBtnBGSelectColor
nfcInputNextBtnBGSelectColor

nfcReadBackAlertTitleColor
nfcReadBackAlertTitleColor

nfcReadBackAlertConfirmColor
nfcReadBackAlertConfirmColor

nfcReadBackAlertCancelColor
nfcReadBackAlertCancelColor

ocrAlbumLabelColor
ocrAlbumLabelColor

ocrTakePhotoLabelColor
ocrTakePhotoLabelColor