tencent cloud

All product documents
APIs
DocumentationAPIsOptical Character RecognitionCard and Document OCR APIsRecognizeBrazilIDCardOCR
RecognizeBrazilIDCardOCR
Last updated: 2025-03-21 14:48:20
RecognizeBrazilIDCardOCR
Last updated: 2025-03-21 14:48:20

1. API Description

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

This interface supports identification of the front and back of Brazilian ID license. The identification fields include name, driver's license category, number, validity period, etc.

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: RecognizeBrazilIDCardOCR.
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 does not exceed 7M after Base64 encoding. Image download time does 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.
BackImageBase64 No String Base64 value of the image on the back of the card. 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. An ImageUrl and ImageBase64 must be provided. If both are provided, only ImageUrl will be used.
BackImageUrl No String The URL address of the image on the back of the card. Supported image formats: PNG, JPG, JPEG, GIF format is not supported yet. Supported image size: The downloaded image does not exceed 7M after Base64 encoding. The image download time does not exceed 3 seconds. The URL of the image stored in Tencent Cloud can ensure higher download speed and stability. It is recommended to store the image in Tencent Cloud. The speed and stability of the URL stored outside Tencent Cloud may be affected to a certain extent.
ReturnHeadImage No Boolean Whether to return portrait photos.

3. Output Parameters

Parameter Name Type Description
Nome String Name
MemberShip String Family information
DataNascimento String Birthday
IssuingAgency String Issuing agency
Fatorrh String blood type
NaturalIDade String Birth place
Observations String Additional information
CPF String CPF
DNI String DNI
RegistroGeral String universal registration
DispatchDate String Issue date
Registro String address
PortraitImage String Portrait image
DocOrigem String Original identity information
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 RecognizeBrazilIDCardOCR Example

Input Example

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

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

Output Example

{
    "Response": {
        "CPF": "400123456/99",
        "DNI": "",
        "DataNascimento": "09/09/1999",
        "DispatchDate": "21/09/2017",
        "DocOrigem": "XXXX-SP XXXXX DE XXXXX CN:LV.A91/XXXX.111/N 1111",
        "Fatorrh": "",
        "IssuingAgency": "XXXX-SP",
        "MemberShip": "XXXX XXX XXX/XXXX XXX XXX",
        "NaturalIDade": "XXXX- SP",
        "Nome": "XXXX XXXX XXX",
        "Observations": "",
        "PortraitImage": "",
        "Registro": "",
        "RegistroGeral": "52.111.11-4 2 via",
        "RequestId": "ace7b820-6476-440f-be2f-0dd1ce762562"
    }
}

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

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 avaliable.

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