API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Dangerous Goods Declaration
Get Dangerous Goods Declaration Fields
This endpoint returns an object representing the extracted dangerous-goods-declaration model fields from a document.
GET
/
v1-preview
/
models
/
dangerous-goods-declaration
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.DangerousGoodsDeclaration.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "dangerous-goods-declaration",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Chemical Solutions Ltd",
"address": "123 Industrial Park, Manchester, UK M1 1AA"
},
"consignee": {
"name": "Global Logistics Inc",
"address": "456 Transport Ave, New York, NY 10001"
},
"carrier": {
"name": "Air Freight Express",
"address": "789 Cargo Terminal, JFK Airport, NY 11430"
},
"transportationDocumentNumber": "DGD-2024-001",
"aircraftType": "Boeing 747-400F",
"airportOfDeparture": "Manchester International Airport",
"airportOfDestination": "John F. Kennedy International Airport",
"additionalHandlingInformation": "Keep away from heat sources. Handle with care.",
"shipmentType": "Non-radioactive",
"shippersReferenceNumber": "REF-2024-001",
"lineItems": [
{
"unNumber": "UN1789",
"properShippingName": "Hydrochloric acid",
"numberOfPieces": 5,
"packageType": "4G",
"quantityPerPackage": 10,
"unitOfMeasure": "L",
"classOrDivision": "8",
"packingGroup": "II",
"packingInstruction": "P001",
"overpackUsed": true
}
],
"certification": {
"nameOfSignatory": "John Smith",
"placeAndDate": "Manchester, 2024-03-15"
},
"emergencyTelephoneNumber": "+44 20 7123 4567"
}
}
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 Dangerous Goods Declaration Data Response
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.DangerousGoodsDeclaration.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "dangerous-goods-declaration",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"shipper": {
"name": "Chemical Solutions Ltd",
"address": "123 Industrial Park, Manchester, UK M1 1AA"
},
"consignee": {
"name": "Global Logistics Inc",
"address": "456 Transport Ave, New York, NY 10001"
},
"carrier": {
"name": "Air Freight Express",
"address": "789 Cargo Terminal, JFK Airport, NY 11430"
},
"transportationDocumentNumber": "DGD-2024-001",
"aircraftType": "Boeing 747-400F",
"airportOfDeparture": "Manchester International Airport",
"airportOfDestination": "John F. Kennedy International Airport",
"additionalHandlingInformation": "Keep away from heat sources. Handle with care.",
"shipmentType": "Non-radioactive",
"shippersReferenceNumber": "REF-2024-001",
"lineItems": [
{
"unNumber": "UN1789",
"properShippingName": "Hydrochloric acid",
"numberOfPieces": 5,
"packageType": "4G",
"quantityPerPackage": 10,
"unitOfMeasure": "L",
"classOrDivision": "8",
"packingGroup": "II",
"packingInstruction": "P001",
"overpackUsed": true
}
],
"certification": {
"nameOfSignatory": "John Smith",
"placeAndDate": "Manchester, 2024-03-15"
},
"emergencyTelephoneNumber": "+44 20 7123 4567"
}
}
Assistant
Responses are generated using AI and may contain mistakes.