com.tencentcloudapi.faceid.v20180301.models

Class WebVerificationConfigIntl

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.WebVerificationConfigIntl

public class WebVerificationConfigIntl
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
WebVerificationConfigIntl()
WebVerificationConfigIntl(WebVerificationConfigIntl source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getAutoDowngrade() Get Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode.
Boolean	getAutoSkip() Get When the verification passed, whether to skip the result page and automatically jump to RedirectURL.
Boolean	getAutoSkipStartPage() Get When starting verification, whether to skip the starting verification page.
Long	getCheckMode() Get Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2.
Boolean	getDisableCheckOcrWarnings() Get Whether to turn off document alarms, the default is false (the alarm detection function is turned on).
Boolean	getIdCardCutReturn() Get The default value is false.
String	getIDCardType() Get The type of lisence used for verification.
String	getLanguage() Get International language, the default value is en (English).
Long	getSecurityLevel() Get Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3
Boolean	getSkipPrivacyPolicy() Get Whether to skip the agreement page, the default is false.
String	getThemeColor() Get Front-end theme color, in the format of RGB hexadecimal color code.
void	setAutoDowngrade(Long AutoDowngrade) Set Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode.
void	setAutoSkip(Boolean AutoSkip) Set When the verification passed, whether to skip the result page and automatically jump to RedirectURL.
void	setAutoSkipStartPage(Boolean AutoSkipStartPage) Set When starting verification, whether to skip the starting verification page.
void	setCheckMode(Long CheckMode) Set Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2.
void	setDisableCheckOcrWarnings(Boolean DisableCheckOcrWarnings) Set Whether to turn off document alarms, the default is false (the alarm detection function is turned on).
void	setIdCardCutReturn(Boolean IdCardCutReturn) Set The default value is false.
void	setIDCardType(String IDCardType) Set The type of lisence used for verification.
void	setLanguage(String Language) Set International language, the default value is en (English).
void	setSecurityLevel(Long SecurityLevel) Set Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3
void	setSkipPrivacyPolicy(Boolean SkipPrivacyPolicy) Set Whether to skip the agreement page, the default is false.
void	setThemeColor(String ThemeColor) Set Front-end theme color, in the format of RGB hexadecimal color code.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebVerificationConfigIntl

public WebVerificationConfigIntl()

WebVerificationConfigIntl

public WebVerificationConfigIntl(WebVerificationConfigIntl source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getAutoSkipStartPage

public Boolean getAutoSkipStartPage()

Get When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.

Returns:

AutoSkipStartPage When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.

setAutoSkipStartPage

public void setAutoSkipStartPage(Boolean AutoSkipStartPage)

Set When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.

Parameters:

AutoSkipStartPage - When starting verification, whether to skip the starting verification page. If true, enter the verification process directly. The default is false. This configuration will not take effect if the downgrade policy is triggered.

getAutoSkip

public Boolean getAutoSkip()

Get When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false. Example value: false

Returns:

AutoSkip When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false. Example value: false

setAutoSkip

public void setAutoSkip(Boolean AutoSkip)

Set When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false. Example value: false

Parameters:

AutoSkip - When the verification passed, whether to skip the result page and automatically jump to RedirectURL. The default value is false. Example value: false

getCheckMode

public Long getCheckMode()

Get Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2. Example value: 3

Returns:

CheckMode Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2. Example value: 3

setCheckMode

public void setCheckMode(Long CheckMode)

Set Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2. Example value: 3

Parameters:

CheckMode - Detection mode, parameter values are as follows: 1: OCR+living detection & face comparison; 2: Living detection & face comparison; 3: Living detection; The default value is 2. Example value: 3

getIDCardType

public String getIDCardType()

Get The type of lisence used for verification. The following types are supported. 1.HKIDCard: Hong Kong (China) ID card 2.MLIDCard: Malaysia ID card 3.IndonesiaIDCard: Indonesia ID card 4.PhilippinesVoteID: Philippines VoteID card 5.PhilippinesDrivingLicense: Philippines driving license 6.PhilippinesTinID: Philippines TinID card 7.PhilippinesSSSID: Philippines SSSID card 8.PhilippinesUMID: Philippines UMID card 9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport. Example: HKIDCard

Returns:

IDCardType The type of lisence used for verification. The following types are supported. 1.HKIDCard: Hong Kong (China) ID card 2.MLIDCard: Malaysia ID card 3.IndonesiaIDCard: Indonesia ID card 4.PhilippinesVoteID: Philippines VoteID card 5.PhilippinesDrivingLicense: Philippines driving license 6.PhilippinesTinID: Philippines TinID card 7.PhilippinesSSSID: Philippines SSSID card 8.PhilippinesUMID: Philippines UMID card 9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport. Example: HKIDCard

setIDCardType

public void setIDCardType(String IDCardType)

Set The type of lisence used for verification. The following types are supported. 1.HKIDCard: Hong Kong (China) ID card 2.MLIDCard: Malaysia ID card 3.IndonesiaIDCard: Indonesia ID card 4.PhilippinesVoteID: Philippines VoteID card 5.PhilippinesDrivingLicense: Philippines driving license 6.PhilippinesTinID: Philippines TinID card 7.PhilippinesSSSID: Philippines SSSID card 8.PhilippinesUMID: Philippines UMID card 9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport. Example: HKIDCard

Parameters:

IDCardType - The type of lisence used for verification. The following types are supported. 1.HKIDCard: Hong Kong (China) ID card 2.MLIDCard: Malaysia ID card 3.IndonesiaIDCard: Indonesia ID card 4.PhilippinesVoteID: Philippines VoteID card 5.PhilippinesDrivingLicense: Philippines driving license 6.PhilippinesTinID: Philippines TinID card 7.PhilippinesSSSID: Philippines SSSID card 8.PhilippinesUMID: Philippines UMID card 9.InternationalIDPassport: ID cards of Hong Kong, Macao and Taiwan (China), and international passport. Example: HKIDCard

getDisableCheckOcrWarnings

public Boolean getDisableCheckOcrWarnings()

Get Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.

Returns:

DisableCheckOcrWarnings Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.

setDisableCheckOcrWarnings

public void setDisableCheckOcrWarnings(Boolean DisableCheckOcrWarnings)

Set Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.

Parameters:

DisableCheckOcrWarnings - Whether to turn off document alarms, the default is false (the alarm detection function is turned on). When enabled, the identity authentication process will be intercepted based on the alarm status of the certificate. If you need to use the document authentication function, please contact us.

getSecurityLevel

public Long getSecurityLevel()

Get Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3

Returns:

SecurityLevel Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3

setSecurityLevel

public void setSecurityLevel(Long SecurityLevel)

Set Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3

Parameters:

SecurityLevel - Liveness security level: 1:Silent mode;2:Action mode;3:Lighting mode;4:Action+Lighting mode;default value is 3

getSkipPrivacyPolicy

public Boolean getSkipPrivacyPolicy()

Get Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.

Returns:

SkipPrivacyPolicy Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.

setSkipPrivacyPolicy

public void setSkipPrivacyPolicy(Boolean SkipPrivacyPolicy)

Set Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.

Parameters:

SkipPrivacyPolicy - Whether to skip the agreement page, the default is false. When SkipPrivacyPolicy is false, the agreement page will be displayed and the privacy agreement needs to be checked; when SkipPrivacyPolicy is true, the agreement page will be skipped and the liveness process will be entered directly without checking the privacy agreement page.

getIdCardCutReturn

public Boolean getIdCardCutReturn()

Get The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.

Returns:

IdCardCutReturn The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.

setIdCardCutReturn

public void setIdCardCutReturn(Boolean IdCardCutReturn)

Set The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.

Parameters:

IdCardCutReturn - The default value is false. If it is false, the original ID image will be displayed. If it is true, the cut ID image will be displayed.

getThemeColor

public String getThemeColor()

Get Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.

Returns:

ThemeColor Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.

setThemeColor

public void setThemeColor(String ThemeColor)

Set Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.

Parameters:

ThemeColor - Front-end theme color, in the format of RGB hexadecimal color code. The default value is "#2d72+1". If the format is incorrect, the default value color will be used.

getLanguage

public String getLanguage()

Get International language, the default value is en (English). Currently supported: th: Thai; en: English;

Returns:

Language International language, the default value is en (English). Currently supported: th: Thai; en: English;

setLanguage

public void setLanguage(String Language)

Set International language, the default value is en (English). Currently supported: th: Thai; en: English;

Parameters:

Language - International language, the default value is en (English). Currently supported: th: Thai; en: English;

getAutoDowngrade

public Long getAutoDowngrade()

Get Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.

Returns:

AutoDowngrade Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.

setAutoDowngrade

public void setAutoDowngrade(Long AutoDowngrade)

Set Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.

Parameters:

AutoDowngrade - Automatic downgrade mode, with the following parameter values: 1: Downgrade to silent live mode; 2: Disable downgrade mode. The default value is 1.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel