すべてのプロダクト
Search

このプロダクト

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

    ドキュメントセンター

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

    最終更新日:Jan 15, 2025

    身元確認 - iOS 向け KYC SDK は、setCustomUI 操作を提供します。これにより、ファイルまたは JSON 文字列を渡すことで、iOS 向け SDK の UI の色やアイコンなどのカスタム UI 構成を設定できます。 KYC は Know Your Customer の略です。このトピックでは、setCustomUI 操作の呼び出し方法について説明し、サンプルコードを提供します。

    説明

    カスタム UI 構成を確実に有効にするために、操作を呼び出す前に SDK を最新バージョンに更新することをお勧めします。指定されたカスタム UI 構成が検証操作の拡張パラメーターと競合する場合、カスタム UI 構成が優先されます。一貫性のある直感的なユーザーエクスペリエンスを提供するために、カスタム UI 構成が検証操作のすべてのパラメーターよりも優先されるようにしてください。

    概要

    ID 検証 - iOS 用 KYC SDK は、setCustomUI 操作を提供します。これにより、カスタム UI の色とアイコンを設定できます。この操作を呼び出して、リクエストパラメーターを指定することで、カスタム UI 構成を設定できます。

    使用方法

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

    パラメーター

    パラメーター

    タイプ

    説明

    configuration

    NSString

    構成。値は JSON 文字列です。

    completeBlock

    block

    結果。有効な値：

    • Yes: 成功。

    • 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", // 終了アイコンの 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", // 終了アイコンの Base64 形式の文字列
    "albumBase64": "album_base64", // アルバムアイコンの Base64 形式の文字列
    "takePhotoBase64": "take_photo_base64", // 写真撮影アイコンの Base64 形式の文字列
    "submitBase64": "submit_base64", // 送信アイコンの Base64 形式の文字列
    "ocrResultExitIconBase64": "ocr_result_exit_icon_base64", // OCR 結果画面の終了アイコンの Base64 形式の文字列
    "ocrResultTipIconBase64": "ocr_result_tip_icon_base64", // OCR 結果画面のヒントアイコンの Base64 形式の文字列
    "ocrTitleColor": "#FFFFFF", // OCR タイトルの色
    "ocrBorderColor": "#E3824C", // OCR 境界線の色
    "ocrSubmitTitleColor": "#FFFFFF", // OCR 送信ボタンのタイトルの色
    "ocrLoadingColor": "#FFFFFF", // OCR ローディングの色
    "failedAlertTitleColor": "#000000", // 失敗アラートのタイトルの色
    "failedAlertMessageColor": "#000000", // 失敗アラートのメッセージの色
    "failedAlertCancelColor": "#4FA3EC", // 失敗アラートのキャンセルボタンの色
    "failedAlertConfirmationColor": "#4FA3EC", // 失敗アラートの確認ボタンの色
    "timeoutAlertTitleColor": "#000000", // タイムアウトアラートのタイトルの色
    "timeoutAlertMessageColor": "#000000", // タイムアウトアラートのメッセージの色
    "timeoutAlertConfirmationColor": "#4FA3EC", // タイムアウトアラートの確認ボタンの色
    "exitAlertTitleColor": "#000000", // 終了アラートのタイトルの色
    "exitAlertCancelColor": "#4FA3EC", // 終了アラートのキャンセルボタンの色
    "exitAlertConfirmationColor": "#4FA3EC", // 終了アラートの確認ボタンの色
    "ocrResultTitleColor": "#000000", // OCR 結果のタイトルの色
    "ocrResultTipBGColor": "#DFDFDF", // OCR 結果のヒントの背景色
    "ocrResultTipColor": "#000000", // OCR 結果のヒントの色
    "ocrResultInfoTitleColor": "#000000", // OCR 結果の情報タイトルの色
    "ocrResultInfoContentColor": "#F6F6F6", // OCR 結果の情報内容の色
    "ocrResultInfoBorderColor": "#E3824C", // OCR 結果の情報の境界線の色
    "ocrResultTipTitleColor": "#D59F9E", // OCR 結果のヒントタイトルの色
    "ocrResultErrorTipBGColor": "#F6DAD5", // OCR 結果のエラーヒントの背景色
    "ocrResultConfirmBtnDisabledBGColor": "#DADADA", // OCR 結果の確認ボタン (無効) の背景色
    "ocrResultConfirmBtnDisabledTitleColor": "#FFFFFF", // OCR 結果の確認ボタン (無効) のタイトルの色
    "ocrResultConfirmBtnEnabledBGColor": "", // OCR 結果の確認ボタン (有効) の背景色
    "ocrResultConfirmBtnEnabledTitleColor": "#FFFFFF", // OCR 結果の確認ボタン (有効) のタイトルの色
    "ocrResultExitAlertTitleColor": "#000000", // OCR 結果の終了アラートのタイトルの色
    "ocrResultExitAlertCancelColor": "#000000", // OCR 結果の終了アラートのキャンセルボタンの色
    "ocrResultExitAlertConfirmationColor": "#4FA3EC", // OCR 結果の終了アラートの確認ボタンの色
    "restrictionsAlertTitleColor": "#000000", // 制限アラートのタイトルの色
    "restrictionsAlertMessageColor": "#000000", // 制限アラートのメッセージの色
    "restrictionsAlertConfirmationColor": "#4FA3EC", // 制限アラートの確認ボタンの色
    "permissionFailedAlertTitleColor": "#000000", // 権限失敗アラートのタイトルの色
    "permissionFailedAlertMessageColor": "#000000", // 権限失敗アラートのメッセージの色
    "permissionFailedAlertConfirmColor": "#4FA3EC", // 権限失敗アラートの確認ボタンの色
    "ocrNetworkErrorAlertTitleColor": "#000000", // OCR ネットワークエラーアラートのタイトルの色
    "ocrNetworkErrorAlertMessageColor": "#000000", // OCR ネットワークエラーアラートのメッセージの色
    "ocrNetworkErrorAlertCancelColor": "#4FA3EC", // OCR ネットワークエラーアラートのキャンセルボタンの色
    "ocrNetworkErrorAlertConfirmColor": "#4FA3EC", // OCR ネットワークエラーアラートの確認ボタンの色
    "docErrorAlertTitleColor": "#000000", // ドキュメントエラーアラートのタイトルの色
    "docErrorAlertMessageColor": "#000000", // ドキュメントエラーアラートのメッセージの色
    "docErrorAlertCancelColor": "#4FA3EC", // ドキュメントエラーアラートのキャンセルボタンの色
    "docErrorAlertConfirmColor": "#4FA3EC", // ドキュメントエラーアラートの確認ボタンの色
    "ocrResultNetworkErrorAlertTitleColor": "#000000", // OCR 結果ネットワークエラーアラートのタイトルの色
    "ocrResultNetworkErrorAlertMessageColor": "#000000", // OCR 結果ネットワークエラーアラートのメッセージの色
    "ocrResultNetworkErrorAlertConfirmColor": "#4FA3EC", // OCR 結果ネットワークエラーアラートの確認ボタンの色
    "ocrResultInfoErrorAlertMessageColor": "#000000", // OCR 結果情報エラーアラートのメッセージの色
    "ocrResultInfoErrorAlertConfirmColor": "#4FA3EC", // OCR 結果情報エラーアラートの確認ボタンの色
    "ocrResultLoadingColor": "#FFFFFF" // OCR 結果のローディングの色
  }
}

    パラメーターの説明

    モジュール

    キー

    スナップショット

    faceModule

    faceBGColor

    image.png

    exitIconBase64

    image.png

    faceTitleColor

    image.png

    faceTipColor

    image.png

    interruptedAlertTitleColor

    image.png

    中断アラートメッセージ色

    image.png

    中断アラート確認色

    image.png

    permissionFailedAlertTitleColor

    image.png

    権限失敗アラートメッセージ色

    image.png

    権限失敗アラート確認色

    image.png

    tooManyRetriesAlertTitleColor

    image.png

    tooManyRetriesAlertMessageColor

    image.png

    tooManyRetriesAlertConfirmColor

    image.png

    faceProgressEndColor

    image.png

    exitAlertTitleColor

    image.png

    exitAlertMessageColor

    image.png

    exitAlertCancelColor

    image.png

    exitAlertConfirmationColor

    image.png

    timeoutAlertTitleColor

    image.png

    timeoutAlertMessageColor

    image.png

    timeoutAlertConfirmationColor

    image.png

    verifyLoadingColor

    image.png

    検証NetworkErrorAlertTitleColor

    image.png

    ネットワークエラー警告の確認メッセージ色

    image.png

    ネットワークエラーアラートのキャンセル色の確認

    image.png

    verifyNetworkErrorAlert確認色

    image.png

    ocrModule

    exitIconBase64

    image.png

    ocrTitleColor

    image.png

    ocr境界線の色色

    image.png

    albumBase64

    image.png

    takePhotoBase64

    image.png

    submitBase64

    image.png

    ocrSubmitTitleColor

    image.png

    ocrLoadingColor

    image.png

    ocrNetworkErrorAlertTitleColor

    image.png

    ocrNetworkErrorAlertMessage色

    image.png

    ocrNetworkErrorAlertCancelColor

    image.png

    ocrNetworkErrorAlertConfirm色

    image.png

    権限失敗アラートタイトルの色

    image.png

    権限失敗アラートメッセージ色

    image.png

    権限失敗アラート確認色

    image.png

    ドキュメントエラーアラートタイトルの色

    image.png

    docErrorAlertメッセージ色

    image.png

    ドキュメントエラーアラートキャンセル色

    image.png

    ドキュメントエラーアラート確認色

    image.png

    失敗アラートのタイトルの色

    image.png

    失敗アラートメッセージの色

    image.png

    失敗アラート確認色

    image.png

    失敗アラートのキャンセル色

    image.png

    制限のアラートタイトルの色

    image.png

    制限のアラートメッセージの色

    image.png

    制限アラート確認色

    image.png

    タイムアウトアラートタイトルの色

    image.png

    timeoutAlertMessageColor

    image.png

    timeoutAlertConfirmationColor

    image.png

    終了アラートのタイトルの色

    image.png

    終了アラートのキャンセル色

    image.png

    終了アラート確認色

    image.png

    OCR 結果終了アイコン Base64

    image.png

    OCR 結果タイトルの色

    image.png

    OCR 結果ヒントの背景色

    image.png

    ocr結果ヒントの色

    image.png

    OCR 結果情報タイトルの色

    image.png

    OCR 結果情報コンテンツの色

    image.png

    OCR 結果確認ボタン有効時の背景色

    image.png

    OCR 結果確認ボタン有効時のタイトルの色

    image.png

    OCR 結果ヒントタイトルの色

    image.png

    OCR 結果ヒントアイコン Base64

    image.png

    ocrResultErrorTipBGColor

    image.png

    ocrResultInfoborderColor

    image.png

    OCR 結果確認ボタン無効時の背景色

    image.png

    OCR 結果確認ボタン無効時のタイトルの色

    image.png

    OCR結果終了アラートタイトルの色

    image.png

    OCR 結果終了アラートキャンセル色

    image.png

    OCR結果終了アラート確認色

    image.png

    OCR 結果ネットワークエラー警告タイトルの色

    image.png

    OCR 結果ネットワークエラーアラートメッセージ色

    image.png

    OCR 結果ネットワークエラー警告確認色

    image.png

    OCR 結果情報エラーアラートメッセージ色

    image.png

    OCR 結果情報エラーアラート確認色

    image.png

    OCR 結果読み込み色

    image.png