Developer API Early Access

Evaluate a RESTful JSON account API for ACE and ACI draft preparation, plus a separate read-only API-key surface for stored records. Production CBP and CBSA submission is not currently available.

Built for Integration

RESTful JSON

Standard REST architecture with JSON request and response bodies. Works with any language, framework, or HTTP client.

Read-Only API Keys

Use an X-API-Key on the integration endpoints to read stored manifest summaries and recorded RNS rows without a login JWT.

Draft Lifecycle

Create, read, update, and validate manifest drafts programmatically without transmitting them to a government agency.

Integration Controls

Keep JWT-authenticated account operations separate from the read-only API-key integration surface.

Use the Two Authentication Surfaces

Choose JWT account access or a read-only integration key; neither makes BorderPro a production filing channel.

1

Sign In for a JWT

Post account credentials to /api/v1/auth/login. Use the returned bearer token for authorized account endpoints.

2

Work With Draft Records

JWT-authenticated endpoints can create and update local draft data according to the user's role. Do not call a submit action for live cargo during early access.

3

Create a Read-Only Key

A company admin can create a key at /api/v1/api-keys using JWT authentication. The full secret is returned only at creation.

4

Read the Integration API

Send that secret as X-API-Key to /api/v1/integration/*. This surface is read-only and returns only records scoped to the key's company.

Example: Read Stored Manifest Summaries

The API-key integration surface is read-only.

GET /api/v1/integration/manifests?per_page=25
X-API-Key: <your_api_key>

The response contains company-scoped summaries of records already stored in BorderPro. It does not create, submit, amend, or cancel a filing and does not prove a current CBP or CBSA status.

API Features

Tools for evaluating a draft workflow before production agency connectivity launches.

Separate Authentication Modes

Use bearer JWTs for account endpoints and X-API-Key only for the read-only integration routes.

Manifest CRUD

Create, read, update, and delete ACE and ACI drafts, shipments, conveyances, and carrier profiles in the preview workflow.

Draft Status

Read locally stored draft status with GET /api/v1/manifests/:id. Live CBP/CBSA status history is not currently available.

Stored RNS Rows

Read company-scoped notification rows through GET /api/v1/integration/rns. BorderPro does not currently supply live agency status.

Profile Management

JWT-authenticated account endpoints can manage carrier, driver, equipment, and shipper profile records according to user permissions.

Shipment Usage

Read the account's stored shipment usage, limit, tier, and catalog price through GET /api/v1/billing/usage.

API FAQ

Join early access for an account. JWTs come from POST /api/v1/auth/login; company admins can create read-only integration keys through /api/v1/api-keys. Production agency submission remains unavailable.

Requests are rate-limited. Handle HTTP 429 responses and use conservative retry behavior; limits depend on the route and server configuration and may change during early access.

No. The /api/v1/integration/* API-key surface is read-only. JWT-authenticated account routes can manage draft records according to role, but production agency transmission is not available during early access.

No official SDK is currently published. The API uses HTTP and JSON, so you can evaluate it with a compatible HTTP client. The verified public route summary is available at /docs.

Evaluate the BorderPro Draft API

Join early access to evaluate the draft API; production government submission is pending certification.

Join API Early Access