Quickstart

This section helps an Integrating System get started with issuing and managing TradeTrust-compliant electronic trade documents (eBL, ePN, ETRs) using BlockPeer Trade APIs.

Prerequisites

Before calling Trade APIs, ensure the following:

1️⃣ Authentication is completed

  • The Integrating System must authenticate End Users via the Auth APIs
  • End Users must be registered and able to approve actions using passkeys

👉 See Auth → QuickStart


2️⃣ A Token Registry is available

  • All TradeTrust eBL / ETRs are issued against a Token Registry
  • The registry defines roles and control rules for documents

If you don’t already have a registry:

  • Use Create Token Registry
  • Wait for deployment completion
  • Configure roles as needed

3️⃣ End Users are available for approval

  • All eBL / ETR issuance and management actions require:
    • A redirect URL
    • Explicit approval by the End User
    • Approval using End User passkeys only

There is no background or automated approval.


Typical quickstart flow

For most Integrating Systems, the Trade API flow looks like this:

  1. Create or identify a Token Registry
  2. Issue an eBL or ePN
  3. Redirect the End User for approval
  4. Manage the document lifecycle (transfer, endorse, return)
  5. Verify documents when required

Key takeaway

Trade APIs allow Integrating Systems to manage eBL / ETR lifecycles using REST APIs, while End Users retain full legal control through explicit approval.