tencent cloud

Synchronization task
Download PDF
Last updated: 2025-09-11 17:22:13
Synchronization task
Last updated: 2025-09-11 17:22:13
Download PDF

Feature Overview

This API supports automatic positioning of all fields on the front side (back side not currently supported) of second-generation Chinese ID cards for Chinese mainland residents and the main page (secondary page not supported) of driving licenses. Text recognition is not currently supported. It is used for removing and disabling specific fields, as well as further text recognition.
Note:
This API is a GET request, which operates in a synchronous method and requires a signature. For specific signature settings, please refer to Request Signature documentation.

Authorization Guide

When used with a sub-account, corresponding permissions must be granted. For COS permissions, please refer to Cloud Object Storage. For CI permissions, please refer to Cloud Infinite.
Processing during download: Set action to cos:GetObject, ci:CreateAILicenseRecognitionJobin the authorization policy.
Processing during upload: Set action to cos:PutObject, ci:CreateAILicenseRecognitionJob in the authorization policy.
Processing in the cloud: Set action to cos:GetObject, cos:PutObject, ci:CreateAILicenseRecognitionJob in the authorization policy (Note: The resource corresponding to GetObject is the source file, and the resource corresponding to PutObject is the processed file).

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Binding CI.
Using this feature requires enabling the AI Content Recognition service in advance through console or API. For details, see Enable AI Content Recognition Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Specifications and Limits.

Fee Description

This API is a paid service. The incurred fees will be collected by Cloud Infinite. For detailed billing information, see Content Recognition Expenses.

Information Description

Front side of ID card: including name, gender, ethnicity, date of birth, address, identification number. Main page of driving license: including license number, name, gender, nationality, address, date of birth, initial issuance date, permitted vehicle type, validity period, issuing unit.

Request

Request Sample

Original image stored in COS
GET /<ObjectKey>?ci-process=AILicenseRec&CardType=IDCard HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Original image from other link
GET /?ci-process=AILicenseRec&CardType=IDCard&detect-url=<detect-url> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Note:
Authorization: Auth String. For details, see Request Signature documentation.

Request Parameters

Parameter
Description
Type
Required
ObjectKey
Object filename, for example: folder/document.jpg
String
Yes
ci-process
Cloud Infinite processing capability AILicenseRec
String
Yes
detect-url
You can process any publicly accessible image link by filling in detect-url. If detect-url is not filled in, the backend will default to processing ObjectKey. If detect-url is filled in, the backend will process the detect-url link, and there is no need to fill in ObjectKey.
http://www.example.com/abc.jpg needs to be url-encoded, and the processed result is http%25253A%25252F%25252Fwww.example.com%25252Fabc.jpg
String
No
CardType
Card OCR type, default is DriverLicense. Valid values:
IDCard: Refers to an identity card.
DriverLicense: Refers to a driver's license.
String
Yes

Request Header

Common Header

This API uses common request headers. For details, see Common Request Headers documentation.

Special Header

This request has no special request header information.

Request Body

This request has no request body.

Response

Response Header

Common Response Header

This API returns common response headers. For details, see Common Response Header documentation.

Special Response Header

There are no special response headers for this operation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <Status>1</Status>
    <IdInfo>
        <Name>Name</Name>
        <DetectedText>xxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>553,439</Point>
            <Point>553,576</Point>
            <Point>989,576</Point>
            <Point>989,439</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Gender</Name>
        <DetectedText>Male</DetectedText>
        <Score>98</Score>
        <Location>
            <Point>541,597</Point>
            <Point>541,723</Point>
            <Point>798,723</Point>
            <Point>798,597</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Ethnicity</Name>
        <DetectedText>Han</DetectedText>
        <Score>98</Score>
        <Location>
            <Point>1032,599</Point>
            <Point>1032,725</Point>
            <Point>1265,725</Point>
            <Point>1265,599</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Birth (Date)</Name>
        <DetectedText>December 1, 1974</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>532,748</Point>
            <Point>532,906</Point>
            <Point>1346,906</Point>
            <Point>1346,748</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Address</Name>
        <DetectedText>Hu’nan Province xxxxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>534,931</Point>
            <Point>534,1253</Point>
            <Point>1587,1253</Point>
            <Point>1587,931</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Identification Number (ID Number)</Name>
        <DetectedText>43xxxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>842,1372</Point>
            <Point>842,1615</Point>
            <Point>2284,1615</Point>
            <Point>2284,1372</Point>
        </Location>
    </IdInfo>
</Response>
The data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None
Container for saving results
Container
The content of Response:
Node Name (Keyword)
Parent Node
Description
Type
Status
Response
Card OCR result, 1: Result identified 0: No result identified
Integer
IdInfo
Response
Card OCR information.
String
The content of the IdInfo node:
Node Name (Keyword)
Parent Node
Description
Type
Name
IdInfo
Name of the field
String
Score
IdInfo
Confidence of the field, value range: [0-100], the higher the value, the greater the probability.
Integer
Location
IdInfo
Coordinates of the field identified in the driving license
Container
The content of the Location node:
Node Name (Keyword)
Parent Node
Description
Type
Point
Location
Driving license info coordinate point (X coordinate, Y coordinate)
String

Error Codes

For common error messages, please refer to the Error Codes documentation.

Practical Example

Using template ID.

Request

GET /<ObjectKey>?CardType=IDCard&ci-process=AILicenseRec HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************
Host:bucket-1250000000.cos.ap-beijing.myqcloud.com

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 414641
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-cos-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=

<Response>
    <Status>1</Status>
    <IdInfo>
        <Name>Name</Name>
        <DetectedText>xxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>553,439</Point>
            <Point>553,576</Point>
            <Point>989,576</Point>
            <Point>989,439</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Gender</Name>
        <DetectedText>Male</DetectedText>
        <Score>98</Score>
        <Location>
            <Point>541,597</Point>
            <Point>541,723</Point>
            <Point>798,723</Point>
            <Point>798,597</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Ethnicity</Name>
        <DetectedText>Han</DetectedText>
        <Score>98</Score>
        <Location>
            <Point>1032,599</Point>
            <Point>1032,725</Point>
            <Point>1265,725</Point>
            <Point>1265,599</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Birth (Date)</Name>
        <DetectedText>December 1, 1974</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>532,748</Point>
            <Point>532,906</Point>
            <Point>1346,906</Point>
            <Point>1346,748</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Address</Name>
        <DetectedText>Hu’nan Province xxxxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>534,931</Point>
            <Point>534,1253</Point>
            <Point>1587,1253</Point>
            <Point>1587,931</Point>
        </Location>
    </IdInfo>
    <IdInfo>
        <Name>Identification Number (ID Number)</Name>
        <DetectedText>43xxxx</DetectedText>
        <Score>99</Score>
        <Location>
            <Point>842,1372</Point>
            <Point>842,1615</Point>
            <Point>2284,1615</Point>
            <Point>2284,1372</Point>
        </Location>
    </IdInfo>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback