tencent cloud

1. API Description

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

This API is used to recognize key fields on the front and back sides of a residence permit for Hong Kong, Macao, or Taiwan residents, including name, gender, date of birth, address, ID number, issuing authority, validity period, number of issues, and permit number. It can be used for residence permit OCR in scenarios such as bank account opening and user registration.

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

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.

3. Output Parameters

4. Example

Example1 Recognizing a residence permit for Hong Kong, Macao, or Taiwan residents

This example shows you how to recognize a residence permit for Hong Kong, Macao, or Taiwan residents.

Input Example

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

{
    "ImageUrl": "https://xx/a.jpg",
    "CardSide": "FRONT"
}

Output Example

{
    "Response": {
        "Name": "",
        "Sex": "",
        "Birth": "1997/6/2",
        "Address": "",
        "IdCardNo": "830000199706020042",
        "CardType": 0,
        "ValidDate": "",
        "Authority": "",
        "VisaNum": "0",
        "PassNo": "000",
        "RequestId": "f72e7048-f1e0-42f3-b0bf-f8730d48bb5c"
    }
}

Example2 Recognizing a residence permit for Hong Kong, Macao, or Taiwan residents

This example shows you how to recognize a residence permit for Hong Kong, Macao, or Taiwan residents.

Input Example

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

{
    "ImageUrl": "https://xx/a.jpg"
}

Output Example

{
    "Response": {
        "Name": "",
        "Sex": "",
        "Birth": "",
        "Address": "",
        "IdCardNo": "",
        "CardType": 1,
        "ValidDate": "2018.09.06-2023.09.06",
        "Authority": "",
        "VisaNum": "0",
        "PassNo": "000",
        "RequestId": "182abb0c-b0bd-403a-ab11-3dba21ae89d0"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.