API Reference | Digicust - AI-Powered Customs Automation

API Digicust

REST, SFTP, Email, MCP và Webhooks. Mọi phương thức tích hợp Digicust tại một nơi. Chọn phương thức phù hợp với hệ thống của bạn và bắt đầu vận hành.

Mở Swagger UI Tải xuống OpenAPI JSON

Chuyển đếnAuthentication REST API SFTP Email MCP Webhooks Phân loại thuế quan Trade compliance

Bắt đầu trong hai bước

Hầu hết các tích hợp đều hoạt động trong vòng một buổi chiều. Hãy tạo các khóa API theo phạm vi, trỏ máy khách của bạn đến URL cơ sở của EU và bắt đầu gửi các trường hợp.

1. Create API keys

Generate scoped, revocable API keys directly in the platform. Use them for server-to-server integrations, ERP feeds or automation scripts.

Open the platform

2. Explore the OpenAPI spec

Browse every endpoint in the interactive Swagger UI, or download the full OpenAPI 3.0 specification as JSON or YAML.

Mở Swagger UI

Authentication

Khóa API cho máy móc, phiên làm việc cho con người

Sử dụng khóa API cho tích hợp máy chủ với máy chủ và mã thông báo phiên cho các ứng dụng người dùng. Cả hai đều xác thực với cùng các điểm cuối; chọn phương thức phù hợp với quy trình của bạn.

Khóa API có tiền tố `dgc_`, được giới hạn theo dự án và có thể thu hồi từ nền tảng.
Mã thông báo phiên được cấp bởi xác thực gốc của Digicust cho ứng dụng web, tiện ích bổ sung Excel và bất kỳ người dùng nào đã đăng nhập.
Tiêu đề Gửi `Authorization: Bearer <key>` hoặc `X-API-Key: <key>`. Cả hai đều được chấp nhận.

Yêu cầu đã xác thực

curl -X GET "https://api.eu.digicust.com/api/{orgId}/{projectId}/cases" \
  -H "Authorization: Bearer dgc_1234567890abcdef1234567890abcdef"

REST API

Full REST API with OpenAPI 3.0

Drive every Digicust capability over standard REST. Cases, conversations, strategies, integrations, mappings, MCP servers, API keys, tariff classification and trade-compliance checks are all addressable with the same authentication and shape.

Authenticate with `Authorization: Bearer dgc_…` API keys or a session token from the Digicust login.
One-step `cases/create-and-process` accepts files plus metadata in a single multipart request.
Async `classify-batch` for large catalogues with WebSocket progress events.
Polling and webhook patterns documented with copy-paste JS and Python examples.
Full OpenAPI spec downloadable as JSON or YAML.

Mở Swagger UI

api.eu.digicust.com/docs

Swagger UI

Digicust API

v3.0.0 · OpenAPI 3.0 · api.eu.digicust.com

Live

Lọc theo thẻ, đường dẫn hoặc hoạt động

cases

POST/{orgId}/{projectId}/cases/create-and-processCreate + process a case
Nội dung yêu cầu (multipart)
- filesFile[]
- caseDataJSON
- strategyIdstring
- messagestring
Phản hồi
- 200Hồ sơ đã được tạo và bắt đầu xử lý
- 401Khóa API bị thiếu hoặc không hợp lệ
- 429Vượt quá giới hạn tốc độ
cURLmultipart/form-data
```
curl -X POST "https://api.eu.digicust.com/api/{orgId}/{projectId}/cases/create-and-process" \
  -H "Authorization: Bearer dgc_your-api-key" \
  -F "files=@invoice.pdf" \
  -F 'caseData={"reference":"CASE-2026-001"}'
```
GET/{orgId}/{projectId}/cases/{caseId}Get case status
POST/{orgId}/{projectId}/classify-batchAsync tariff classification
POST/{orgId}/{projectId}/trade-compliance/checkRun compliance checks
POST/{orgId}/{projectId}/integrationsCreate an integration
GET/organizations/{orgId}/projects/{projectId}/api-keysList API keys

13 thẻ · 82 hoạt động

JSON YAML Dùng thử trực tiếp

SFTP

SFTP for legacy file flows

When an ERP, customs broker or partner can only speak files, Digicust drops processed cases on SFTP and picks up new ones from a watched folder. Same pipelines, same audit trail, no new schema for them to learn.

Outbound: push processed declarations, structured payloads or PDF outputs to your SFTP server.
Pre-built SFTP profiles for Scope, DAKOSY, E2OPEN, MERCURIO and DBH.
Inbound: drop documents into a strategy folder; Digicust creates the case automatically.
Password and key-based authentication with optional passphrase.
Optional FTP fallback for partners that have not migrated to SFTP.

Configure an SFTP integration

{
  "name": "Export to SFTP",
  "type": "SFTP",
  "enabled": true,
  "config": {
    "sftp": {
      "host": "sftp.example.com",
      "port": 22,
      "username": "sftp-user",
      "privateKeyBase64": "LS0tLS1CRUdJTi…",
      "remotePath": "/exports/customs"
    }
  }
}

Email gateway for documents and follow-ups

Every strategy gets its own ingest email address; every case gets its own follow-up address. Send PDFs, EML, MSG or even photos and Digicust opens the case, parses attachments, classifies the goods and replies in your team's voice.

Per-strategy ingest address creates new cases automatically.
Per-case reply address attaches incoming mail to the open case.
Document control agent can chase suppliers, brokers or carriers in their own language.
Notifications on processing start, completion and SLA breaches.
Custom email gateway endpoint for teams that want to relay through their own MTA.

Thư · Digicust

Đã kết nối

Tìm kiếm hộp thư đến

imports-de@routing.digicust.exampletheo ngày

