com.tencentcloudapi.faceid.v20180301.models

Class CardVerifyResult

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.faceid.v20180301.models.CardVerifyResult

public class CardVerifyResult
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CardVerifyResult()
CardVerifyResult(CardVerifyResult 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
FileInfo	getCardImage() Get The download URL of the identity document image, which is valid for 10 minutes.
CardInfo	getCardInfo() Deprecated.
FileInfo	getCardInfoOcrJson() Get The OCR result (in JSON) of the identity document image.
FileInfo	getCardVideo() Get The download URL of the video used for identity document verification, which is valid for 10 minutes.
Boolean	getIsEdit() Get Whether the user modified the card recognition result
Boolean	getIsPass() Get Whether the authentication or OCR process is successful.
NormalCardInfo	getNormalCardInfo() Get License OCR result
String	getRequestId() Get The request ID of a single process.
Long[]	getWarnCardInfos() Get Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.
void	setCardImage(FileInfo CardImage) Set The download URL of the identity document image, which is valid for 10 minutes.
void	setCardInfo(CardInfo CardInfo) Deprecated.
void	setCardInfoOcrJson(FileInfo CardInfoOcrJson) Set The OCR result (in JSON) of the identity document image.
void	setCardVideo(FileInfo CardVideo) Set The download URL of the video used for identity document verification, which is valid for 10 minutes.
void	setIsEdit(Boolean IsEdit) Set Whether the user modified the card recognition result
void	setIsPass(Boolean IsPass) Set Whether the authentication or OCR process is successful.
void	setNormalCardInfo(NormalCardInfo NormalCardInfo) Set License OCR result
void	setRequestId(String RequestId) Set The request ID of a single process.
void	setWarnCardInfos(Long[] WarnCardInfos) Set Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.
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

CardVerifyResult

public CardVerifyResult()

CardVerifyResult

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

getIsPass

public Boolean getIsPass()

Get Whether the authentication or OCR process is successful.

Returns:

IsPass Whether the authentication or OCR process is successful.

setIsPass

public void setIsPass(Boolean IsPass)

Set Whether the authentication or OCR process is successful.

Parameters:

IsPass - Whether the authentication or OCR process is successful.

getIsEdit

public Boolean getIsEdit()

Get Whether the user modified the card recognition result

Returns:

IsEdit Whether the user modified the card recognition result

setIsEdit

public void setIsEdit(Boolean IsEdit)

Set Whether the user modified the card recognition result

Parameters:

IsEdit - Whether the user modified the card recognition result

getCardVideo

public FileInfo getCardVideo()

Get The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled. Note: This field may return null, indicating that no valid value can be obtained.

Returns:

CardVideo The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled. Note: This field may return null, indicating that no valid value can be obtained.

setCardVideo

public void setCardVideo(FileInfo CardVideo)

Set The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled. Note: This field may return null, indicating that no valid value can be obtained.

Parameters:

CardVideo - The download URL of the video used for identity document verification, which is valid for 10 minutes. This parameter is returned only if video-based identity document verification is enabled. Note: This field may return null, indicating that no valid value can be obtained.

getCardImage

public FileInfo getCardImage()

Get The download URL of the identity document image, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

Returns:

CardImage The download URL of the identity document image, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

setCardImage

public void setCardImage(FileInfo CardImage)

Set The download URL of the identity document image, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

Parameters:

CardImage - The download URL of the identity document image, which is valid for 10 minutes. Note: This field may return null, indicating that no valid value can be obtained.

getCardInfoOcrJson

public FileInfo getCardInfoOcrJson()

Get The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. (1) Hong Kong (China) identity card When the value of `IdCardType` is `HK`: - CnName (string): Name in Chinese. - EnName (string): Name in English. - TelexCode (string): The code corresponding to the name in Chinese. - Sex (string): Gender. Valid values: `M` (male) and `F` (female). - Birthday (string): Date of birth. - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum (string): Identity card number. - Symbol (string): The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate (string): Month and year of first registration. - CurrentIssueDate (string): The date of latest issuance. (2) Malaysian identity card When the value of `IdCardType` is `ML`: - Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday (string): Date of birth. - ID (string): Identity card number. - Name (string): Name. - Address (string): Address. - Type (string): Identity document type. (3) Philippine identity document When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday (string): Date of birth. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - VIN (string): Voter's identification number (VIN). - CivilStatus (string): Civil status. - Citizenship (string): Citizenship. - PrecinctNo (string): Precinct. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex (string): Gender. - Birthday (string): Date of birth. - Name (string): Name. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - MiddleName (string): Middle name. - Nationality (string): Nationality. - LicenseNo (string): License number. - ExpiresDate (string): Expiration date. - AgencyCode (string): Agency code. When the value of `IdCardType` is `PhilippinesTinID`: - LicenseNumber (string): Tax identification number (TIN). - FullName (string): Full name. - Address (string): Address. - Birthday (string): Date of birth. - IssueDate (string): Issue date. When the value of `IdCardType` is `PhilippinesSSSID`: - LicenseNumber (string): Common reference number (CRN). - FullName (string): Full name. - Birthday (string): Date of birth. When the value of `IdCardType` is `PhilippinesUMID`: - Surname (string): Surname. - MiddleName (string):Middle name. - GivenName (string): Given name. - Sex (string): Gender. - Birthday (string): Date of birth. - Address (string): Address. - CRN (string): Common reference number (CRN). (4) Indonesian identity card When the value of `IdCardType` is `IndonesiaIDCard`: - NIK (string): Single Identity Number. - Nama (string): Full name. - TempatTglLahir (string): Place and date of birth. - JenisKelamin (string): Gender. - GolDarah (string): Blood type. - Alamat (string): Address. - RTRW (string): Street. - KelDesa (string): Village. - Kecamatan (string): Region. - Agama (string): Religion. - StatusPerkawinan (string): Marital status. - Perkerjaan (string): Occupation. - KewargaNegaraan (string): Nationality. - BerlakuHingga (string): Expiry date. - IssuedDate (string): Issue date. (5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions When the value of `IdCardType` is `MLIDPassport`: - FullName (string): Full name. - Surname (string): Surname. - GivenName (string): Given name. - Birthday (string): Date of birth. - Sex (string): Gender. Valid values: `F` (female) and `M` (male). - DateOfExpiration (string): Expiration date. - IssuingCountry (string): Issuing country. - NationalityCode (string): Country/region code. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CardInfoOcrJson The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. (1) Hong Kong (China) identity card When the value of `IdCardType` is `HK`: - CnName (string): Name in Chinese. - EnName (string): Name in English. - TelexCode (string): The code corresponding to the name in Chinese. - Sex (string): Gender. Valid values: `M` (male) and `F` (female). - Birthday (string): Date of birth. - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum (string): Identity card number. - Symbol (string): The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate (string): Month and year of first registration. - CurrentIssueDate (string): The date of latest issuance. (2) Malaysian identity card When the value of `IdCardType` is `ML`: - Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday (string): Date of birth. - ID (string): Identity card number. - Name (string): Name. - Address (string): Address. - Type (string): Identity document type. (3) Philippine identity document When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday (string): Date of birth. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - VIN (string): Voter's identification number (VIN). - CivilStatus (string): Civil status. - Citizenship (string): Citizenship. - PrecinctNo (string): Precinct. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex (string): Gender. - Birthday (string): Date of birth. - Name (string): Name. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - MiddleName (string): Middle name. - Nationality (string): Nationality. - LicenseNo (string): License number. - ExpiresDate (string): Expiration date. - AgencyCode (string): Agency code. When the value of `IdCardType` is `PhilippinesTinID`: - LicenseNumber (string): Tax identification number (TIN). - FullName (string): Full name. - Address (string): Address. - Birthday (string): Date of birth. - IssueDate (string): Issue date. When the value of `IdCardType` is `PhilippinesSSSID`: - LicenseNumber (string): Common reference number (CRN). - FullName (string): Full name. - Birthday (string): Date of birth. When the value of `IdCardType` is `PhilippinesUMID`: - Surname (string): Surname. - MiddleName (string):Middle name. - GivenName (string): Given name. - Sex (string): Gender. - Birthday (string): Date of birth. - Address (string): Address. - CRN (string): Common reference number (CRN). (4) Indonesian identity card When the value of `IdCardType` is `IndonesiaIDCard`: - NIK (string): Single Identity Number. - Nama (string): Full name. - TempatTglLahir (string): Place and date of birth. - JenisKelamin (string): Gender. - GolDarah (string): Blood type. - Alamat (string): Address. - RTRW (string): Street. - KelDesa (string): Village. - Kecamatan (string): Region. - Agama (string): Religion. - StatusPerkawinan (string): Marital status. - Perkerjaan (string): Occupation. - KewargaNegaraan (string): Nationality. - BerlakuHingga (string): Expiry date. - IssuedDate (string): Issue date. (5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions When the value of `IdCardType` is `MLIDPassport`: - FullName (string): Full name. - Surname (string): Surname. - GivenName (string): Given name. - Birthday (string): Date of birth. - Sex (string): Gender. Valid values: `F` (female) and `M` (male). - DateOfExpiration (string): Expiration date. - IssuingCountry (string): Issuing country. - NationalityCode (string): Country/region code. Note: This field may return null, indicating that no valid values can be obtained.

setCardInfoOcrJson

public void setCardInfoOcrJson(FileInfo CardInfoOcrJson)

Set The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. (1) Hong Kong (China) identity card When the value of `IdCardType` is `HK`: - CnName (string): Name in Chinese. - EnName (string): Name in English. - TelexCode (string): The code corresponding to the name in Chinese. - Sex (string): Gender. Valid values: `M` (male) and `F` (female). - Birthday (string): Date of birth. - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum (string): Identity card number. - Symbol (string): The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate (string): Month and year of first registration. - CurrentIssueDate (string): The date of latest issuance. (2) Malaysian identity card When the value of `IdCardType` is `ML`: - Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday (string): Date of birth. - ID (string): Identity card number. - Name (string): Name. - Address (string): Address. - Type (string): Identity document type. (3) Philippine identity document When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday (string): Date of birth. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - VIN (string): Voter's identification number (VIN). - CivilStatus (string): Civil status. - Citizenship (string): Citizenship. - PrecinctNo (string): Precinct. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex (string): Gender. - Birthday (string): Date of birth. - Name (string): Name. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - MiddleName (string): Middle name. - Nationality (string): Nationality. - LicenseNo (string): License number. - ExpiresDate (string): Expiration date. - AgencyCode (string): Agency code. When the value of `IdCardType` is `PhilippinesTinID`: - LicenseNumber (string): Tax identification number (TIN). - FullName (string): Full name. - Address (string): Address. - Birthday (string): Date of birth. - IssueDate (string): Issue date. When the value of `IdCardType` is `PhilippinesSSSID`: - LicenseNumber (string): Common reference number (CRN). - FullName (string): Full name. - Birthday (string): Date of birth. When the value of `IdCardType` is `PhilippinesUMID`: - Surname (string): Surname. - MiddleName (string):Middle name. - GivenName (string): Given name. - Sex (string): Gender. - Birthday (string): Date of birth. - Address (string): Address. - CRN (string): Common reference number (CRN). (4) Indonesian identity card When the value of `IdCardType` is `IndonesiaIDCard`: - NIK (string): Single Identity Number. - Nama (string): Full name. - TempatTglLahir (string): Place and date of birth. - JenisKelamin (string): Gender. - GolDarah (string): Blood type. - Alamat (string): Address. - RTRW (string): Street. - KelDesa (string): Village. - Kecamatan (string): Region. - Agama (string): Religion. - StatusPerkawinan (string): Marital status. - Perkerjaan (string): Occupation. - KewargaNegaraan (string): Nationality. - BerlakuHingga (string): Expiry date. - IssuedDate (string): Issue date. (5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions When the value of `IdCardType` is `MLIDPassport`: - FullName (string): Full name. - Surname (string): Surname. - GivenName (string): Given name. - Birthday (string): Date of birth. - Sex (string): Gender. Valid values: `F` (female) and `M` (male). - DateOfExpiration (string): Expiration date. - IssuingCountry (string): Issuing country. - NationalityCode (string): Country/region code. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CardInfoOcrJson - The OCR result (in JSON) of the identity document image. If verification or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. (1) Hong Kong (China) identity card When the value of `IdCardType` is `HK`: - CnName (string): Name in Chinese. - EnName (string): Name in English. - TelexCode (string): The code corresponding to the name in Chinese. - Sex (string): Gender. Valid values: `M` (male) and `F` (female). - Birthday (string): Date of birth. - Permanent (int): Whether it is a permanent residence identity card. Valid values: `0` (non-permanent), `1` (permanent), and `-1` (unknown). - IdNum (string): Identity card number. - Symbol (string): The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate (string): Month and year of first registration. - CurrentIssueDate (string): The date of latest issuance. (2) Malaysian identity card When the value of `IdCardType` is `ML`: - Sex (string): Gender. Valid values: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday (string): Date of birth. - ID (string): Identity card number. - Name (string): Name. - Address (string): Address. - Type (string): Identity document type. (3) Philippine identity document When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday (string): Date of birth. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - VIN (string): Voter's identification number (VIN). - CivilStatus (string): Civil status. - Citizenship (string): Citizenship. - PrecinctNo (string): Precinct. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex (string): Gender. - Birthday (string): Date of birth. - Name (string): Name. - Address (string): Address. - LastName (string): Last name. - FirstName (string): First name. - MiddleName (string): Middle name. - Nationality (string): Nationality. - LicenseNo (string): License number. - ExpiresDate (string): Expiration date. - AgencyCode (string): Agency code. When the value of `IdCardType` is `PhilippinesTinID`: - LicenseNumber (string): Tax identification number (TIN). - FullName (string): Full name. - Address (string): Address. - Birthday (string): Date of birth. - IssueDate (string): Issue date. When the value of `IdCardType` is `PhilippinesSSSID`: - LicenseNumber (string): Common reference number (CRN). - FullName (string): Full name. - Birthday (string): Date of birth. When the value of `IdCardType` is `PhilippinesUMID`: - Surname (string): Surname. - MiddleName (string):Middle name. - GivenName (string): Given name. - Sex (string): Gender. - Birthday (string): Date of birth. - Address (string): Address. - CRN (string): Common reference number (CRN). (4) Indonesian identity card When the value of `IdCardType` is `IndonesiaIDCard`: - NIK (string): Single Identity Number. - Nama (string): Full name. - TempatTglLahir (string): Place and date of birth. - JenisKelamin (string): Gender. - GolDarah (string): Blood type. - Alamat (string): Address. - RTRW (string): Street. - KelDesa (string): Village. - Kecamatan (string): Region. - Agama (string): Religion. - StatusPerkawinan (string): Marital status. - Perkerjaan (string): Occupation. - KewargaNegaraan (string): Nationality. - BerlakuHingga (string): Expiry date. - IssuedDate (string): Issue date. (5) A passport issued in Hong Kong/Macao/Taiwan (China) or other countries/regions When the value of `IdCardType` is `MLIDPassport`: - FullName (string): Full name. - Surname (string): Surname. - GivenName (string): Given name. - Birthday (string): Date of birth. - Sex (string): Gender. Valid values: `F` (female) and `M` (male). - DateOfExpiration (string): Expiration date. - IssuingCountry (string): Issuing country. - NationalityCode (string): Country/region code. Note: This field may return null, indicating that no valid values can be obtained.

getRequestId

public String getRequestId()

Get The request ID of a single process.

Returns:

RequestId The request ID of a single process.

setRequestId

public void setRequestId(String RequestId)

Set The request ID of a single process.

Parameters:

RequestId - The request ID of a single process.

getCardInfo

@Deprecated
public CardInfo getCardInfo()

Deprecated.

Get The recognition results of ID card

Returns:

CardInfo The recognition results of ID card

setCardInfo

@Deprecated
public void setCardInfo(CardInfo CardInfo)

Deprecated.

Set The recognition results of ID card

Parameters:

CardInfo - The recognition results of ID card

getNormalCardInfo

public NormalCardInfo getNormalCardInfo()

Get License OCR result

Returns:

NormalCardInfo License OCR result

setNormalCardInfo

public void setNormalCardInfo(NormalCardInfo NormalCardInfo)

Set License OCR result

Parameters:

NormalCardInfo - License OCR result

getWarnCardInfos

public Long[] getWarnCardInfos()

Get Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.

Returns:

WarnCardInfos Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.

setWarnCardInfos

public void setWarnCardInfos(Long[] WarnCardInfos)

Set Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.

Parameters:

WarnCardInfos - Card warning information -9101 Alarm for covered certificate, -9102 Alarm for photocopied certificate, -9103 Alarm for photographed certificate, -9107 Alarm for reflective certificate, -9108 Alarm for blurry image, -9109 This capability is not enabled.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel