すべてのプロダクト
Search
ドキュメントセンター

ID Verification:iOS SDK のカスタム UI 構成

最終更新日:Mar 01, 2026

ID Verification iOS SDK は、setCustomUI インターフェースを提供し、UI の色とアイコンをカスタマイズできます。ファイルとして、または JSON データ形式で構成をこのインターフェースに渡すことで、カスタム UI を適用できます。このトピックでは、UI カスタマイズインターフェースについて説明し、関連するコード例を提供します。

説明

一部のカスタム構成では、SDK のアップグレードが必要になる場合があります。ご利用の前に、SDK を最新バージョンにアップグレードすることを推奨します。ユーザーインターフェースのカスタム設定と認証インターフェースの拡張パラメーターとの間に競合がある場合、ユーザーインターフェースのカスタム設定が優先されます。これにより、一貫性のある直感的なユーザーエクスペリエンスが保証されます。

インターフェースの説明

インターフェースの定義

iOS SDK は、setCustomUI インターフェースを提供し、UI の色とアイコンをカスタマイズできます。このメソッドを呼び出し、対応するパラメーターを渡すことで、UI をカスタマイズできます。

/** 
 * // カスタム UI の色とアイコンを設定します
 *
 * // カスタム UI を設定します
 * @param configuration - 入力 JSON 文字列
 * @param completeBlock - 構成結果のコールバック
*/
- (void)setCustomUI:(nonnull NSString *)configuration
           complete:(void(^_Nullable)(BOOL success, NSError * _Nullable error))completeBlock;

リクエストパラメーター

名前

タイプ

説明

configuration

NSString

カスタム UI 構成を JSON 文字列として指定します。

completeBlock

block

結果コールバック。

  • success = YES: 構成が成功しました。

  • success = NO: 構成に問題があります。詳細については、返されたエラーメッセージをご参照ください。

サンプルコード

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",
    "ocrGuideStartBtnDisableBGColor":"#d5d5d5",
    "ocrGuideStartBtnDisableTextColor":"#F9F9FA" 
  }
}

フィールド構成の効果

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

ocrGuideStartBtnDisableTextColorimage

ocrGuideStartBtnDisableBGColorimage