The ID Verification iOS SDK provides the setCustomUI interface to customize UI colors and icons. Pass a configuration file or JSON string to apply your customizations.
Some customizations may require an SDK upgrade. Upgrade to the latest version before use. If UI custom settings conflict with authentication interface extension parameters, the UI settings take precedence.
Interface description
Interface definition
The iOS SDK provides the setCustomUI interface to customize UI colors and icons.
/**
* Set custom UI colors and icons
*
* 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;
Request parameters
|
Name |
Type |
Description |
|
configuration |
NSString |
Custom UI configuration in JSON format. |
|
completeBlock |
block |
The result callback.
|
Sample code
NSString *jsonString = @"{\"faceConfig\":{\"exitIconBase64\":\"data:image/png;base64,iVBORw0..\"}}";
[[AliyunIdentityPlatform sharedInstance] setCustomUI:@"" complete:^(BOOL success, NSError * _Nullable error) {
NSLog(@"%@",error.localizedDescription);
}];
Configuration fields
Full configuration example
{
"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"
}
}
Field configuration effects
faceModule
|
faceBGColor
|
exitIconBase64
|
faceTitleColor
|
|
faceTipColor
|
interruptedAlertTitleColor
|
interruptedAlertMessageColor
|
|
interruptedAlertConfirmColor
|
permissionFailedAlertTitleColor
|
permissionFailedAlertMessageColor
|
|
permissionFailedAlertConfirmColor
|
tooManyRetriesAlertTitleColor
|
tooManyRetriesAlertMessageColor
|
|
tooManyRetriesAlertConfirmColor
|
faceProgressEndColor
|
exitAlertTitleColor
|
|
exitAlertMessageColor
|
exitAlertCancelColor
|
exitAlertConfirmationColor
|
|
timeoutAlertTitleColor
|
timeoutAlertMessageColor
|
timeoutAlertConfirmationColor
|
|
verifyLoadingColor
|
verifyNetworkErrorAlertTitleColor
|
verifyNetworkErrorAlertMessageColor
|
|
verifyNetworkErrorAlertCancelColor
|
verifyNetworkErrorAlertConfirmColor
|
ocrModule
|
exitIconBase64 |
ocrTitleColor |
ocrBorderColor |
|
albumBase64 |
takePhotoBase64 |
submitBase64 |
|
ocrSubmitTitleColor |
ocrLoadingColor |
ocrNetworkErrorAlertTitleColor |
|
ocrNetworkErrorAlertMessageColor |
ocrNetworkErrorAlertCancelColor |
ocrNetworkErrorAlertConfirmColor |
|
permissionFailedAlertTitleColor |
permissionFailedAlertMessageColor |
permissionFailedAlertConfirmColor |
|
docErrorAlertTitleColor |
docErrorAlertMessageColor |
docErrorAlertCancelColor |
|
docErrorAlertConfirmColor |
failedAlertTitleColor |
failedAlertMessageColor |
|
failedAlertConfirmationColor |
failedAlertCancelColor |
restrictionsAlertTitleColor |
|
restrictionsAlertMessageColor |
restrictionsAlertConfirmationColor |
timeoutAlertTitleColor |
|
timeoutAlertMessageColor |
timeoutAlertConfirmationColor |
exitAlertTitleColor |
|
exitAlertCancelColor |
exitAlertConfirmationColor |
ocrResultExitIconBase64 |
|
ocrResultTitleColor |
ocrResultTipBGColor |
ocrResultTipColor |
|
ocrResultInfoTitleColor |
ocrResultInfoContentColor |
ocrResultConfirmBtnEnabledBGColor |
|
ocrResultConfirmBtnEnabledTitleColor |
ocrResultTipTitleColor |
ocrResultTipIconBase64 |
|
ocrResultErrorTipBGColor |
ocrResultInfoborderColor |
ocrResultConfirmBtnDisabledBGColor |
|
ocrResultConfirmBtnDisabledTitleColor |
ocrResultExitAlertTitleColor |
ocrResultExitAlertCancelColor |
|
ocrResultExitAlertConfirmationColor |
ocrResultNetworkErrorAlertTitleColor |
ocrResultNetworkErrorAlertMessageColor |
|
ocrResultNetworkErrorAlertConfirmColor |
ocrResultInfoErrorAlertMessageColor |
ocrResultInfoErrorAlertConfirmColor |
|
ocrResultLoadingColor |
ocrGuideExitIconBase64 |
ocrGuideTitleColor |
|
ocrGuideContentColor |
ocrGuideStartBtnTextColor |
ocrGuideStartBtnBGColor |
|
ocrGuideIndicatorUnSelectedColor |
ocrGuideIndicatorSelectedColor |
nfcTitleColor |
|
nfcContentColor |
nfcConfirmBtnBGColor |
nfcConfirmBtnTextColor |
|
nfcInputCheckAlertMessageColor |
nfcInputCheckAlertConfirmColor |
nfcInputPassportEditHintColor |
|
nfcInputBirthdayEditHintColor |
nfcInputValidityEditHintColor |
nfcInputPassportLabelColor |
|
nfcInputBirthdayLabelColor |
nfcInputValidityLabelColor |
nfcInputBirthdayEditColor |
|
nfcInputValidityEditColor |
nfcInputPassportEditColor |
nfcInputTitleColor |
|
nfcInputBackAlertTitleColor |
nfcInputBackAlertCancelColor |
nfcInputBackAlertConfirmColor |
|
nfcInputNextBtnTextSelectColor |
nfcInputNextBtnBGSelectColor |
nfcReadBackAlertTitleColor |
|
nfcReadBackAlertConfirmColor |
nfcReadBackAlertCancelColor |
ocrAlbumLabelColor |
|
ocrTakePhotoLabelColor |
ocrGuideStartBtnDisableTextColor |
ocrGuideStartBtnDisableBGColor |



















































































































