​
Usage

Copy the code block, replace YOUR_API_KEY with your API key, then process documents quickly.
from abbyy_document_ai import DocumentAi

with DocumentAi(api_key_auth=YOUR_API_KEY) as document_ai:
  res = document_ai.models.customs_declaration.begin_field_extraction(input_source={
    "url": "https://example.com/document.pdf",
  })

  assert res.documents is not None
  doc_id = res.documents[0].id

  processed = False
  while not processed:
      time.sleep(3)  # Wait 3 seconds between checks
      res = document_ai.models.customs_declaration.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.customs_declaration.meta.status == "Processed"

  print(res.customs_declaration.fields)

​
Extracted Fields

Field NameDescription
Declaration InformationInformation about the customs declaration.
  Declaration NumberThe customs declaration number.
  Declaration TypeThe type of customs declaration.
  Declaration DateThe date of the customs declaration.
  Declaration OfficeThe customs office where the declaration is filed.
Movement Reference NumberThe Movement Reference Number (MRN).
Movement Reference Number BarcodeThe MRN barcode.
Issuing DateThe date on which the declaration was issued.
Customs OfficeThe customs office identifier.
Forms (repeating group)Information about the declaration forms.
  Part 1The declaration page number.
  Part 2The total number of pages.
Security DeclarationSpecifies whether the declaration contains additional risk analysis documents regarding the transported goods.
ItemsThe number of items in the shipment.
Total PackagesThe total number of packages.
Reference Number (repeating group)The reference number (for tracking).
Transport Charges Method of Payment CodeThe code for the method of payment used to cover transport charges.
ConsignorInformation about the consignor.
  NameThe consignor’s name.
  AddressThe consignor’s address.
  EORI NumberThe consignor’s Economic Operators Registration and Identification (EORI) number.
ConsigneeInformation about the consignee.
  NameThe consignee’s name.
  AddressThe consignee’s address.
  EORI NumberThe consignee’s Economic Operators Registration and Identification (EORI) number.
Declarant (repeating group)Information about the declarant.
  NameThe declarant’s name.
  AddressThe declarant’s address.
  EORI NumberThe declarant’s Economic Operators Registration and Identification (EORI) number.
Export Country CodeThe consignor’s country code.
Destination Country CodeThe consignee’s country code.
Customs Office of ExitThe customs office where the goods will exit the EU.
Countries of Routing CodesThe codes for countries of routing for the shipment.
Identity of Means of Transport at DepartureThe identifier for the means of transport at departure.
Nationality of Means of Transport at DepartureThe country of registration of the transport at departure.
ContainerSpecifies whether the goods are being shipped in a container.
Identity of Means of Transport at BorderThe identifier for the transport shipping the goods when they are presented at the border.
Nationality of Means of Transport at BorderThe country of registration of the transport shipping the goods when they are presented at the border.
CurrencyThe currency used to specify the value of the goods in the declaration.
TotalThe total value of the shipped goods.
Exchange RateThe currency exchange rate.
Mode of Transport at BorderThe mode of transport used to arrive at the border (road, rail, air, sea).
Internal Mode of TransportThe internal mode of transport of the goods (road, rail, air, sea).
Customs Office of ExitIdentifier of the customs office that released the goods.
Location of GoodsThe location where the goods are stored before customs clearance.
Gross Weight in KGThe total gross weight of the packaged goods (in kilograms).
Seal NumberThe seal number.
Control by Office of DispatchOther information specified by the customs office.
  ResultThe result of the control by office of dispatch.
  Seals AffixedInformation about seals affixed during control.
  Seals IdentityIdentity information of the seals.
  Time LimitTime limit specified by the control office.

​
Validation Rules

RuleDescription
Check MRN FormatValidates the format of the Movement Reference Number (MRN).
Check Declaration TypeValidates that the declaration type code follows the correct format and contains valid values.
Check EORI NumbersValidates the format of EORI numbers for consignor, consignee, and declarant.
Check Country CodesValidates that the export and destination country codes are valid EU country codes.
Check FormsValidates that the form numbers are sequential and the total matches the actual number of forms.
Check Security DeclarationValidates that the security declaration value is either ‘S’ or empty/0.
Check Reference NumbersValidates the format of reference numbers for tracking.

​
Supported Languages

CountriesLanguages
EU Member StatesEnglish, German, French, Spanish, Italian, Dutch