java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.faceid.v20180301.models.DetectAuthRequest

public class DetectAuthRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor	Description
`DetectAuthRequest()`
`DetectAuthRequest(DetectAuthRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RuleIdConfig`	`getConfig()`	Get RuleId相关配置
`Encryption`	`getEncryption()`	Get 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
`String`	`getExtra()`	Get 透传字段，在获取验证结果时返回。
`String`	`getIdCard()`	Get 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
`String`	`getImageBase64()`	Get 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
`IntentionActionConfig[]`	`getIntentionActions()`	Get 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
`IntentionQuestion[]`	`getIntentionQuestions()`	Get 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
`String`	`getIntentionVerifyText()`	Get 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
`String`	`getName()`	Get 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
`String`	`getRedirectUrl()`	Get 认证结束后重定向的回调链接地址。最长长度1024位。
`String`	`getRuleId()`	Get 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
`String`	`getTerminalType()`	Get 本接口不需要传递此参数。
`void`	`setConfig(RuleIdConfig Config)`	Set RuleId相关配置
`void`	`setEncryption(Encryption Encryption)`	Set 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
`void`	`setExtra(String Extra)`	Set 透传字段，在获取验证结果时返回。
`void`	`setIdCard(String IdCard)`	Set 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
`void`	`setImageBase64(String ImageBase64)`	Set 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
`void`	`setIntentionActions(IntentionActionConfig[] IntentionActions)`	Set 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
`void`	`setIntentionQuestions(IntentionQuestion[] IntentionQuestions)`	Set 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
`void`	`setIntentionVerifyText(String IntentionVerifyText)`	Set 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
`void`	`setName(String Name)`	Set 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
`void`	`setRedirectUrl(String RedirectUrl)`	Set 认证结束后重定向的回调链接地址。最长长度1024位。
`void`	`setRuleId(String RuleId)`	Set 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
`void`	`setTerminalType(String TerminalType)`	Set 本接口不需要传递此参数。
`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
  - DetectAuthRequest
```
public DetectAuthRequest()
```
  - DetectAuthRequest
```
public DetectAuthRequest(DetectAuthRequest 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
  - getRuleId
```
public String getRuleId()
```
    Get 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
    
    Returns:
    
    RuleId 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
  - setRuleId
```
public void setRuleId(String RuleId)
```
    Set 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
    
    Parameters:
    
    RuleId - 用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。
  - getTerminalType
```
public String getTerminalType()
```
    Get 本接口不需要传递此参数。
    
    Returns:
    
    TerminalType 本接口不需要传递此参数。
  - setTerminalType
```
public void setTerminalType(String TerminalType)
```
    Set 本接口不需要传递此参数。
    
    Parameters:
    
    TerminalType - 本接口不需要传递此参数。
  - getIdCard
```
public String getIdCard()
```
    Get 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
    
    Returns:
    
    IdCard 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
  - setIdCard
```
public void setIdCard(String IdCard)
```
    Set 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
    
    Parameters:
    
    IdCard - 身份标识（未使用OCR服务时，必须传入）。规则：a-zA-Z0-9组合。最长长度32位。
  - getName
```
public String getName()
```
    Get 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
    
    Returns:
    
    Name 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
  - setName
```
public void setName(String Name)
```
    Set 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
    
    Parameters:
    
    Name - 姓名。（未使用OCR服务时，必须传入）最长长度32位。中文请使用UTF-8编码。
  - getRedirectUrl
```
public String getRedirectUrl()
```
    Get 认证结束后重定向的回调链接地址。最长长度1024位。
    
    Returns:
    
    RedirectUrl 认证结束后重定向的回调链接地址。最长长度1024位。
  - setRedirectUrl
```
public void setRedirectUrl(String RedirectUrl)
```
    Set 认证结束后重定向的回调链接地址。最长长度1024位。
    
    Parameters:
    
    RedirectUrl - 认证结束后重定向的回调链接地址。最长长度1024位。
  - getExtra
```
public String getExtra()
```
    Get 透传字段，在获取验证结果时返回。
    
    Returns:
    
    Extra 透传字段，在获取验证结果时返回。
  - setExtra
```
public void setExtra(String Extra)
```
    Set 透传字段，在获取验证结果时返回。
    
    Parameters:
    
    Extra - 透传字段，在获取验证结果时返回。
  - getImageBase64
```
public String getImageBase64()
```
    Get 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
    
    Returns:
    
    ImageBase64 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
  - setImageBase64
```
public void setImageBase64(String ImageBase64)
```
    Set 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
    
    Parameters:
    
    ImageBase64 - 用于人脸比对的照片，图片的Base64值； Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。
  - getEncryption
```
public Encryption getEncryption()
```
    Get 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
    
    Returns:
    
    Encryption 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
  - setEncryption
```
public void setEncryption(Encryption Encryption)
```
    Set 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
    
    Parameters:
    
    Encryption - 敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。
  - getIntentionVerifyText
```
public String getIntentionVerifyText()
```
    Get 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
    
    Returns:
    
    IntentionVerifyText 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
  - setIntentionVerifyText
```
public void setIntentionVerifyText(String IntentionVerifyText)
```
    Set 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
    
    Parameters:
    
    IntentionVerifyText - 意愿核身（朗读模式）使用的文案，若未使用意愿核身（朗读模式），则该字段无需传入。默认为空，最长可接受120的字符串长度。
  - getIntentionQuestions
```
public IntentionQuestion[] getIntentionQuestions()
```
    Get 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
    
    Returns:
    
    IntentionQuestions 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
  - setIntentionQuestions
```
public void setIntentionQuestions(IntentionQuestion[] IntentionQuestions)
```
    Set 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
    
    Parameters:
    
    IntentionQuestions - 意愿核身语音问答模式（即语音播报+语音回答）使用的文案，包括：系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
  - getConfig
```
public RuleIdConfig getConfig()
```
    Get RuleId相关配置
    
    Returns:
    
    Config RuleId相关配置
  - setConfig
```
public void setConfig(RuleIdConfig Config)
```
    Set RuleId相关配置
    
    Parameters:
    
    Config - RuleId相关配置
  - getIntentionActions
```
public IntentionActionConfig[] getIntentionActions()
```
    Get 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
    
    Returns:
    
    IntentionActions 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
  - setIntentionActions
```
public void setIntentionActions(IntentionActionConfig[] IntentionActions)
```
    Set 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
    
    Parameters:
    
    IntentionActions - 意愿核身（点头确认模式）使用的文案，若未使用意愿核身（点头确认模式），则该字段无需传入。当前仅支持一个提示文本。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class DetectAuthRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DetectAuthRequest

DetectAuthRequest

Method Detail

getRuleId

setRuleId

getTerminalType

setTerminalType

getIdCard

setIdCard

getName

setName

getRedirectUrl

setRedirectUrl

getExtra

setExtra

getImageBase64

setImageBase64

getEncryption

setEncryption

getIntentionVerifyText

setIntentionVerifyText

getIntentionQuestions

setIntentionQuestions

getConfig

setConfig

getIntentionActions

setIntentionActions

toMap