com.tencentcloudapi.ocr.v20181119.models

Class RecognizeValidIDCardOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.RecognizeValidIDCardOCRRequest

public class RecognizeValidIDCardOCRRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RecognizeValidIDCardOCRRequest()
RecognizeValidIDCardOCRRequest(RecognizeValidIDCardOCRRequest 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	getCardType() Get 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。
Boolean	getEnableBorderCheck() Get 默认值为false，打开返回边缘完整性判断。
Boolean	getEnableCopyCheck() Get 默认值为false，打开返回证件是否存在复印。
Boolean	getEnableCropImage() Get 默认值为false，打开返回证件主体切图。
Boolean	getEnableElectronCheck() Get 默认值为false，打开返回是否存在电子身份证判断。
Boolean	getEnableOcclusionCheck() Get 默认值为false，打开返回证件是否被遮挡。
Boolean	getEnablePortrait() Get 默认值为false，打开返回证件头像切图。
Boolean	getEnablePSCheck() Get 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效
Boolean	getEnableQualityCheck() Get 默认值为false，打开返回证件是否模糊。
Boolean	getEnableReshootCheck() Get 默认值为false，打开返回证件是否存在屏幕翻拍。
Boolean	getEnableWordCheck() Get 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效
String	getImageBase64() Get 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
String	getImageUrl() Get 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。
void	setCardType(Long CardType) Set 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。
void	setEnableBorderCheck(Boolean EnableBorderCheck) Set 默认值为false，打开返回边缘完整性判断。
void	setEnableCopyCheck(Boolean EnableCopyCheck) Set 默认值为false，打开返回证件是否存在复印。
void	setEnableCropImage(Boolean EnableCropImage) Set 默认值为false，打开返回证件主体切图。
void	setEnableElectronCheck(Boolean EnableElectronCheck) Set 默认值为false，打开返回是否存在电子身份证判断。
void	setEnableOcclusionCheck(Boolean EnableOcclusionCheck) Set 默认值为false，打开返回证件是否被遮挡。
void	setEnablePortrait(Boolean EnablePortrait) Set 默认值为false，打开返回证件头像切图。
void	setEnablePSCheck(Boolean EnablePSCheck) Set 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效
void	setEnableQualityCheck(Boolean EnableQualityCheck) Set 默认值为false，打开返回证件是否模糊。
void	setEnableReshootCheck(Boolean EnableReshootCheck) Set 默认值为false，打开返回证件是否存在屏幕翻拍。
void	setEnableWordCheck(Boolean EnableWordCheck) Set 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效
void	setImageBase64(String ImageBase64) Set 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
void	setImageUrl(String ImageUrl) Set 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。
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

RecognizeValidIDCardOCRRequest

public RecognizeValidIDCardOCRRequest()

RecognizeValidIDCardOCRRequest

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

getImageBase64

public String getImageBase64()

Get 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Returns:

ImageBase64 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

setImageBase64

public void setImageBase64(String ImageBase64)

Set 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

Parameters:

ImageBase64 - 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。

getImageUrl

public String getImageUrl()

Get 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。

Returns:

ImageUrl 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。

setImageUrl

public void setImageUrl(String ImageUrl)

Set 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。

Parameters:

ImageUrl - 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。

getCardType

public Long getCardType()

Get 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。

Returns:

CardType 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。

setCardType

public void setCardType(Long CardType)

Set 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。

Parameters:

CardType - 0 自动，自动判断输入证件的类型 1 身份证人像面，指定输入证件类型为二代身份证人像面 2 身份证国徽面，指定输入证件类型为二代身份证国徽面 3 身份证人像国徽面，指定输入证件类型为二代身份证人像面或者国徽面 4 临时身份证人像面，指定输入证件类型为临时身份证人像面 5 临时身份证国徽面，指定输入证件类型为临时身份证国徽面 6 临时身份证人像国徽面，指定输入证件类型为临时身份证人像面或者国徽面 7 港澳台居住证人像面，指定输入证件类型为港澳台居住证人像面 8 港澳台居住证国徽面，指定输入证件类型为港澳台居住证国徽面 9 港澳台居住证人像国徽面，指定输入证件类型为港澳台居住证人像面或者国徽面 10 外国人永久居留身份证人像面，指定输入证件类型为外国人永久居留证人像面 11 外国人永久居留身份证国徽面，指定输入证件类型为外国人永久居留证国徽面 12 外国人永久居留身份证人像国徽面，指定输入证件类型为外国人永久居留证人像或者国徽面 该参数如果不填，将为您自动判断卡证类型。

getEnablePortrait

public Boolean getEnablePortrait()

Get 默认值为false，打开返回证件头像切图。

Returns:

EnablePortrait 默认值为false，打开返回证件头像切图。

setEnablePortrait

public void setEnablePortrait(Boolean EnablePortrait)

Set 默认值为false，打开返回证件头像切图。

Parameters:

EnablePortrait - 默认值为false，打开返回证件头像切图。

getEnableCropImage

public Boolean getEnableCropImage()

Get 默认值为false，打开返回证件主体切图。

Returns:

EnableCropImage 默认值为false，打开返回证件主体切图。

setEnableCropImage

public void setEnableCropImage(Boolean EnableCropImage)

Set 默认值为false，打开返回证件主体切图。

Parameters:

EnableCropImage - 默认值为false，打开返回证件主体切图。

getEnableBorderCheck

public Boolean getEnableBorderCheck()

Get 默认值为false，打开返回边缘完整性判断。

Returns:

EnableBorderCheck 默认值为false，打开返回边缘完整性判断。

setEnableBorderCheck

public void setEnableBorderCheck(Boolean EnableBorderCheck)

Set 默认值为false，打开返回边缘完整性判断。

Parameters:

EnableBorderCheck - 默认值为false，打开返回边缘完整性判断。

getEnableOcclusionCheck

public Boolean getEnableOcclusionCheck()

Get 默认值为false，打开返回证件是否被遮挡。

Returns:

EnableOcclusionCheck 默认值为false，打开返回证件是否被遮挡。

setEnableOcclusionCheck

public void setEnableOcclusionCheck(Boolean EnableOcclusionCheck)

Set 默认值为false，打开返回证件是否被遮挡。

Parameters:

EnableOcclusionCheck - 默认值为false，打开返回证件是否被遮挡。

getEnableCopyCheck

public Boolean getEnableCopyCheck()

Get 默认值为false，打开返回证件是否存在复印。

Returns:

EnableCopyCheck 默认值为false，打开返回证件是否存在复印。

setEnableCopyCheck

public void setEnableCopyCheck(Boolean EnableCopyCheck)

Set 默认值为false，打开返回证件是否存在复印。

Parameters:

EnableCopyCheck - 默认值为false，打开返回证件是否存在复印。

getEnableReshootCheck

public Boolean getEnableReshootCheck()

Get 默认值为false，打开返回证件是否存在屏幕翻拍。

Returns:

EnableReshootCheck 默认值为false，打开返回证件是否存在屏幕翻拍。

setEnableReshootCheck

public void setEnableReshootCheck(Boolean EnableReshootCheck)

Set 默认值为false，打开返回证件是否存在屏幕翻拍。

Parameters:

EnableReshootCheck - 默认值为false，打开返回证件是否存在屏幕翻拍。

getEnablePSCheck

public Boolean getEnablePSCheck()

Get 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效

Returns:

EnablePSCheck 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效

setEnablePSCheck

public void setEnablePSCheck(Boolean EnablePSCheck)

Set 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效

Parameters:

EnablePSCheck - 默认值为false，打开返回证件是否存在PS。类型为：临时、港澳台居住证、外国人居住证失效

getEnableWordCheck

public Boolean getEnableWordCheck()

Get 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效

Returns:

EnableWordCheck 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效

setEnableWordCheck

public void setEnableWordCheck(Boolean EnableWordCheck)

Set 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效

Parameters:

EnableWordCheck - 默认值为false，打开返回字段级反光和字段级完整性告警。类型为：临时、港澳台居住证、外国人居住证失效

getEnableQualityCheck

public Boolean getEnableQualityCheck()

Get 默认值为false，打开返回证件是否模糊。

Returns:

EnableQualityCheck 默认值为false，打开返回证件是否模糊。

setEnableQualityCheck

public void setEnableQualityCheck(Boolean EnableQualityCheck)

Set 默认值为false，打开返回证件是否模糊。

Parameters:

EnableQualityCheck - 默认值为false，打开返回证件是否模糊。

getEnableElectronCheck

public Boolean getEnableElectronCheck()

Get 默认值为false，打开返回是否存在电子身份证判断。

Returns:

EnableElectronCheck 默认值为false，打开返回是否存在电子身份证判断。

setEnableElectronCheck

public void setEnableElectronCheck(Boolean EnableElectronCheck)

Set 默认值为false，打开返回是否存在电子身份证判断。

Parameters:

EnableElectronCheck - 默认值为false，打开返回是否存在电子身份证判断。

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.