API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Certificate Of Origin
Get Certificate Of Origin Fields
This endpoint returns an object representing the extracted certificate-of-origin model fields from a document.
GET
/
v1-preview
/
models
/
certificate-of-origin
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.CertificateOfOrigin.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"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
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
Path Parameters
The id of the document
Response
200
application/json
Extracted Certificate Of Origin Data Response
Was this page helpful?
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.CertificateOfOrigin.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.