Border Agency
Authenticate and retrieve Goods Load data and documents shared with your organisation.
TWIN sends ISN signals to your registered endpoint automatically. You can then query TWIN directly to retrieve the full Goods Load data and any attached documents.
Goods Load and consignment refer to the same entity. TWIN's schema and API use "consignment"; this guide uses "Goods Load", the term freight forwarders use day to day.
TWIN sends two ISN signals to your registered endpoint automatically: a Pre-Notification
signal when the freight forwarder creates or updates a Goods Load, and a Despatch signal when
they add a twin:despatched event.
Authenticate
Exchange your email and password for a session cookie.
POST /authentication/login
Content-Type: application/json{
"email": "[email protected]",
"password": "your-password"
}The JWT arrives via Set-Cookie. Include it on every subsequent request.
See Authentication for full details.
Read the Goods Load
The signal contains the Goods Load globalId and originRecordID — the freight forwarder's internal reference. Use the globalId to fetch the full Goods Load — parties, transport details, events, and any TWIN-resolved fields.
GET /supply-chain/data-space/consignments/<globalId>
Cookie: access_token=<jwt>See Get a Consignment for the full response shape.
List Goods Load documents
Fetch the list of documents attached to the Goods Load:
GET /supply-chain/data-space/consignments/<globalId>/documents
Cookie: access_token=<jwt>Returns a list of DocumentAttachment objects — see List Consignment Documents for the full response shape.
To download a specific document, use the href from the response directly, or fetch it by ID:
GET /supply-chain/data-space/consignments/<globalId>/documents/<documentId>
Cookie: access_token=<jwt>