API overview

Updated at:

This topic outlines the APIs. Before you can use the console or an SDK, you must complete the prerequisite operations. For more information, see Quick start.

SDK downloads and user guides

You can use an SDK to call the OpenAPI of Document Mind. SDKs are available for Java, Python 3, Node.js, C#, Go, and PHP. The download links are as follows:

SDK language

SDK download link

User guide

Java

Java SDK

Java SDK user guide

Python 3

Python 3 SDK

Python SDK user guide

Node.js

Node.js SDK

Node.js SDK user guide

C#

C# SDK

C# SDK user guide

Go

Go SDK

Go SDK user guide

PHP

PHP SDK

PHP SDK user guide

After you download and decompress the package, see the README.md and README-CN.md files for instructions on how to use each SDK.

Trade document recognition APIs

API

API Overview

Export declaration recognition

Extracts key fields from export declarations, including pre-entry and non-fixed format draft declarations. Supported fields include declaration number, export date, declaration date, declaring entity, and product specifications.

Import declaration recognition

Extracts key fields from import declarations. Supported fields include pre-entry number, customs number, domestic consignee name, port of entry, import date, declaration date, declaring entity, and product specifications.

Sales confirmation recognition

Extracts key fields from Sales Confirmation documents. Supported fields include seller, buyer, contract number, signing date, total price, and product details.

Invoice recognition

Extracts key fields from common international trade invoices, such as commercial invoices, proforma invoices, and non-fixed format tax settlement invoices. Supported fields include invoice number, invoice date, seller, buyer, product or service information, amount exclusive of tax, tax amount, tax rate, and total amount.

Packing list recognition

Extracts key fields from Packing List documents. Supported fields include shipper, consignee, invoice number, invoice date, and product details.

Container load plan recognition

Extracts key fields from Container Load Plan documents. Supported fields include vessel or voyage, container number, seal number, port of loading, port of discharge, place of delivery, bill of lading number, total number of packages, total gross weight, total volume, and product details.

Bill of lading recognition

Extracts key fields from Bill of Lading documents, including master and house bills of lading. Supported fields include shipper, consignee, notify party, bill of lading number, place of receipt, port of loading, port of discharge, place of delivery, voyage, and vessel name.

Air waybill recognition

Extracts key fields from Air Waybills. Supported fields include airline code, waybill number, master waybill number, house waybill number, airport of departure, and carrier.

Sea waybill recognition

Extracts key fields from Sea Waybills. Supported fields include booking number, shipper, consignee, waybill number, voyage, vessel name, and product specifications.

Booking note recognition

Extracts key fields from Booking Note documents. Supported fields include contract number, order number, invoice number, estimated time of departure, place of delivery, container type, container quantity, and product details.

Certificate of origin recognition

Extracts key fields from Certificate of Origin documents, including general certificates, Generalized System of Preferences (GSP) certificates, and Asia-Pacific Trade Agreement certificates. Supported fields include serial number, certificate number, issuing country, exporter, producer, vessel name, and product specifications.