Extracted Fields

Supported Languages

The Packing List model extracts data from packing lists.

Packing List

A modern, simple, and easy-to-integrate OCR and document processing API service

Document AI API

ABBYY Document AI API is a modern, simple, and easy-to-integrate OCR and document processing API service.

Welcome

Getting started with the Document AI API Technical Preview

Technical Preview

An overview of all available document models and their capabilities for extracting data from various types of documents.

Overview

Introduction

This endpoint returns a list of documents that have been processed by the caller's organization. The list is paginated; use the [RFC 8288-compliant](https://www.rfc-editor.org/rfc/rfc8288) `Link` header on successful responses to obtain previous and/or next pages. The `Link` header may also contain links to the results for each document.

List Documents

Delete Document

This endpoint processes a document using the document-conversion model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Document Conversion

This endpoint retrieves metadata about a document that has been processed with the `document-conversion` model. Note that the response can include an RFC 8288-style `Link` header that may contain links to file downloads.

Get Conversion

This endpoint returns a file containing the OCR results of processing a document with the `document-conversion` model.

Download Converted Document

This endpoint processes a document using the image-to-text model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Image To Text Extraction

This endpoint retrieves a document's text that was created by the `process` operation using the `image-to-text` model.

Get Extracted Text

This endpoint processes a document using the receipt model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Receipt Field Extraction

This endpoint returns an object representing the extracted receipt model fields from a document.

Get Receipt Fields

This endpoint processes a document using the invoice model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Invoice Field Extraction

This endpoint returns an object representing the extracted invoice model fields from a document.

Get Invoice Fields

This endpoint processes a document using the purchase-order model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Purchase Order Field Extraction

This endpoint returns an object representing the extracted purchase-order model fields from a document.

Get Purchase Order Fields

This endpoint processes a document using the remittance-advice model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Remittance Advice Field Extraction

This endpoint returns an object representing the extracted remittance-advice model fields from a document.

Get Remittance Advice Fields

This endpoint processes a document using the delivery-note model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Delivery Note Field Extraction

This endpoint returns an object representing the extracted delivery-note model fields from a document.

Get Delivery Note Fields

This endpoint processes a document using the hotel-invoice model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Hotel Invoice Field Extraction

This endpoint returns an object representing the extracted hotel-invoice model fields from a document.

Get Hotel Invoice Fields

This endpoint processes a document using the taxi-receipt model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Taxi Receipt Field Extraction

This endpoint returns an object representing the extracted taxi-receipt model fields from a document.

Get Taxi Receipt Fields

This endpoint processes a document using the utility-bill model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Utility Bill Field Extraction

This endpoint returns an object representing the extracted utility-bill model fields from a document.

Get Utility Bill Fields

This endpoint processes a document using the us-form-1040 model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin US Form 1040 Field Extraction

This endpoint returns an object representing the extracted us-form-1040 model fields from a document.

Get US Form 1040 Fields

This endpoint processes a document using the us-form-w2 model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin US Form W2 Field Extraction

This endpoint returns an object representing the extracted us-form-w2 model fields from a document.

Get US Form W2 Fields

This endpoint processes a document using the personal-earnings-statement model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Personal Earnings Statement Field Extraction

This endpoint returns an object representing the extracted personal-earnings-statement model fields from a document.

Get Personal Earnings Statement Fields

This endpoint processes a document using the bank-statement model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Bank Statement Field Extraction

This endpoint returns an object representing the extracted bank-statement model fields from a document.

Get Bank Statement Fields

This endpoint processes a document using the air-waybill model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Air Waybill Field Extraction

This endpoint returns an object representing the extracted air-waybill model fields from a document.

Get Air Waybill Fields

This endpoint processes a document using the arrival-notice model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Arrival Notice Field Extraction

This endpoint returns an object representing the extracted arrival-notice model fields from a document.

Get Arrival Notice Fields

This endpoint processes a document using the bill-of-lading model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Bill Of Lading Field Extraction

