com.tencentcloudapi.faceid.v20180301.models

Class ApplySdkVerificationTokenRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.ApplySdkVerificationTokenRequest

public class ApplySdkVerificationTokenRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ApplySdkVerificationTokenRequest()
ApplySdkVerificationTokenRequest(ApplySdkVerificationTokenRequest 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
String	getActionList() Get This interface is used to control th action sequences.
Long	getCheckMode() Get The verification mode.
String	getCompareImage() Get The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.
Boolean	getDisableChangeOcrResult() Get Whether to forbid the modification of the OCR result by users.
Boolean	getDisableCheckOcrWarnings() Get Whether to disable the OCR warnings.
String	getExtra() Get A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.
String	getIdCardType() Get Specifies the identity document type used for authentication.
Boolean	getNeedVerifyIdCard() Deprecated.
String	getSdkVersion() Get ENHANCED: enhanced.
Long	getSecurityLevel() Get The security level of the verification.
Long[]	getSelectedWarningCodes() Get Customize which alarm codes to block.
void	setActionList(String ActionList) Set This interface is used to control th action sequences.
void	setCheckMode(Long CheckMode) Set The verification mode.
void	setCompareImage(String CompareImage) Set The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.
void	setDisableChangeOcrResult(Boolean DisableChangeOcrResult) Set Whether to forbid the modification of the OCR result by users.
void	setDisableCheckOcrWarnings(Boolean DisableCheckOcrWarnings) Set Whether to disable the OCR warnings.
void	setExtra(String Extra) Set A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.
void	setIdCardType(String IdCardType) Set Specifies the identity document type used for authentication.
void	setNeedVerifyIdCard(Boolean NeedVerifyIdCard) Deprecated.
void	setSdkVersion(String SdkVersion) Set ENHANCED: enhanced.
void	setSecurityLevel(Long SecurityLevel) Set The security level of the verification.
void	setSelectedWarningCodes(Long[] SelectedWarningCodes) Set Customize which alarm codes to block.
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, isStream, 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

ApplySdkVerificationTokenRequest

public ApplySdkVerificationTokenRequest()

ApplySdkVerificationTokenRequest

public ApplySdkVerificationTokenRequest(ApplySdkVerificationTokenRequest 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

getCheckMode

public Long getCheckMode()

Get The verification mode. Valid values: 1: OCR + liveness detection + face comparison 2: Liveness detection + face comparison 3: Liveness detection Default value: 1

Returns:

CheckMode The verification mode. Valid values: 1: OCR + liveness detection + face comparison 2: Liveness detection + face comparison 3: Liveness detection Default value: 1

setCheckMode

public void setCheckMode(Long CheckMode)

Set The verification mode. Valid values: 1: OCR + liveness detection + face comparison 2: Liveness detection + face comparison 3: Liveness detection Default value: 1

Parameters:

CheckMode - The verification mode. Valid values: 1: OCR + liveness detection + face comparison 2: Liveness detection + face comparison 3: Liveness detection Default value: 1

getSecurityLevel

public Long getSecurityLevel()

Get The security level of the verification. Valid values: 1: Video-based liveness detection 2: Motion-based liveness detection 3: Reflection-based liveness detection 4: Motion- and reflection-based liveness detection Default value: 4

Returns:

SecurityLevel The security level of the verification. Valid values: 1: Video-based liveness detection 2: Motion-based liveness detection 3: Reflection-based liveness detection 4: Motion- and reflection-based liveness detection Default value: 4

setSecurityLevel

public void setSecurityLevel(Long SecurityLevel)

Set The security level of the verification. Valid values: 1: Video-based liveness detection 2: Motion-based liveness detection 3: Reflection-based liveness detection 4: Motion- and reflection-based liveness detection Default value: 4

Parameters:

SecurityLevel - The security level of the verification. Valid values: 1: Video-based liveness detection 2: Motion-based liveness detection 3: Reflection-based liveness detection 4: Motion- and reflection-based liveness detection Default value: 4

getIdCardType

public String getIdCardType()

Get Specifies the identity document type used for authentication. valid values:. HK (default): hong kong (china) identity card. 2. ML: malaysian identity card. Indonesian identity card. 4. PhilippinesVoteID: specifies the voter card in the philippines. 5. PhilippinesDrivingLicense: specifies the driving license in philippines. 6. PhilippinesTinID: specifies the philippines tin id. 7. PhilippinesSSSID: specifies the SSSID in the philippines. 8. philippines UMID: specifies the philippines UMID. 9. MLIDPassport: specifies the passport for hong kong (china), macao (china), and taiwan (china) as well as overseas passports. ThailandIDCard: specifies the thai identity card. Mainland id card. 12. SingaporeIDCard: specifies the Singapore id card. 13. HMTPermit: specifies the hong kong, macau and taiwan travel permit.

Returns:

IdCardType Specifies the identity document type used for authentication. valid values:. HK (default): hong kong (china) identity card. 2. ML: malaysian identity card. Indonesian identity card. 4. PhilippinesVoteID: specifies the voter card in the philippines. 5. PhilippinesDrivingLicense: specifies the driving license in philippines. 6. PhilippinesTinID: specifies the philippines tin id. 7. PhilippinesSSSID: specifies the SSSID in the philippines. 8. philippines UMID: specifies the philippines UMID. 9. MLIDPassport: specifies the passport for hong kong (china), macao (china), and taiwan (china) as well as overseas passports. ThailandIDCard: specifies the thai identity card. Mainland id card. 12. SingaporeIDCard: specifies the Singapore id card. 13. HMTPermit: specifies the hong kong, macau and taiwan travel permit.

setIdCardType

public void setIdCardType(String IdCardType)

Set Specifies the identity document type used for authentication. valid values:. HK (default): hong kong (china) identity card. 2. ML: malaysian identity card. Indonesian identity card. 4. PhilippinesVoteID: specifies the voter card in the philippines. 5. PhilippinesDrivingLicense: specifies the driving license in philippines. 6. PhilippinesTinID: specifies the philippines tin id. 7. PhilippinesSSSID: specifies the SSSID in the philippines. 8. philippines UMID: specifies the philippines UMID. 9. MLIDPassport: specifies the passport for hong kong (china), macao (china), and taiwan (china) as well as overseas passports. ThailandIDCard: specifies the thai identity card. Mainland id card. 12. SingaporeIDCard: specifies the Singapore id card. 13. HMTPermit: specifies the hong kong, macau and taiwan travel permit.

Parameters:

IdCardType - Specifies the identity document type used for authentication. valid values:. HK (default): hong kong (china) identity card. 2. ML: malaysian identity card. Indonesian identity card. 4. PhilippinesVoteID: specifies the voter card in the philippines. 5. PhilippinesDrivingLicense: specifies the driving license in philippines. 6. PhilippinesTinID: specifies the philippines tin id. 7. PhilippinesSSSID: specifies the SSSID in the philippines. 8. philippines UMID: specifies the philippines UMID. 9. MLIDPassport: specifies the passport for hong kong (china), macao (china), and taiwan (china) as well as overseas passports. ThailandIDCard: specifies the thai identity card. Mainland id card. 12. SingaporeIDCard: specifies the Singapore id card. 13. HMTPermit: specifies the hong kong, macau and taiwan travel permit.

getCompareImage

public String getCompareImage()

Get The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.

Returns:

CompareImage The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.

setCompareImage

public void setCompareImage(String CompareImage)

Set The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.

Parameters:

CompareImage - The Base64-encoded value of the photo to compare, which is required only when `CheckMode` is set to `2`.

getNeedVerifyIdCard

@Deprecated
public Boolean getNeedVerifyIdCard()

Deprecated.

Get Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.

Returns:

NeedVerifyIdCard Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.

setNeedVerifyIdCard

@Deprecated
public void setNeedVerifyIdCard(Boolean NeedVerifyIdCard)

Deprecated.

Set Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.

Parameters:

NeedVerifyIdCard - Whether ID card authentication is required. If not, only document OCR will be performed. Currently, authentication is available only when the value of `IdCardType` is `HK`.

getDisableChangeOcrResult

public Boolean getDisableChangeOcrResult()

Get Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)

Returns:

DisableChangeOcrResult Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)

