GetCardVerificationExternalResult

最后更新时间：2025-11-25 15:01:41

GetCardVerificationExternalResult

最后更新时间： 2025-11-25 15:01:41

1. API Description

Domain name for API request: ocr.intl.tencentcloudapi.com.

This API is used to obtain document recognition results.

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: GetCardVerificationExternalResult.
Version	Yes	String	Common Params. The value used for this API: 2018-11-19.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
CardVerificationToken	Yes	String	Initiates the recognition interface and returns a unique token.

3. Output Parameters

Parameter Name	Type	Description
Status	String	Indicates the status. valid values: PASSED PROCESSING WARNING
WarnInfo	Array of String	Indicates the anti-counterfeiting information. -ScreenshotSuspected: The image is a screenshot. -RetakeSuspected: The image is taken from another screen. -PaperCopy: The image is a black and white, or color photocopy. -FakeSuspected: The image of the card, or the information on the card has been edited or altered. -OtherWarning: Document's authenticity is not verified for various reasons. Note: This field may return null, indicating that no valid values can be obtained.
Nationality	String	Country Code. Note: This field may return null, indicating that no valid values can be obtained.
CardInfo	GeneralCard	Recognition result of the text in the id photo. Note: This field may return null, indicating that no valid values can be obtained.
CardVerificationToken	String	Specifies the token in the request parameters.
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 GetCardVerificationExternalResult

Input Example

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

{
    "CardVerificationToken": "9943345f-a690-4220-a749-9c68518f2e17"
}

Output Example

{
    "Response": {
        "CardInfo": {
            "Address": {
                "City": "",
                "Country": "",
                "FormattedAddress": "",
                "LineFive": "",
                "LineFour": "",
                "LineOne": "",
                "LineThree": "",
                "LineTwo": "",
                "PostalCode": "",
                "Subdivision": ""
            },
            "Age": "",
            "BirthPlace": "SAN FELIPE ZBS",
            "Birthday": "1997/10/01",
            "DueDate": "",
            "ExpirationDate": "2033/10/19",
            "FirstName": "IVY ROSE",
            "FirstNameLocal": "IVY ROSE",
            "FullName": "GOLIMLIM EREDIA IVY ROSE",
            "FullNameLocal": "GOLIMLIM EREDIA IVY ROSE",
            "IssuedAuthority": "DFA TARLAC",
            "IssuedCountry": "Philippines",
            "IssuedDate": "2023/10/20",
            "LastName": "GOLIMLIM",
            "LastNameLocal": "GOLIMLIM",
            "LicenseNumber": "P5784986C",
            "Nationality": "PHL",
            "PassportCodeFirst": "",
            "PassportCodeSecond": "",
            "PersonalNumber": "P5784986C",
            "RegistrationNumber": "",
            "Sex": "FEMALE"
        },
        "CardVerificationToken": "9943345f-a690-4220-a749-9c68518f2e17",
        "Nationality": "PHL",
        "Status": "PASSED",
        "WarnInfo": null,
        "RequestId": "d4413701-8afc-48e1-920f-defd04157c65"
    }
}

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
FailedOperation.OcrFailed	OCR failed. This error may be caused by unstable network connections,service anomalies or other issues.
FailedOperation.UnKnowError	Unknown error.
FailedOperation.UnOpenError	The service is not activated.
InvalidParameterValue.InvalidParameterValueLimit	Incorrect parameter value.
ResourceUnavailable.InArrears	The account is in arrears.
ResourceUnavailable.ResourcePackageRunOut	The account resource package is exhausted.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud