Transportation License OCR
Function
Transportation License OCR recognizes the text on the first page of a road transportation license and returns the structured information in JSON format. For details about the constraints on using this API, see Constraints. For details about how to use this API, see Introduction to OCR.
Prerequisites
Before using Transportation License OCR, you need to apply for the service and complete authentication. For details, see Subscribing to OCR and Authentication.
URI
POST https://{endpoint}/v2/{project_id}/ocr/transportation-license
| Parameter | Mandatory | Description |
|---|---|---|
| endpoint | Yes | Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services in different regions. For more details, see Endpoints. For example, the endpoint of OCR in the CN North-Beijing4 region is ocr.cn-north-4.myhuaweicloud.com. |
| project_id | Yes | Project ID, which can be obtained from Obtaining a Project ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token During API authentication using a token, the token is added to requests to obtain permissions for calling the API. The value of X-Subject-Token in the response header is the obtained token. |
| Content-Type | Yes | String | MIME type of the request body. The value is application/json. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| image | No. Set either this parameter or url. | String | Base64 character string converted from the image. The size cannot exceed 10 MB. The narrow edge contains at least 15 pixels and the wide edge contains at most 4,096 pixels. The JPEG, JPG, PNG, BMP, and TIFF formats are supported. |
| url | No. Set either this parameter or image. | String | Image URL. Currently, the following URLs are supported:
NOTE:
|
Response Parameters
Response parameters and status codes vary in different recognition results. They are described as below.
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| result | TransportationLicenseResult object | Calling result of a successful API call. This parameter contains 6 main fields and other fields that can be extracted. This parameter is not included when the API fails to be called. |
| Parameter | Type | Description |
|---|---|---|
| owner_name | String | Owner's name |
| license_number | String | Transportation license number |
| vehicle_number | String | License plate number |
| vehicle_type | String | Vehicle type |
| vehicle_weight | String | Tonnage (seats) |
| vehicle_size | String | Vehicle dimensions |
| issuing_authority | String | Issuing authority. This parameter is optional, depending on the transportation license layout. |
| issue_date | String | Date of issue. This parameter is optional, depending on the transportation license layout. |
| owner_address | String | Owner's address. This parameter is optional, depending on the transportation license layout. |
| economic_type | String | Economic type. This parameter is optional, depending on the transportation license layout. |
| business_certificate | String | Business license number. This parameter is optional, depending on the transportation license layout. |
| business_scope | String | Common goods transportation on roads. This parameter is optional, depending on the transportation license layout. |
| confidence | Object | Confidence of related fields. A higher confidence indicates a more accurate result. The confidence is not equal to the accuracy, and is calculated through related algorithms. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code of a failed API call. For details, see Error Codes. If error code ModelArts.4204 is displayed, refer to Why Is a Message Stating "ModelArts.4204" Displayed When the OCR API Is Called? This parameter is not included when the API is successfully called. |
| error_msg | String | Error message returned when the API fails to be called This parameter is not included when the API is successfully called. |
Request Example
- The endpoint is the request URL for calling an API. Endpoints vary depending on services and regions. For details, see Endpoints.
For example, Transportation License OCR is deployed in the CN North-Beijing4 region. The endpoint is ocr.cn-north-4.myhuaweicloud.com. The request URL is https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/transportation-license. project_id is the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
- For details about how to obtain a token, see Making an API Request.
- Request example (Method 1: Use the image Base64 string.)
POST https://{endpoint}/v2/{project_id}/ocr/transportation-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } - Request example (Method 2: Use the image URL.)
POST https://{endpoint}/v2/{project_id}/ocr/transportation-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" } - Sample code for a Python 3 request (For codes in other languages, refer to the following sample or use OCR SDK.)
# encoding:utf-8 import requests import base64 url = "https://{endpoint}/v2/{project_id}/ocr/transportation-license" token = "Actual token value obtained by the user" headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} imagepath = r'./data/transportation-license-demo.png' with open(imagepath, "rb") as bin_data: image_data = bin_data.read() image_base64 = base64.b64encode(image_data).decode("utf-8") # Base64 encoding of images. payload = {"image": image_base64} # url or image. response = requests.post(url, headers=headers, json=payload) print(response.text)
Example Response
Status code: 200
Successful response example
{
"result": {
"owner_name": "Owner name recognized from the image",
"license_number": "License number recognized from the image",
"vehicle_number": "Vehicle number recognized from the image",
"vehicle_type": "Vehicle type recognized from the image",
"maximum_capacity": "Maximum capacity recognized from the image",
"vehicle_size": "Vehicle size recognized from the image",
"issuing_authority": "Issuing authority recognized from the image",
"issue_date": "2014-11-16",
"confidence": {
"owner_name": 0.9963,
"license_number": 0.9988,
"vehicle_number": 0.9999,
"vehicle_type": 1.0,
"vehicle_weight": 0.9793,
"vehicle_size": 1.0,
"issuing_authority": 0.9983,
"issue_date": 1.0
}
}
} Status code: 400
Failure response example
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Success response |
| 400 | Failure response |
For details about status codes, see Status Codes.
Error Codes
For details about error codes, see Error Codes.
Last Article: Business License OCR
Next Article: Plate Number OCR
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.