setDisableChangeOcrResult

public void setDisableChangeOcrResult(Boolean DisableChangeOcrResult)

Set Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)

Parameters:

DisableChangeOcrResult - Whether to forbid the modification of the OCR result by users. Default value: `false` (modification allowed). (Currently, this parameter is not applied.)

getDisableCheckOcrWarnings

public Boolean getDisableCheckOcrWarnings()

Get Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning. This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.

Returns:

DisableCheckOcrWarnings Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning. This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.

setDisableCheckOcrWarnings

public void setDisableCheckOcrWarnings(Boolean DisableCheckOcrWarnings)

Set Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning. This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.

Parameters:

DisableCheckOcrWarnings - Whether to disable the OCR warnings. Default value: `false` (not disable), where OCR warnings are enabled and the OCR result will not be returned if there is a warning. This feature applies only to Hong Kong (China) identity cards, Malaysian identity cards, and passports.

getSelectedWarningCodes

public Long[] getSelectedWarningCodes()

Get Customize which alarm codes to block. If left blank, all alarm codes will be blocked by default. Optional alarm codes are: -9101 (occlusion or incomplete border), -9102 (photocopying), -9103 (screen capture by camera), -9104 (image editing/PS modification), -9107 (glare/reflection), -9108 (blurriness), -9901 (other alarms).

