tencent cloud

All product documents
Optical Character Recognition
DocumentationOptical Character RecognitionServer APIsCard and Document OCR APIsHmtPermitOCR
HmtPermitOCR
Download PDF
Last updated: 2023-09-05 15:28:10
HmtPermitOCR
Last updated: 2023-09-05 15:28:10
Download PDF

1. API Description

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

This API is used to recognize the fields on an exit/entry permit (card) for traveling to and from Hong Kong, Macao, or Taiwan, including place of issuance, issuing authority, validity period, gender, date of birth, name in English, name in Chinese, and document number.

A maximum of 10 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: PermitOCR.
Version Yes String Common Params. The value used for this API: 2018-11-19.
Region No String Common Params. This parameter is not required for this API.
ImageBase64 No String The Base64-encoded value of the image.
Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
Either ImageUrl or ImageBase64 of the image must be provided. If both are provided, only ImageUrl is used.
ImageUrl No String The URL of the image.
Supported image formats: PNG, JPG, and JPEG. GIF is currently not supported.
Supported image size: The downloaded image after Base64 encoding can be up to 7 MB. The download time of the image cannot exceed 3s.
We recommend that you store the image in Tencent Cloud for higher download speed and stability.
The download speed and stability of non-Tencent Cloud URLs may be low.

3. Output Parameters

Parameter Name Type Description
Name String Name
EnglishName String Name in English
Number String ID number
Sex String Gender
ValidDate String Validity period
IssueAuthority String Issuing authority
IssueAddress String Place of issue
Birthday String Date of birth
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Recognizing an exit/entry permit for traveling to and from Hong Kong, Macao, or Taiwan

This example shows you how to recognize an exit/entry permit for traveling to and from Hong Kong, Macao, or Taiwan.

Input Example

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

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

Output Example

{
    "Response": {
        "Name": "",
        "EnglishName": "LIMING",
        "Number": "C00000000",
        "Sex": "",
        "ValidDate": "2018.10.09-2028.10.08",
        "IssueAuthority": "",
        "IssueAddress": "",
        "Birthday": "1981.08.03",
        "RequestId": "3090debe-3662-4ef1-8784-6ef2fb59f75e"
    }
}

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.DownLoadError File download failed.
FailedOperation.ImageDecodeFailed Image decoding failed.
FailedOperation.OcrFailed OCR failed.
FailedOperation.UnKnowError Unknown error.
FailedOperation.UnOpenError The service is not activated.
InvalidParameterValue.InvalidParameterValueLimit Incorrect parameter value.
LimitExceeded.TooLargeFileError The file is too large.
ResourcesSoldOut.ChargeStatusException Exceptional billing status.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon