API Documentation

Review the JWT-authenticated account routes and the separate read-only API-key integration surface before production agency connectivity is available.

Overview

The BorderPro early-access API returns JSON and supports local account records; it does not currently transmit production filings to CBP or CBSA or return live agency status. Account endpoints use JWT authentication, while /integration/* endpoints use a read-only API key. The base URL is https://borderpro.ai/api/v1.

Authentication

Obtain a JWT token by posting account credentials to the login endpoint. Include the token as a Bearer header on account requests. Company admins can then create read-only integration keys; those keys are sent directly in X-API-Key and are never exchanged for a JWT.

# Request
POST /api/v1/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "your-password"
}

# Abbreviated response
{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {"id": 123, "role": "dispatcher"}
  }
}

# JWT account request
Authorization: Bearer <token>

# Read-only integration request
GET /api/v1/integration/manifests
X-API-Key: <key>

Key Endpoints

Endpoint Description Auth
GET /manifests List company-scoped stored records JWT
POST /manifests Create an ACE or ACI local draft record JWT
GET /manifests/:id Read a local record and its stored workflow state JWT
GET /rns List RNS rows already stored for the account; not a live agency feed JWT
GET /trucks List saved truck profiles JWT
GET /drivers List saved driver profiles JWT
GET /billing/usage Read the account's stored usage and tier values JWT
POST /api-keys Create a company-scoped integration key; secret returned once JWT admin
GET /integration/manifests Read company-scoped manifest summaries X-API-Key
GET /integration/rns Read company-scoped stored RNS rows; not a live agency feed X-API-Key

This is a verified route summary, not a complete production API contract. Check the response returned by your early-access account and do not use live regulated cargo data unless your onboarding instructions authorize it. Join early access to test the draft workflow.

Join the API Early Access

Evaluate local account records and read-only integration endpoints. Production government submission will remain disabled until agency certification is complete.