Returns:

SelectedWarningCodes Customize which alarm codes to block. If left blank, all alarm codes will be blocked by default. Optional alarm codes are: -9101 (occlusion or incomplete border), -9102 (photocopying), -9103 (screen capture by camera), -9104 (image editing/PS modification), -9107 (glare/reflection), -9108 (blurriness), -9901 (other alarms).

setSelectedWarningCodes

public void setSelectedWarningCodes(Long[] SelectedWarningCodes)

Set Customize which alarm codes to block. If left blank, all alarm codes will be blocked by default. Optional alarm codes are: -9101 (occlusion or incomplete border), -9102 (photocopying), -9103 (screen capture by camera), -9104 (image editing/PS modification), -9107 (glare/reflection), -9108 (blurriness), -9901 (other alarms).

Parameters:

SelectedWarningCodes - Customize which alarm codes to block. If left blank, all alarm codes will be blocked by default. Optional alarm codes are: -9101 (occlusion or incomplete border), -9102 (photocopying), -9103 (screen capture by camera), -9104 (image editing/PS modification), -9107 (glare/reflection), -9108 (blurriness), -9901 (other alarms).

getExtra

public String getExtra()

Get A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.

Returns:

Extra A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.

setExtra

public void setExtra(String Extra)

Set A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.

Parameters:

Extra - A passthrough field, which is returned together with the verification result and can contain up to 1,024 bits.

getSdkVersion

public String getSdkVersion()

Get ENHANCED: enhanced. BASIC: basic version (default).

Returns:

SdkVersion ENHANCED: enhanced. BASIC: basic version (default).

setSdkVersion

public void setSdkVersion(String SdkVersion)

Set ENHANCED: enhanced. BASIC: basic version (default).

Parameters:

SdkVersion - ENHANCED: enhanced. BASIC: basic version (default).

getActionList

public String getActionList()

Get This interface is used to control th action sequences. Action types are as follows: "blink" "mouth" "nod" "shake" You can choose 1-2 actions out of the four. Single action example: "blink" Multiple action example: "blink,mouth" The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error.

Returns:

ActionList This interface is used to control th action sequences. Action types are as follows: "blink" "mouth" "nod" "shake" You can choose 1-2 actions out of the four. Single action example: "blink" Multiple action example: "blink,mouth" The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error.

setActionList

public void setActionList(String ActionList)

Set This interface is used to control th action sequences. Action types are as follows: "blink" "mouth" "nod" "shake" You can choose 1-2 actions out of the four. Single action example: "blink" Multiple action example: "blink,mouth" The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error.

Parameters:

ActionList - This interface is used to control th action sequences. Action types are as follows: "blink" "mouth" "nod" "shake" You can choose 1-2 actions out of the four. Single action example: "blink" Multiple action example: "blink,mouth" The default value is blink. The different action types passed in this parameter take effect only when the SecurityLevel is 2 or 4; otherwise, the interface reports an error.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.