REST API overview
A REST API for issuing, transferring, and verifying trade documents from your own systems. We are finalising the public documentation. Pilot partners get direct support and hands-on integration help during onboarding.
Detailed endpoint documentation is coming soon.
Interactive API reference, OpenAPI spec, and SDKs are in active development. If you are planning an integration, contact us at info@docushield.live for early access and direct developer support.
Core capabilities
What the API does.
Document operations
Issue new Bills of Lading, transfer title to new holders, surrender documents to carriers, and retrieve status at any point in the document lifecycle.
Verification
Verify any DocuShield document. Confirm document integrity, issuer identity, and current status. Verifiable by anyone, no DocuShield account required.
Webhooks and events
Subscribe to real-time events as documents are issued, transferred, surrendered, verified, or revoked. HMAC-signed payloads for integrity.
Organization and access
Manage organization members, API keys, access scopes, and audit logs. Built for teams operating at scale with multiple roles.
Design principles
Built to be integrated, not just used.
REST and JSON
Standard HTTP methods, JSON bodies, predictable response shapes. No novel protocols to learn.
Bearer token auth
Simple API key authentication. Scoped, rotatable, revocable. Every call is logged and auditable.
Open standards underneath
Documents and title transfers follow the TradeTrust specification. Your integration is portable.
SDKs and tooling
Language SDKs coming with general availability.
Official SDKs for Node.js, Python, and Go are in active development. Pilot developers receive direct library access and sample projects during integration.
Want to integrate before the SDKs ship? Contact us for a developer preview.
Get early API access.
We are onboarding pilot developers now. Tell us what you want to build and we will help you get integrated.
Request access