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

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 identity document image.
FileInfo	getCardInfoOcrJson() Get The OCR result (in JSON) of the identity document image.
FileInfo	getCardVideo() Get The video for ID card authentication.
Boolean	getIsPass() Get Whether the authentication or OCR process is successful.
String	getRequestId() Get The request ID of a single process.
void	setCardImage(FileInfo CardImage) Set The identity document image.
void	setCardInfoOcrJson(FileInfo CardInfoOcrJson) Set The OCR result (in JSON) of the identity document image.
void	setCardVideo(FileInfo CardVideo) Set The video for ID card authentication.
void	setIsPass(Boolean IsPass) Set Whether the authentication or OCR process is successful.
void	setRequestId(String RequestId) Set The request ID of a single process.
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

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.

getCardVideo

public FileInfo getCardVideo()

Get The video for ID card authentication. This field is returned only if the video-based ID card authentication is enabled. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

CardVideo The video for ID card authentication. This field is returned only if the video-based ID card authentication is enabled. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

setCardVideo

public void setCardVideo(FileInfo CardVideo)

Set The video for ID card authentication. This field is returned only if the video-based ID card authentication is enabled. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

CardVideo - The video for ID card authentication. This field is returned only if the video-based ID card authentication is enabled. The URL is valid for 10 minutes. Note: This field may return null, indicating that no valid values can be obtained.

getCardImage

public FileInfo getCardImage()

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

Returns:

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

setCardImage

public void setCardImage(FileInfo CardImage)

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

Parameters:

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

getCardInfoOcrJson

public FileInfo getCardInfoOcrJson()

Get The OCR result (in JSON) of the identity document image. If authentication or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - 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: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string: Date of birth. - ID string: ID number. - Name string: Name. - Address string: Address. - Type string: Identity document type. When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday string: Date of birth. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - VIN string: VIN number. - CivilStatus string: Marital status. - Citizenship string: Citizenship. - PrecinctNo string: Region. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex string: Gender. - Birthday string: Date of birth. - Name string: Name. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - MiddleName string: Middle name. - Nationality string: Nationality. - LicenseNo string: License number. - ExpiresDate string: Validity period. - AgencyCode string: Agency 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 authentication or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - 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: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string: Date of birth. - ID string: ID number. - Name string: Name. - Address string: Address. - Type string: Identity document type. When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday string: Date of birth. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - VIN string: VIN number. - CivilStatus string: Marital status. - Citizenship string: Citizenship. - PrecinctNo string: Region. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex string: Gender. - Birthday string: Date of birth. - Name string: Name. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - MiddleName string: Middle name. - Nationality string: Nationality. - LicenseNo string: License number. - ExpiresDate string: Validity period. - AgencyCode string: Agency 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 authentication or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - 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: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string: Date of birth. - ID string: ID number. - Name string: Name. - Address string: Address. - Type string: Identity document type. When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday string: Date of birth. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - VIN string: VIN number. - CivilStatus string: Marital status. - Citizenship string: Citizenship. - PrecinctNo string: Region. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex string: Gender. - Birthday string: Date of birth. - Name string: Name. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - MiddleName string: Middle name. - Nationality string: Nationality. - LicenseNo string: License number. - ExpiresDate string: Validity period. - AgencyCode string: Agency 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 authentication or OCR fails, this parameter is left empty. The URL is valid for 10 minutes. When the value of `IdCardType` is `HK`: - CnName string: Chinese name - EnName string: English name - TelexCode string: The code corresponding to the Chinese name - 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: ID number. - Symbol string: The ID symbol below the date of birth, such as "***AZ". - FirstIssueDate string: The date of first issuance. - CurrentIssueDate string: The date of latest issuance. When the value of `IdCardType` is `ML`: - Sex string: `LELAKI` (male) and `PEREMPUAN` (female). - Birthday string: Date of birth. - ID string: ID number. - Name string: Name. - Address string: Address. - Type string: Identity document type. When the value of `IdCardType` is `PhilippinesVoteID`: - Birthday string: Date of birth. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - VIN string: VIN number. - CivilStatus string: Marital status. - Citizenship string: Citizenship. - PrecinctNo string: Region. When the value of `IdCardType` is `PhilippinesDrivingLicense`: - Sex string: Gender. - Birthday string: Date of birth. - Name string: Name. - Address string: Address. - LastName string: Family name. - FirstName string: First name. - MiddleName string: Middle name. - Nationality string: Nationality. - LicenseNo string: License number. - ExpiresDate string: Validity period. - AgencyCode string: Agency 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.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel