GetWebVerificationResultIntl

This API is used to get the verification result with the corresponding BizToken after the web-based verification is completed. The token is valid for three days (259,200s) after issuance and can be called multiple times.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: GetWebVerificationResultIntl.
Version	Yes	String	Common Params. The value used for this API: 2018-03-01.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-jakarta, ap-singapore.
BizToken	Yes	String	The token for the web-based verification, which is generated using the `ApplyWebVerificationBizTokenIntl` API.

3. Output Parameters

Parameter Name	Type	Description
ErrorCode	Integer	The final result of this verification. `0` indicates that the person is the same as that in the photo. For other error codes, see Selfie Verification (Mobile HTML5) Error Codes 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.
VerificationDetailList	Array of VerificationDetail	The detailed verification result list of this process. Retries are allowed, so a verification process may have several entries of results. Note: This field may return null, indicating that no valid values can be obtained.
VideoBase64	String	The Base64-encoded string of the video collected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no video is collected, null is returned. Note: This field may return null, indicating that no valid values can be obtained.
BestFrameBase64	String	The Base64-encoded string of the best face screenshot collected from the video stream. Retries are allowed, and this field returns only the data collected in the last verification. If no best face screenshot is collected, null is returned. Note: This field may return null, indicating that no valid values can be obtained.
OCRResult	Array of OCRResult	Card recognize result. Note: This field may return null, indicating that no valid values can be obtained.
Extra	String	The passthrough parameter of the business, max 1,000 characters, which will be returned in GetWebVerificationResultIntl.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting the result of a web-based verification process

Input Example

POST / HTTP/1.1
Host: faceid.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWebVerificationResult
<Common request parameters>

{
    "BizToken": "EE13636D-1985-42CA-BD61-73F4C8B687E6"
}

Output Example

{
    "Response": {
        "ErrorCode": 0,
        "ErrorMsg": "abc",
        "VerificationDetailList": [
            {
                "ErrorCode": 0,
                "ErrorMsg": "abc",
                "LivenessErrorCode": 0,
                "LivenessErrorMsg": "abc",
                "CompareErrorCode": 0,
                "CompareErrorMsg": "abc",
                "ReqTimestamp": 1,
                "Similarity": 0,
                "Seq": "abc"
            }
        ],
        "VideoBase64": "abc",
        "BestFrameBase64": "abc",
        "OCRResult": [
            {
                "IsPass": true,
                "CardImageBase64": "abc",
                "CardInfo": {
                    "HKIDCard": {
                        "CnName": "abc",
                        "EnName": "abc",
                        "IdNum": "abc",
                        "Birthday": "abc",
                        "Sex": "abc"
                    },
                    "MLIDCard": {
                        "Name": "abc",
                        "ID": "abc",
                        "Sex": "abc",
                        "Address": "abc",
                        "Type": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesVoteID": {
                        "VIN": "abc",
                        "FirstName": "abc",
                        "LastName": "abc",
                        "Birthday": "abc",
                        "CivilStatus": "abc",
                        "Citizenship": "abc",
                        "Address": "abc",
                        "PrecinctNo": "abc"
                    },
                    "IndonesiaIDCard": {
                        "NIK": "abc",
                        "Nama": "abc",
                        "TempatTglLahir": "abc",
                        "JenisKelamin": "abc",
                        "GolDarah": "abc",
                        "Alamat": "abc",
                        "RTRW": "abc",
                        "KelDesa": "abc",
                        "Kecamatan": "abc",
                        "Agama": "abc",
                        "StatusPerkawinan": "abc",
                        "Perkerjaan": "abc",
                        "KewargaNegaraan": "abc",
                        "BerlakuHingga": "abc",
                        "IssuedDate": "abc",
                        "Provinsi": "abc",
                        "Kota": "abc"
                    },
                    "PhilippinesDrivingLicense": {
                        "Name": "abc",
                        "LastName": "abc",
                        "FirstName": "abc",
                        "MiddleName": "abc",
                        "Nationality": "abc",
                        "Sex": "abc",
                        "Address": "abc",
                        "LicenseNo": "abc",
                        "ExpiresDate": "abc",
                        "AgencyCode": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesTinID": {
                        "LicenseNumber": "abc",
                        "FullName": "abc",
                        "Address": "abc",
                        "Birthday": "abc",
                        "IssueDate": "abc"
                    },
                    "PhilippinesSSSID": {
                        "LicenseNumber": "abc",
                        "FullName": "abc",
                        "Birthday": "abc"
                    },
                    "PhilippinesUMID": {
                        "Surname": "abc",
                        "MiddleName": "abc",
                        "GivenName": "abc",
                        "Sex": "abc",
                        "Birthday": "abc",
                        "Address": "abc",
                        "CRN": "abc"
                    }
                },
                "RequestId": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.BizTokenExpired	BizToken expired.
InvalidParameterValue.BizTokenIllegal	Invalid BizToken.
OperationDenied	Operation denied.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Getting the result of a web-based verification process

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Image Creation

Internet of Things

Stream Services

Cloud Real-time Rendering

Cloud Resource Management

More

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Management and Audit Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Developer Tools

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Voice Technology

Optical Character Recognition

Interactive Video Services

Media SDK

Medical Services

Monitor and Operation

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Getting the result of a web-based verification process

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center