This endpoint returns an object representing the extracted bill-of-lading model fields from a document.

Get Bill Of Lading Fields

This endpoint processes a document using the certificate-of-origin model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Certificate Of Origin Field Extraction

This endpoint returns an object representing the extracted certificate-of-origin model fields from a document.

Get Certificate Of Origin Fields

This endpoint processes a document using the commercial-invoice model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Commercial Invoice Field Extraction

This endpoint returns an object representing the extracted commercial-invoice model fields from a document.

Get Commercial Invoice Fields

This endpoint processes a document using the dangerous-goods-declaration model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Dangerous Goods Declaration Field Extraction

This endpoint returns an object representing the extracted dangerous-goods-declaration model fields from a document.

Get Dangerous Goods Declaration Fields

This endpoint processes a document using the customs-declaration model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Customs Declaration Field Extraction

This endpoint returns an object representing the extracted customs-declaration model fields from a document.

Get Customs Declaration Fields

This endpoint processes a document using the packing-list model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Packing List Field Extraction

This endpoint returns an object representing the extracted packing-list model fields from a document.

Get Packing List Fields

This endpoint processes a document using the sea-waybill model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Sea Waybill Field Extraction

This endpoint returns an object representing the extracted sea-waybill model fields from a document.

Get Sea Waybill Fields

This endpoint processes a document using the international-consignment-note model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin International Consignment Note Field Extraction

This endpoint returns an object representing the extracted international-consignment-note model fields from a document.

Get International Consignment Note Fields

This endpoint processes a document using the basic-contract model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Basic Contract Field Extraction

This endpoint returns an object representing the extracted basic-contract model fields from a document.

Get Basic Contract Fields

This endpoint processes a document using the brokerage-statement model. Note that the response can include an RFC 8288-style `Link` header that may contain links to results. If multiple documents are sent for processing, there will be a link with rel='results' for each document.

Begin Brokerage Statement Field Extraction

This endpoint returns an object representing the extracted brokerage-statement model fields from a document.

Get Brokerage Statement Fields

Connect and engage with a worldwide community of ABBYY developers, customers, educators, and experts all around the world.

Join the ABBYY Community

Discord

Forum

Twitter

Daily.dev

Blog

Youtube

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Quickstart

Preview changes locally to update your docs

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

Field Name	Description
Shipper	Information about the sender of the goods.
Name	The shipper’s name.
Address	The shipper’s address.
State	The shipper’s state.
City	The shipper’s city.
Street	The shipper’s street address.
Postal Code	The shipper’s postal code.
Country	The shipper’s country.
Consignee	Information about the recipient of the goods.
Name	The consignee’s name.
Address	The consignee’s address.
State	The consignee’s state.
City	The consignee’s city.
Street	The consignee’s street address.
Postal Code	The consignee’s postal code.
Country	The consignee’s country.
Document Information	Information about the packing list document.
Number	The packing list number.
Date	The date when the packing list was issued.
Reference Documents	Information about related documents.
Invoice Number	The reference invoice number.
Purchase Order Number	The reference purchase order number.
Bill of Lading Number	The reference bill of lading number.
Shipping Information	Information about the shipment.
Port of Loading	The port where the goods are loaded.
Port of Discharge	The port where the goods are discharged.
Vessel Name	The name of the vessel.
Voyage Number	The voyage number.
Package Information	Information about the packages.
Total Packages	The total number of packages.
Package Type	The type of packages.
Total Weight	The total weight of all packages.
Total Volume	The total volume of all packages.
Line Items (repeating group)	Information about individual line items.
Package Number	The package identification number.
Description	The description of the goods.
Quantity	The quantity of items.
Unit of Measurement	The unit of measurement for the quantity.
Weight	The weight of the line item.
Volume	The volume of the line item.
Country of Origin	The country where the goods originated.
HS Code	The Harmonized System code for the goods.

Get Started

Models

Packing List

Extracted Fields

Supported Languages

Get Started

Models

​Extracted Fields

​Supported Languages

Extracted Fields

Supported Languages