tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetSdkVerificationResult

Last updated: 2024-09-10 17:41:51

    1. API Description

    Domain name for API request: faceid.tencentcloudapi.com.

    This API is used to get the verification result with the corresponding token after the SDK-based verification is completed. The token is valid for three days 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: GetSdkVerificationResult.
    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-hongkong, ap-jakarta, ap-singapore.
    SdkToken Yes String The token used to identify an SDK-based verification process.

    3. Output Parameters

    Parameter Name Type Description
    Result String The result code of the verification result.
    Description String The verification result description.
    ChargeCount Integer The charge count.
    CardVerifyResults Array of CardVerifyResult The results of multiple OCR processes (in order). The result of the final process is used as the valid result.
    CompareResults Array of CompareResult The results of multiple liveness detection processes (in order). The result of the final process is used as the valid result.
    Extra String Data passed through in the process of getting the token.
    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 verification result

    This example shows you how to get the verification result.

    Input Example

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

{
    "SdkToken": "D2B55F0C-FB5D-4FB6-8765-3E931EBBFC79"
}

    Output Example

    {
    "Response": {
        "CardVerifyResults": [
            {
                "IsPass": true,
                "CardVideo": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "682e24b207acf1825286c1fceef5631c",
                    "Size": 9430792
                },
                "CardImage": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "667c2448b10b09ee9ec14ab2b0d36608",
                    "Size": 232267
                },
                "CardInfoOcrJson": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "0ae50935bb50cd70e6e34f81ff2e3fbd",
                    "Size": 224
                },
                "RequestId": "8e510d65-c26e-4de7-991d-e07ef0ad953d"
            }
        ],
        "CompareResults": [
            {
                "ErrorCode": "1001",
                "ErrorMsg": "Failed to call the liveness engine",
                "LiveData": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "f624d26bfb45e149b293097037819feb",
                    "Size": 719585
                },
                "LiveVideo": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "e87070d8eb95f64bc01b12e03cc8f533",
                    "Size": 887224
                },
                "LiveErrorCode": "1001",
                "LiveErrorMsg": "Failed to call the liveness engine",
                "CompareErrorCode": "",
                "CompareErrorMsg": "",
                "BestFrame": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "c4f217871aaeb0180e40152f61658835",
                    "Size": 122984
                },
                "ProfileImage": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "d51df99b25d87785ea5e2dfb0d6e920f",
                    "Size": 23091
                },
                "Sim": 0,
                "IsNeedCharge": true,
                "CardInfoInputJson": {
                    "Url": "https://intl-reflect-h5-1257237511.cos.ap-guangzhou.myqcloud.com",
                    "MD5": "02497f445dc72a330b468fa24529315b",
                    "Size": 219
                },
                "RequestId": "6e498069-4d51-4032-82a8-9adb53cda85b"
            }
        ],
        "ChargeCount": 4,
        "Description": "Failed to call the liveness engine",
        "Extra": "",
        "RequestId": "b8cb2269-08b2-426c-8be8-c7142c7e64e4",
        "Result": "1001"
    }
}

    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

    6. Error Code

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy