Developer API
Build against the whole transaction journey.
Nine governed API families connect partner identity, commercial instruments, evidence, execution, finance and settlement to one transaction context.
REST
Versioned OpenAPI contract
Events
Signed CloudEvents webhooks
Access
API-key scopes plus transaction grants
API product families
From partner onboarding to confirmed settlement.
Each family includes its endpoint catalogue, scopes, domain rules, events and a complete Postman example.
Partner & organisation APIs
Register partner applications, resolve legal organisations and preserve namespaced identifiers without creating duplicate trading identities.
7 endpoints · 4 events
KYB & trust APIs
Submit provider checks, evidence and recommendations while preserving TradeVow’s separate policy and manual-review decision.
6 endpoints · 4 events
Transaction APIs
Create and manage the canonical Transaction 360 record that anchors parties, requirements, evidence, execution, finance and settlement.
10 endpoints · 5 events
Trade instrument APIs
Link opportunities, RFQs, quotes, purchase orders, contracts and invoices to the transaction without forcing partners into one commercial workflow.
7 endpoints · 5 events
Evidence & document APIs
Register, verify and share evidence metadata, governed document references and transaction evidence packs.
6 endpoints · 5 events
Logistics & execution APIs
Connect shipments, transport documents, execution milestones and exceptions to the commercial transaction and its readiness state.
6 endpoints · 5 events
Compliance & rules APIs
Turn corridor rules into machine-readable transaction requirements, evaluations, evidence needs and explainable decisions.
5 endpoints · 5 events
Finance-readiness APIs
Expose permissioned readiness signals and funder submissions built from verified transaction execution rather than a disconnected application journey.
6 endpoints · 5 events
Settlement APIs
Coordinate settlement instructions, conditions and payment evidence in the transaction context without assuming TradeVow always moves or holds funds.
5 endpoints · 5 events
First integration
Create once. Retry safely. Follow the events.
The public contract distinguishes partner-reported facts from TradeVow decisions. Material commands are idempotent, traceable and subject to transaction-level permissions.
✓ Idempotent commands
✓ Purpose-bound projections
✓ Occurrence and recording time
✓ Correlation and causation
curl -X POST https://sandbox-api.tradevow.com/v1/transactions \
+ -H "X-TradeVow-API-Key: $TRADEVOW_API_KEY" \
+ -H "Idempotency-Key: 01TV-CONNECT-117" \
+ -H "Content-Type: application/json" \
+ -d '{
"source": "partner_platform",
"source_reference": "PO-89431",
"corridor": {
"origin_country": "BW",
"destination_country": "GB"
},
"commercial_value": {
"amount": "48500.00",
"currency": "GBP"
}
}'Postman workspace
One collection. Nine API families. A connected variable chain.
The collection includes environment variables, scoped API-key authentication, idempotency headers, sample bodies and test scripts that retain identifiers between requests.