ASCI API - CBP Communication

CBP Communication module page - how it works, an interactive test form, and the endpoint reference, all in one place. Set your tenant API Key in the Setup block below; every request sends the ApiKey header. See All Forms for the combined surface or Home for the module index.

How it works

CBP transmit + reply capture (CBPCOM).

CBP Communication

CBP Communication (CBPCOM) transmits a built CATAIR message to U.S. Customs and tracks every reply. The {channel} path segment selects the environment: cert (Certification, active by default) or prod (Production). The legacy system builds the CATAIR (after inserting the MKEYED entry and generating the reference); this is the API-driven transmit + reply-capture path.

Transmit posts to POST /api/Cbp/{channel}/Transmit (needs cbp.submit); replies and submission state are read back with cbp.read. Use GET /api/Cbp/Environment to see the active channel.

Setup

API key + base URL used by every request below.

Credentials

API Key

Base URL

Leave Base URL blank to call this same server with relative paths (the normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms at another host. Every request below sends the ApiKey header.

Idempotency Key

Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.

Test form

Interactive form - POSTs to the API and shows the JSON response + HTTP status.

CBP Communication (CBPCOM). Transmit a built CATAIR message to U.S. Customs and track every reply. Cert vs Production is a controlled setting (Certification is active by default). The legacy system builds the CATAIR (after inserting the MKEYED entry and generating the reference); this is the API-driven transmit + reply-capture path. Needs an ApiKey with cbp.submit (transmit) / cbp.read (view).

Active environment

Transmit a CATAIR message

Channel

Reference No

Filer Code

CATAIR

Submissions

Filter channel

Submission detail (status, replies, ISF/entry/bill numbers)

Channel

Submission ID

What CBP returns: for an ISF, the reply carries the isf_number (CBP ISF Transaction Number), the bill_no (bill of lading), and an accept/reject status (ISF ACCEPTED / REJECTED). For a Quick Entry, the reply carries the assigned entry_no. Every reply (success and failure) is captured with its CBP condition codes; the operator view is the Manager's CBP Comm Manager.

Endpoints

CBP endpoint family (api/Cbp). Full request schema below.

CBP endpoints

Method	Path	Purpose
POST	`/api/Cbp/{channel}/Transmit`	Transmit a CATAIR message (channel = cert \| prod). Scope `cbp.submit`.
GET	`/api/Cbp/Submissions`	List CBP submissions. Scope `cbp.read`.
GET	`/api/Cbp/{channel}/{submissionId}`	Fetch one submission + replies.
GET	`/api/Cbp/{channel}/{submissionId}/Status`	Submission status.
GET	`/api/Cbp/Environment`	Active channel (cert / prod).

Schema

Request body for POST /api/Cbp/{channel}/Transmit. The legacy system builds the CATAIR message and notifies the API; send the message inline (catair) or reference a file it dropped in the tenant CBP_OUTBOX (catair_file) - supply one or the other.

Transmit request

Field	Type	Req?	Description
`reference_no`	string	No	ASCI 6-byte reference number (I0$) for the entry / ISF.
`filer_code`	string	No	3-char ABI filer code (e.g. S38).
`catair`	string	Cond.	The built CATAIR message text (inline). Optional if `catair_file` is set.
`catair_file`	string	Cond.	Filename in the tenant CBP_OUTBOX that the legacy dropped. Optional if `catair` is set.
`metadata`	object	No	Optional client-supplied key/value bag (string→string, ≤50 entries) echoed back on replies / webhooks.

Environment switch request

Body for the loopback environment switch.

Field	Type	Req?	Description
`environment`	string	Yes	`CERT` or `PROD`.