tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
人脸核身
    文档
    Download PDF

    GetCardVerificationResult

    最后更新时间：2024-09-10 17:41:51
    下载PDF

    1. API Description

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

    The interface supports obtaining the certificate authentication result based on the token.

    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: GetCardVerificationResult.
    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.
    CardVerificationToken Yes String The token used to identify an verification process. It can be used to get the verification result after the process is completed.

    3. Output Parameters

    Parameter Name Type Description
    Status String Pass status. When Warning and Rejected are returned, please check the specific reasons in the WarnInfo structure return. Example values are as follows:
    PASSED
    WARNING
    REJECTED
    PROCESSING
    WarnInfo Array of String Warning information returned by document verification.
    Nationality String Nationality code. Complies with standard ISO 3166-1 alpha-3.

    Example value: IDN
    CardType String Card Type. The supported options are:
    ID_CARD
    PASSPORT
    DRIVING_LICENSE
    AUTO

    Example value: ID_CARD
    CardSubType String Subtype of the ID document.
    CardInfo CardInfo Recognition results of the ID document.
    IDVerificationToken String The token used to identify an verification process. It can be used to get the verification result after the process is completed.
    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 Sample response

    Input Example

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

{
    "CardVerificationToken": "abc"
}

    Output Example

    {
    "Response": {
        "Status": "abc",
        "WarnInfo": [
            "abc"
        ],
        "Nationality": "abc",
        "CardType": "abc",
        "CardSubType": "abc",
        "CardInfo": {
            "HKIDCard": {
                "CnName": "abc",
                "EnName": "abc",
                "TelexCode": "abc",
                "Sex": "abc",
                "Birthday": "abc",
                "Permanent": "abc",
                "IdNum": "abc",
                "Symbol": "abc",
                "FirstIssueDate": "abc",
                "CurrentIssueDate": "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"
            },
            "InternationalIDPassport": {
                "LicenseNumber": "abc",
                "FullName": "abc",
                "Surname": "abc",
                "GivenName": "abc",
                "Birthday": "abc",
                "Sex": "abc",
                "DateOfExpiration": "abc",
                "IssuingCountry": "abc",
                "NationalityCode": "abc",
                "PassportCodeFirst": "abc",
                "PassportCodeSecond": "abc"
            },
            "GeneralCard": {
                "LicenseNumber": "abc",
                "PersonalNumber": "abc",
                "PassportCodeFirst": "abc",
                "PassportCodeSecond": "abc",
                "ExpirationDate": "abc",
                "DueDate": "abc",
                "IssuedDate": "abc",
                "IssuedAuthority": "abc",
                "IssuedCountry": "abc",
                "FullName": "abc",
                "FirstName": "abc",
                "LastName": "abc",
                "Sex": "abc",
                "Age": "abc",
                "Birthday": "abc",
                "BirthPlace": "abc",
                "Nationality": "abc",
                "RegistrationNumber": "abc",
                "Address": {
                    "Country": "abc",
                    "PostalCode": "abc",
                    "Subdivision": "abc",
                    "City": "abc",
                    "FormattedAddress": "abc",
                    "LineOne": "abc",
                    "LineTwo": "abc",
                    "LineThree": "abc",
                    "LineFour": "abc",
                    "LineFive": "abc"
                }
            },
            "IndonesiaDrivingLicense": {
                "LastName": "abc",
                "FirstName": "abc",
                "LicenseNumber": "abc",
                "Birthday": "abc",
                "Address": "abc",
                "ExpirationDate": "abc",
                "IssuedDate": "abc",
                "IssuedCountry": "abc"
            },
            "ThailandIDCard": {
                "LastName": "abc",
                "FirstName": "abc",
                "LicenseNumber": "abc",
                "DateOfBirth": "abc",
                "DateOfExpiry": "abc",
                "DateOfIssue": "abc",
                "IssuedCountry": "abc"
            },
            "SingaporeIDCard": {
                "ChName": "abc",
                "EnName": "abc",
                "ID": "abc",
                "Sex": "abc",
                "CountryOfBirth": "abc",
                "Birthday": "abc",
                "Address": "abc",
                "Race": "abc",
                "NRICCode": "abc",
                "PostCode": "abc",
                "DateOfExpiration": "abc",
                "DateOfIssue": "abc"
            }
        },
        "IDVerificationToken": "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

    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
    FailedOperation.UnKnowError Unknown error.
    FailedOperation.UnOpenError The service is not activated.
    InvalidParameterValue.InvalidParameterValueLimit Parameter value is wrong.
    ResourceUnavailable.InArrears The account is in arrears.
    ResourceUnavailable.ResourcePackageRunOut The account has exhausted the resource package for this service.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款