GET
/
v1-preview
/
models
/
certificate-of-origin
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.certificate_of_origin.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.certificate_of_origin is not None

    # Handle response
    print(res.certificate_of_origin)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "certificate-of-origin",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "certificateNumber": "CO123456",
    "serialNumber": "SN789012",
    "countryOfIssue": "United States",
    "exporter": {
      "name": "ACME Manufacturing Inc.",
      "address": "123 Production Ave, Industrial Park, Detroit, MI 48201"
    },
    "consignee": {
      "name": "Global Imports Ltd",
      "address": "456 Commerce Street, London, UK EC2A 4PB"
    },
    "meansOfTransportAndRoute": {
      "cityOfOrigin": "Detroit",
      "countryOfOrigin": "United States",
      "cityOfDestination": "London",
      "countryOfDestination": "United Kingdom",
      "meansOfTransport": "Sea",
      "departureDate": "2024-01-15"
    },
    "invoiceNumbers": [
      {
        "invoiceNumber": "INV123456",
        "invoiceDate": "2024-01-10"
      }
    ],
    "marksAndNumbersOfPackages": "CARTON 1-50",
    "lineItems": [
      {
        "position": 1,
        "numbersAndKindOfPackages": "50 cartons",
        "description": "Industrial machinery parts",
        "hsCode": "8483.30.51",
        "originCriterion": "WO",
        "preferenceCriterion": "A",
        "countryOfOrigin": "United States",
        "quantity": 50,
        "uom": "cartons",
        "netWeight": 2500,
        "grossWeight": 2750,
        "weightUom": "kg"
      }
    ],
    "weight": 2750,
    "weightUom": "kg"
  }
}

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

​
documentId
string
required

The id of the document

Response

200
application/json

Extracted Certificate Of Origin Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "id": "wh23anb5xjf0ntw5taase5qz",
  "name": "document.jpg",
  "createdAt": "2025-02-07T17:44:06.949Z",
  "model": "image-to-text",
  "status": "Processed",
  "pageCount": 10,
  "errors": [{ "message": "Total is required" }]
}
​
fields
object

Fields extracted from a certificate of origin

Example:
{
  "certificateNumber": "CO123456",
  "serialNumber": "SN789012",
  "countryOfIssue": "United States",
  "exporter": {
    "name": "ACME Manufacturing Inc.",
    "address": "123 Production Ave, Industrial Park, Detroit, MI 48201"
  },
  "consignee": {
    "name": "Global Imports Ltd",
    "address": "456 Commerce Street, London, UK EC2A 4PB"
  },
  "meansOfTransportAndRoute": {
    "cityOfOrigin": "Detroit",
    "countryOfOrigin": "United States",
    "cityOfDestination": "London",
    "countryOfDestination": "United Kingdom",
    "meansOfTransport": "Sea",
    "departureDate": "2024-01-15"
  },
  "invoiceNumbers": [
    {
      "invoiceNumber": "INV123456",
      "invoiceDate": "2024-01-10"
    }
  ],
  "marksAndNumbersOfPackages": "CARTON 1-50",
  "lineItems": [
    {
      "position": 1,
      "numbersAndKindOfPackages": "50 cartons",
      "description": "Industrial machinery parts",
      "hsCode": "8483.30.51",
      "originCriterion": "WO",
      "preferenceCriterion": "A",
      "countryOfOrigin": "United States",
      "quantity": 50,
      "uom": "cartons",
      "netWeight": 2500,
      "grossWeight": 2750,
      "weightUom": "kg"
    }
  ],
  "weight": 2750,
  "weightUom": "kg"
}
​
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

Was this page helpful?