com.tencentcloudapi.ocr.v20181119.models

Class IDCardOCRResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.IDCardOCRResponse

public class IDCardOCRResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
IDCardOCRResponse()
IDCardOCRResponse(IDCardOCRResponse 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	getAddress() Get Address (profile photo side)
String	getAdvancedInfo() Get Extended information, which will be returned only when requested.
String	getAuthority() Get Issuing authority (national emblem side)
String	getBirth() Get Date of birth (profile photo side)
String	getIdNum() Get ID number (profile photo side)
String	getName() Get Name (profile photo side)
String	getNation() Get Ethnicity (profile photo side)
String	getRequestId() Get The unique request ID, which is returned for each request.
String	getSex() Get Gender (profile photo side)
String	getValidDate() Get Validity period (national emblem side)
void	setAddress(String Address) Set Address (profile photo side)
void	setAdvancedInfo(String AdvancedInfo) Set Extended information, which will be returned only when requested.
void	setAuthority(String Authority) Set Issuing authority (national emblem side)
void	setBirth(String Birth) Set Date of birth (profile photo side)
void	setIdNum(String IdNum) Set ID number (profile photo side)
void	setName(String Name) Set Name (profile photo side)
void	setNation(String Nation) Set Ethnicity (profile photo side)
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setSex(String Sex) Set Gender (profile photo side)
void	setValidDate(String ValidDate) Set Validity period (national emblem side)
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

IDCardOCRResponse

public IDCardOCRResponse()

IDCardOCRResponse

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

getName

public String getName()

Get Name (profile photo side)

Returns:

Name Name (profile photo side)

setName

public void setName(String Name)

Set Name (profile photo side)

Parameters:

Name - Name (profile photo side)

getSex

public String getSex()

Get Gender (profile photo side)

Returns:

Sex Gender (profile photo side)

setSex

public void setSex(String Sex)

Set Gender (profile photo side)

Parameters:

Sex - Gender (profile photo side)

getNation

public String getNation()

Get Ethnicity (profile photo side)

Returns:

Nation Ethnicity (profile photo side)

setNation

public void setNation(String Nation)

Set Ethnicity (profile photo side)

Parameters:

Nation - Ethnicity (profile photo side)

getBirth

public String getBirth()

Get Date of birth (profile photo side)

Returns:

Birth Date of birth (profile photo side)

setBirth

public void setBirth(String Birth)

Set Date of birth (profile photo side)

Parameters:

Birth - Date of birth (profile photo side)

getAddress

public String getAddress()

Get Address (profile photo side)

Returns:

Address Address (profile photo side)

setAddress

public void setAddress(String Address)

Set Address (profile photo side)

Parameters:

Address - Address (profile photo side)

getIdNum

public String getIdNum()

Get ID number (profile photo side)

Returns:

IdNum ID number (profile photo side)

setIdNum

public void setIdNum(String IdNum)

Set ID number (profile photo side)

Parameters:

IdNum - ID number (profile photo side)

getAuthority

public String getAuthority()

Get Issuing authority (national emblem side)

Returns:

Authority Issuing authority (national emblem side)

setAuthority

public void setAuthority(String Authority)

Set Issuing authority (national emblem side)

Parameters:

Authority - Issuing authority (national emblem side)

getValidDate

public String getValidDate()

Get Validity period (national emblem side)

Returns:

ValidDate Validity period (national emblem side)

setValidDate

public void setValidDate(String ValidDate)

Set Validity period (national emblem side)

Parameters:

ValidDate - Validity period (national emblem side)

getAdvancedInfo

public String getAdvancedInfo()

Get Extended information, which will be returned only when requested. For the input parameters, please see example 3 and example 4. `IdCard`: Base64-encoded content of the cropped ID card photo, which will be returned if `Config.CropIdCard` is set to `true`. `Portrait`: Base64-encoded content of the ID photo on the card, which will be returned if `Config.CropPortrait` is set to `true`. `Quality`: Image quality score, which will be returned if `Config.Quality` is set to `true`. Value range: 0–100. The lower the score, the blurrier the image. The recommended threshold is ≥ 50. `BorderCodeValue`: Warning threshold score for incomplete ID card borders, which will be returned if `Config.BorderCheckWarn` is set to `true`. Value range: 0–100. The lower the score, the lower the probability of border occlusion. The recommended threshold value is ≤ 50. `WarnInfos`: Warning information. Warning codes and descriptions are as follows: -9100: The ID card validity period is invalid. -9101: The ID card borders are incomplete. -9102: The ID card image is photocopied. -9103: The ID card image is spoofed. -9104: The ID card is a temporary one. -9105: The ID card frame is occluded. -9106: The ID card image is photoshopped. -9107: The ID card image has glares.

Returns:

AdvancedInfo Extended information, which will be returned only when requested. For the input parameters, please see example 3 and example 4. `IdCard`: Base64-encoded content of the cropped ID card photo, which will be returned if `Config.CropIdCard` is set to `true`. `Portrait`: Base64-encoded content of the ID photo on the card, which will be returned if `Config.CropPortrait` is set to `true`. `Quality`: Image quality score, which will be returned if `Config.Quality` is set to `true`. Value range: 0–100. The lower the score, the blurrier the image. The recommended threshold is ≥ 50. `BorderCodeValue`: Warning threshold score for incomplete ID card borders, which will be returned if `Config.BorderCheckWarn` is set to `true`. Value range: 0–100. The lower the score, the lower the probability of border occlusion. The recommended threshold value is ≤ 50. `WarnInfos`: Warning information. Warning codes and descriptions are as follows: -9100: The ID card validity period is invalid. -9101: The ID card borders are incomplete. -9102: The ID card image is photocopied. -9103: The ID card image is spoofed. -9104: The ID card is a temporary one. -9105: The ID card frame is occluded. -9106: The ID card image is photoshopped. -9107: The ID card image has glares.

setAdvancedInfo

public void setAdvancedInfo(String AdvancedInfo)

Set Extended information, which will be returned only when requested. For the input parameters, please see example 3 and example 4. `IdCard`: Base64-encoded content of the cropped ID card photo, which will be returned if `Config.CropIdCard` is set to `true`. `Portrait`: Base64-encoded content of the ID photo on the card, which will be returned if `Config.CropPortrait` is set to `true`. `Quality`: Image quality score, which will be returned if `Config.Quality` is set to `true`. Value range: 0–100. The lower the score, the blurrier the image. The recommended threshold is ≥ 50. `BorderCodeValue`: Warning threshold score for incomplete ID card borders, which will be returned if `Config.BorderCheckWarn` is set to `true`. Value range: 0–100. The lower the score, the lower the probability of border occlusion. The recommended threshold value is ≤ 50. `WarnInfos`: Warning information. Warning codes and descriptions are as follows: -9100: The ID card validity period is invalid. -9101: The ID card borders are incomplete. -9102: The ID card image is photocopied. -9103: The ID card image is spoofed. -9104: The ID card is a temporary one. -9105: The ID card frame is occluded. -9106: The ID card image is photoshopped. -9107: The ID card image has glares.

Parameters:

AdvancedInfo - Extended information, which will be returned only when requested. For the input parameters, please see example 3 and example 4. `IdCard`: Base64-encoded content of the cropped ID card photo, which will be returned if `Config.CropIdCard` is set to `true`. `Portrait`: Base64-encoded content of the ID photo on the card, which will be returned if `Config.CropPortrait` is set to `true`. `Quality`: Image quality score, which will be returned if `Config.Quality` is set to `true`. Value range: 0–100. The lower the score, the blurrier the image. The recommended threshold is ≥ 50. `BorderCodeValue`: Warning threshold score for incomplete ID card borders, which will be returned if `Config.BorderCheckWarn` is set to `true`. Value range: 0–100. The lower the score, the lower the probability of border occlusion. The recommended threshold value is ≤ 50. `WarnInfos`: Warning information. Warning codes and descriptions are as follows: -9100: The ID card validity period is invalid. -9101: The ID card borders are incomplete. -9102: The ID card image is photocopied. -9103: The ID card image is spoofed. -9104: The ID card is a temporary one. -9105: The ID card frame is occluded. -9106: The ID card image is photoshopped. -9107: The ID card image has glares.

getRequestId

public String getRequestId()

Get The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, which is returned for each request. RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, which is returned for each request. RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, which is returned for each request. RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel