tencent cloud

Feedback

Data Types

Last updated: 2022-09-05 16:37:38

CardVerifyResult

The result of a single authentication or OCR process during the identity verification.

Used by actions: GetSdkVerificationResult.

Name Type Description
IsPass Boolean Whether the authentication or OCR process is successful.
CardVideo FileInfo 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.
CardImage FileInfo 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.
CardInfoOcrJson FileInfo 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.
RequestId String The request ID of a single process.

CompareResult

The description of a single comparison result.

Used by actions: GetSdkVerificationResult.

Name Type Description
ErrorCode String The final comparison result.
ErrorMsg String The description of the final comparison result.
LiveData FileInfo
LiveVideo FileInfo The video for this liveness detection process. The URL is valid for 10 minutes.
LiveErrorCode String The code of the liveness detection result.
LiveErrorMsg String The description of the liveness detection result.
BestFrame FileInfo The best face screenshot in this liveness detection. The URL is valid for 10 minutes.
Note: This field may return null, indicating that no valid values can be obtained.
ProfileImage FileInfo The profile photo screenshot from the identity document. The URL is valid for 10 minutes.
CompareErrorCode String The code of the face comparison result.
Note: This field may return null, indicating that no valid values can be obtained.
CompareErrorMsg String The description of the face comparison result.
Note: This field may return null, indicating that no valid values can be obtained.
Sim Float Similarity
Note: This field may return null, indicating that no valid values can be obtained.
IsNeedCharge Boolean This field is disused.
CardInfoInputJson FileInfo The identity document photo info edited by the user in JSON. If the value of DisableChangeOcrResult is true, the editing feature is disabled and this field does not exist. 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
- ID string
- Name string
- Address string
- Type string: Identity document type.
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The request ID of this verification process.

FileInfo

The description of a file, including a download URL and the MD5 checksum and size of the file.

Used by actions: GetLivenessResult, GetSdkVerificationResult, VideoLivenessCompare.

Name Type Required Description
Url String Yes The URL for downloading the file
MD5 String Yes The 32-bit MD5 checksum of the file
Size Integer Yes The file size

VerificationDetail

The details of the verification process.

Used by actions: GetWebVerificationResult.

Name Type Description
ErrorCode Integer The final result of this verification. 0 indicates that the person is the same as that in the photo.
Note: This field may return null, indicating that no valid values can be obtained.
ErrorMsg String The description of the final verification result.
Note: This field may return null, indicating that no valid values can be obtained.
LivenessErrorCode Integer The result of this liveness detection process. 0 indicates success.
Note: This field may return null, indicating that no valid values can be obtained.
LivenessErrorMsg String The result description of this liveness detection process.
Note: This field may return null, indicating that no valid values can be obtained.
CompareErrorCode Integer The result of this comparison process. 0 indicates that the person in the best face screenshot collected from the video stream is the same as that in the uploaded image for comparison.
Note: This field may return null, indicating that no valid values can be obtained.
CompareErrorMsg String The result description of this comparison process.
Note: This field may return null, indicating that no valid values can be obtained.
ReqTimestamp Integer The timestamp (ms) of this verification process.
Note: This field may return null, indicating that no valid values can be obtained.
Similarity Float The similarity of the best face screenshot collected from the video stream and the uploaded image for comparison in this verification process. Valid range: [0.00, 100.00]. By default, the person in the screenshot is judged as the same person in the image if the similarity is greater than or equal to 70.
Note: This field may return null, indicating that no valid values can be obtained.
Seq String Unique ID of this verification process.
Note: This field may return null, indicating that no valid values can be obtained.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support