tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

MainlandPermitOCR

Last updated: 2023-06-25 16:08:55

    1. API Description

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

    This API is used to recognize all fields on the front of a mainland travel permit for Hong Kong, Macao, or Taiwan residents: name in Chinese, name in English, gender, date of birth, issuing authority, validity period, document number, place of issuance, number of issues, and document type.

    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: MainlandPermitOCR.
    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.
    RetProfile No Boolean Whether to return the ID photo. By default, the ID photo is not returned.

    3. Output Parameters

    Parameter Name Type Description
    Name String Name in Chinese
    EnglishName String Name in English
    Sex String Gender
    Birthday String Date of birth
    IssueAuthority String Issuing authority
    ValidDate String Validity period
    Number String ID number
    IssueAddress String Place of issue
    IssueNumber String Number of issues
    Type String Document type
    Profile String Base64-encoded profile photo, which is returned only when RetProfile is set to True
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

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

    This example shows you how to recognize a mainland travel 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: MainlandPermitOCR
<Common request parameters>

{
    "ImageUrl": "https://xx/a.jpg",
    "RetProfile": "False"
}

    Output Example

    {
    "Response": {
        "Name": "",
        "EnglishName": "LIMING",
        "Number": "C00000000",
        "Sex": "",
        "ValidDate": "2018.10.09-2028.10.08",
        "IssueAuthority": "",
        "IssueAddress": "",
        "Birthday": "1981.08.03",
        "IssueNumber": "02",
        "Type": "",
        "Profile": "",
        "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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy