RecognizeBrazilRNEOCR

Download PDF

Last updated: 2025-04-18 15:04:14

RecognizeBrazilRNEOCR

Last updated: 2025-04-18 15:04:14

Download PDF

1. API Description

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

Brazil RNE document recognition Default interface request frequency limit: 5 times/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: RecognizeBrazilRNEOCR.
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.
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
RNE	String	RNE
CLASSIFICATION	String	Classification
VALIDADE	String	Valid date
NOME	String	Name
Membership	String	Family information
NACIONALIDADE	String	Nationality
NATURALIDADE	String	Place of Birth
IssuingAgency	String	Issuing agency
DateOfBirth	String	Birthday
Sex	String	Gender
EntryDate	String	Date of entry
VIA	String	VIA
DispatchDate	String	Dispatch date
MRZ	String	MRZ
PortraitImage	String	PortraitImage 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 RecognizeBrazilRNEOCR 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": false
}

Output Example

{
    "Response": {
        "CLASSIFICATION": "PERMANENTE",
        "DateOfBirth": "01/01/2001",
        "DispatchDate": "01/01/2001",
        "EntryDate": "01/01/2001",
        "IssuingAgency": "CGPI/DIREX/DPF",
        "MRZ": "AAAAA AAAA AAAA 111111",
        "Membership": "",
        "NACIONALIDADE": "CHINESA",
        "NATURALIDADE": "REP.POPULAR DA CHINA",
        "NOME": "XXXX CHEN",
        "PortraitImage": "",
        "RNE": "G1111-8",
        "RequestId": "9681c688-e523-4f7e-9672-238e817b4e64",
        "Sex": "M",
        "VALIDADE": "26/10/2025",
        "VIA": "1"
    }
}

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

Tencent Cloud CLI 3.0

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. This error may be caused by unstable network connections,service anomalies or other issues.
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

Feedback

tencent cloud