tencent cloud

RecognizeMexicoVTID
Last updated: 2025-06-25 11:48:56
RecognizeMexicoVTID
Last updated: 2025-06-25 11:48:56

1. API Description

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

This interface supports identification of the front and back of Mexican Voter ID Card. The default interface request frequency limit is 5 times per second.

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: RecognizeMexicoVTID.
Version Yes String Common Params. The value used for this API: 2018-11-19.
Region No String Common Params. This parameter is not required.
ImageBase64 No String Base64 value of the image. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image should not exceed 7M after Base64 encoding. Image downloading time should not exceed 3 seconds.
ImageUrl No String URL address of the image. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image should not exceed 7M after Base64 encoding. Image download time should not exceed 3 seconds. URLs of images stored in Tencent Cloud can guarantee higher download speed and stability. It is recommended that images be stored in Tencent Cloud. The speed and stability of URLs not stored in Tencent Cloud may be affected to a certain extent.
ReturnHeadImage No Boolean Whether to return portrait photos.

3. Output Parameters

Parameter Name Type Description
Name String Name
Sex String Sex
Address String Address
VotePIN String Vote PIN Code
CURP String Unique Population Registry Code
Birth String Birthday
SECCION String Section Number
IssueDate String IssueDate
ValidDate String ValidDate
State String State
City String City
Locality String Locality
EMISION String Edition
PortraitImage String Portrait image base64
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 RecognizeMexicoVTID Example

Input Example

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

{
    "ImageBase64": "/9j/4AAQSkZJRg.....s97n//2Q==",
    "ImageUrl": "",
    "ReturnHeadImage": false
}

Output Example

{
    "Response": {
        "Address": "C. xxx 3080 xxxx 11111, xxxx.",
        "Birth": "19/01/1980",
        "CURP": "xxx11112222",
        "City": "",
        "EMISION": "",
        "IssueDate": "2003 01",
        "Locality": "",
        "Name": "xxxx xxxx",
        "PortraitImage": "",
        "RequestId": "6e773a78-69d6-4330-8001-d81f1840550b",
        "SECCION": "0703",
        "Sex": "H",
        "State": "",
        "ValidDate": "2022-2032",
        "VotePIN": "xxxxx"
    }
}

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.UnKnowError Unknown error.
FailedOperation.UnOpenError The service is not activated.
LimitExceeded.TooLargeFileError The file is too large.
ResourceUnavailable.ResourcePackageRunOut The account resource package is exhausted.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback