com.tencentcloudapi.ocr.v20181119.models

Class HKIDCardOCRResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.HKIDCardOCRResponse

public class HKIDCardOCRResponse
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
HKIDCardOCRResponse()
HKIDCardOCRResponse(HKIDCardOCRResponse 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	getBirthday() Get Date of birth
String	getCnName() Get Name in Chinese
String	getCurrentIssueDate() Get Last receipt date
String	getEnName() Get Name in English
Long	getFakeDetectResult() Get Authenticity check.
String	getFirstIssueDate() Get First issue date
String	getHeadImage() Get Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.
String	getIdNum() Get Identity card number
Long	getPermanent() Get Permanent identity card.
String	getRequestId() Get The unique request ID, which is returned for each request.
String	getSex() Get Gender.
String	getSymbol() Get Document symbol, i.e., the symbol under the date of birth, such as "***AZ"
String	getTelexCode() Get Telecode for the name in Chinese
Long[]	getWarningCode() Get Multiple alarm codes.
void	setBirthday(String Birthday) Set Date of birth
void	setCnName(String CnName) Set Name in Chinese
void	setCurrentIssueDate(String CurrentIssueDate) Set Last receipt date
void	setEnName(String EnName) Set Name in English
void	setFakeDetectResult(Long FakeDetectResult) Set Authenticity check.
void	setFirstIssueDate(String FirstIssueDate) Set First issue date
void	setHeadImage(String HeadImage) Set Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.
void	setIdNum(String IdNum) Set Identity card number
void	setPermanent(Long Permanent) Set Permanent identity card.
void	setRequestId(String RequestId) Set The unique request ID, which is returned for each request.
void	setSex(String Sex) Set Gender.
void	setSymbol(String Symbol) Set Document symbol, i.e., the symbol under the date of birth, such as "***AZ"
void	setTelexCode(String TelexCode) Set Telecode for the name in Chinese
void	setWarningCode(Long[] WarningCode) Set Multiple alarm codes.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

HKIDCardOCRResponse

public HKIDCardOCRResponse()

HKIDCardOCRResponse

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

getCnName

public String getCnName()

Get Name in Chinese

Returns:

CnName Name in Chinese

setCnName

public void setCnName(String CnName)

Set Name in Chinese

Parameters:

CnName - Name in Chinese

getEnName

public String getEnName()

Get Name in English

Returns:

EnName Name in English

setEnName

public void setEnName(String EnName)

Set Name in English

Parameters:

EnName - Name in English

getTelexCode

public String getTelexCode()

Get Telecode for the name in Chinese

Returns:

TelexCode Telecode for the name in Chinese

setTelexCode

public void setTelexCode(String TelexCode)

Set Telecode for the name in Chinese

Parameters:

TelexCode - Telecode for the name in Chinese

getSex

public String getSex()

Get Gender. Valid values: Male, Female

Returns:

Sex Gender. Valid values: Male, Female

setSex

public void setSex(String Sex)

Set Gender. Valid values: Male, Female

Parameters:

Sex - Gender. Valid values: Male, Female

getBirthday

public String getBirthday()

Get Date of birth

Returns:

Birthday Date of birth

setBirthday

public void setBirthday(String Birthday)

Set Date of birth

Parameters:

Birthday - Date of birth

getPermanent

public Long getPermanent()

Get Permanent identity card. 0: non-permanent; 1: permanent; -1: unknown.

Returns:

Permanent Permanent identity card. 0: non-permanent; 1: permanent; -1: unknown.

setPermanent

public void setPermanent(Long Permanent)

Set Permanent identity card. 0: non-permanent; 1: permanent; -1: unknown.

Parameters:

Permanent - Permanent identity card. 0: non-permanent; 1: permanent; -1: unknown.

getIdNum

public String getIdNum()

Get Identity card number

Returns:

IdNum Identity card number

setIdNum

public void setIdNum(String IdNum)

Set Identity card number

Parameters:

IdNum - Identity card number

getSymbol

public String getSymbol()

Get Document symbol, i.e., the symbol under the date of birth, such as "***AZ"

Returns:

Symbol Document symbol, i.e., the symbol under the date of birth, such as "***AZ"

setSymbol

public void setSymbol(String Symbol)

Set Document symbol, i.e., the symbol under the date of birth, such as "***AZ"

Parameters:

Symbol - Document symbol, i.e., the symbol under the date of birth, such as "***AZ"

getFirstIssueDate

public String getFirstIssueDate()

Get First issue date

Returns:

FirstIssueDate First issue date

setFirstIssueDate

public void setFirstIssueDate(String FirstIssueDate)

Set First issue date

Parameters:

FirstIssueDate - First issue date

getCurrentIssueDate

public String getCurrentIssueDate()

Get Last receipt date

Returns:

CurrentIssueDate Last receipt date

setCurrentIssueDate

public void setCurrentIssueDate(String CurrentIssueDate)

Set Last receipt date

Parameters:

CurrentIssueDate - Last receipt date

getFakeDetectResult

public Long getFakeDetectResult()

Get Authenticity check. 0: unable to judge (because the image is blurred, incomplete, reflective, too dark, etc.); 1: forged; 2: authentic. Note: this field may return null, indicating that no valid values can be obtained.

Returns:

FakeDetectResult Authenticity check. 0: unable to judge (because the image is blurred, incomplete, reflective, too dark, etc.); 1: forged; 2: authentic. Note: this field may return null, indicating that no valid values can be obtained.

setFakeDetectResult

public void setFakeDetectResult(Long FakeDetectResult)

Set Authenticity check. 0: unable to judge (because the image is blurred, incomplete, reflective, too dark, etc.); 1: forged; 2: authentic. Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

FakeDetectResult - Authenticity check. 0: unable to judge (because the image is blurred, incomplete, reflective, too dark, etc.); 1: forged; 2: authentic. Note: this field may return null, indicating that no valid values can be obtained.

getHeadImage

public String getHeadImage()

Get Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.

Returns:

HeadImage Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.

setHeadImage

public void setHeadImage(String HeadImage)

Set Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

HeadImage - Base64-encoded identity photo Note: this field may return null, indicating that no valid values can be obtained.

getWarningCode

public Long[] getWarningCode()

Get Multiple alarm codes. If the ID card is spoofed, photocopied, or doctored, the corresponding alarm code will be returned. -9102: alarm for photocopied document -9103: alarm for spoofed document -9104: alarm for doctored document -9105: alarm for forged document

Returns:

WarningCode Multiple alarm codes. If the ID card is spoofed, photocopied, or doctored, the corresponding alarm code will be returned. -9102: alarm for photocopied document -9103: alarm for spoofed document -9104: alarm for doctored document -9105: alarm for forged document

setWarningCode

public void setWarningCode(Long[] WarningCode)

Set Multiple alarm codes. If the ID card is spoofed, photocopied, or doctored, the corresponding alarm code will be returned. -9102: alarm for photocopied document -9103: alarm for spoofed document -9104: alarm for doctored document -9105: alarm for forged document

Parameters:

WarningCode - Multiple alarm codes. If the ID card is spoofed, photocopied, or doctored, the corresponding alarm code will be returned. -9102: alarm for photocopied document -9103: alarm for spoofed document -9104: alarm for doctored document -9105: alarm for forged document

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