ALPHATEX SRL
09:14
Re: Invoice INV-2026-0481 + packing list
Attached the corrected packing list as requested. Please confirm receipt.
packing-list-INV-2026-0481.pdf
Demo Components AG
08:42
LTSD signed for 2026 catalogue
Bitte bestätigen Sie den Erhalt der unterzeichneten Lieferantenerklärung.
LTSD-2026-DEMO.pdf
DAKOSY notifications
08:31
ATLAS reference 26DE12345 released
Customs released 4 line items. ABD attached.
ABD-26DE12345.pdf
TANGENS Spedition
Yesterday
Rückfrage zur Sendung 0481
Können Sie die Tarifnummer zu Position 3 noch einmal prüfen?

Re: Invoice INV-2026-0481 + packing list

ASALPHATEX SRL·To: imports-de@routing.digicust.exampleToday 09:14

Tự động đính kèm vào hồ sơ DE-IMP-2026-0481

Xin chào,

vui lòng xem danh sách đóng gói đã sửa cho hóa đơn INV-2026-0481 đính kèm. Kích thước cho dòng 3 đã được cập nhật theo yêu cầu của bạn.

Trân trọng,
ALPHATEX SRL · logistics desk

1 tệp đính kèm

PDF

packing-list-INV-2026-0481.pdf

168 KB · Được phân tích bởi tác nhân Digicust

Đã tiếp nhận 09:14 · trường hợp đã cập nhật lúc 09:14

MCP

Model Context Protocol, first-class

Digicust speaks MCP, the open protocol that connects AI agents to external tools. Plug your own MCP server in to extend the Digicust agent with custom tools and data sources, or expose Digicust's customs tools to your own LLM apps.

SSE, HTTP and stdio transports supported.
Bring your own auth: bearer token, API key or basic.
Per-strategy enabling so the agent only sees the tools it should use.
Available tools surface live during case processing, no redeploy required.
Use the Digicust MCP server from any LLM app to run customs workflows on demand.

{
  "name": "Custom Tools Server",
  "transport": "sse",
  "url": "https://your-mcp-server.com/sse",
  "auth": { "type": "bearer", "token": "your-mcp-token" },
  "enabled": true
}

Webhooks

Webhooks for outbound events

Get notified the moment a case is processed, a finding is raised or a strategy event fires. Webhooks are configured per-strategy and can be paired with mappings to deliver exactly the payload your system expects.

POST/PUT/GET/DELETE delivery with custom headers.
None, Basic, Bearer or Keycloak OAuth2 authentication.
Pair with a mapping to transform the case into your downstream schema.
Automatic retries (3 attempts, 60s timeout) with delivery audit log.
Receive base64-encoded attachments alongside the structured payload.

Webhook payload (excerpt)

{
  "caseId": "6501234567890abcdef12345",
  "reference": "CASE-2026-001",
  "timestamp": "2026-01-15T10:35:00Z",
  "data": {
    "invoiceNumber": "INV-2026-001",
    "items": [
      { "description": "Widget A", "hsCode": "8473.30.20", "value": 2550.00 }
    ]
  }
}

API phân loại mã HS

Mã HS kèm lý do, phương án thay thế và tham chiếu BTI

Phân loại đơn lẻ hoặc hàng loạt (tối đa 10) với lập luận GR1 đến GR6 rõ ràng, điểm tin cậy và các mã thay thế. Sử dụng điểm cuối hàng loạt bất đồng bộ cho toàn bộ danh mục với các sự kiện tiến trình WebSocket.

Phân loại mô tả hàng hóa

curl -X POST "https://api.eu.digicust.com/api/{orgId}/{projectId}/tools/tariff-classification" \
  -H "Authorization: Bearer dgc_your-api-key" \
  -H "Content-Type: application/json" \
  -d '{ "goodsDescription": "USB-A to USB-C cable, 2m, copper" }'

API tuân thủ thương mại

Trừng phạt, lưỡng dụng, cấm vận, CBAM, tái xuất Mỹ

Một điểm cuối thực hiện kiểm tra mặt hàng (kiểm soát xuất/nhập khẩu, cấm vận, CBAM, tái xuất khẩu của Mỹ) và sàng lọc các bên dựa trên danh sách các bên bị từ chối toàn cầu, với điểm rủi ro có cấu trúc.

Kiểm tra mặt hàng + đối tác

curl -X POST "https://api.eu.digicust.com/api/{orgId}/{projectId}/trade-compliance/check" \
  -H "Authorization: Bearer dgc_your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "itemChecks": [{ "customsTariffNumber": "8456301000", "destinationCountry": "CN" }],
    "partyChecks": [{ "name": "Acme Corporation Ltd.", "role": "buyer" }]
  }'

Được xây dựng cho sản xuất

Global coverage

Submission-ready data for ATLAS, AES, NCTS, ASYCUDA, DAKOSY, AEB, Format, Scope, Mercurio and more across 30+ countries.

Async + sync

Sync endpoints for short-lived calls, async pipelines for batches and long-running classifications, with WebSocket progress events.

Enterprise security

API key plus session-based authentication, scoped keys, instant revocation, audit log on every action, GDPR-aligned EU hosting.

Lưu ý bảo mật: Giữ khóa API ngoài mã phía máy khách, xoay vòng định kỳ và thu hồi bất kỳ khóa nào có thể đã bị rò rỉ. Liên hệ với bộ phận hỗ trợ nếu bạn nghi ngờ bị xâm phạm. Các khóa có thể được thu hồi ngay lập tức.

Sẵn sàng tích hợp?

Tạo khóa API và bắt đầu với dự án sandbox, hoặc trao đổi với chúng tôi trước về hình thức tích hợp phù hợp với hệ thống của bạn.

Mở Swagger UI Liên hệ hỗ trợ