Developer Portal
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
  1. Start Here
  • Start Here
    • Overview
    • Getting started
    • Authentication
    • Testing
    • Errors & status codes
    • FAQ
  • General
    • Retrieve a list of vessels
      GET
    • Additional entity search
      GET
  • Screening
    • Screening a vessel
    • Watchlist checks
    • Additional checks
    • Movement history
    • Carbon rating
    • Submit a vessel for screening
      POST
    • Retrieve a list of transactions and their screening results
      GET
    • Ship & Flag Watchlist check
      GET
    • Company Watchlist check
      GET
    • Country Sanctions check
      GET
    • Ship movement history
      GET
    • Ship-to-Ship (STS) pairing screening
      GET
    • Company history check
      GET
    • P&I Club check
      GET
    • Vessel operational status
      GET
    • Flag history check
      GET
    • AIS positional discrepancy (spoofing) events
      GET
    • Periods of Non-Reporting
      GET
    • Carbon rating details
      GET
    • Get the PurpleTRAC Screening Report PDF
      GET
    • Submit a vessel for rescreening
      PUT
    • Archive a Screening
      PUT
  • Tracking
    • Voyage updates
    • Notification catalogue
    • Additional entities
    • Tracking a vessel
    • Enable a vessel for tracking
    • Remove additional entities from a tracked vessel
    • Add additional entities to a tracked vessel
    • List the additional entities on a transaction
    • Update voyage and tracking details
    • Get vessel positional data
    • Retrieve a list of vessel or bill of lading notifications
    • Get the PurpleTRAC Trade Report PDF
  • Bill of Lading
    • Carriers
    • Verification
    • Submit a Bill of Lading for screening
    • Get all BL Screening Results
    • Get a single BL screening result
    • Get the PurpleTRAC Bill of Lading Screening Report PDF
    • Enable tracking for a screened Bill of Lading
    • Get the PurpleTRAC Bill of Lading Tracking Report PDF
    • Disable tracking for a Bill of Lading
  • Containers
    • Screening
    • Carriers
    • Submit a Container for screening
    • Get all Container Screening Results
    • Archive Container
    • Get a single Container screening result
    • Get the Container report
  • Schemas
    • BLVGetAllResultsResponse
    • BLVScreeningResponse
    • BLVLastScreeningResult
    • BLVScreeningResultDetails
    • ContainerRegistrationBody
    • ContainerRegistrationResponse
    • ContainerGetAllResultsResponse
    • ContainerScreeningResponse
    • CarbonRatings
    • CarbonRating
    • CompanySanctions
    • CompanySanction
    • CountryChecks
    • CountryCheck
    • StsPairings
    • StsPairing
    • OtherAssociations
    • OtherAssociation
    • CompanyHistoryChecks
    • CompanyHistoryCheck
    • ShipStatuses
    • ShipStatus
    • FlagHistoryChecks
    • FlagHistoryCheck
    • PositionalDiscrepancies
    • PositionalDiscrepancy
    • DiscrepancyZone
    • DiscrepancyPort
    • NonReportingResponse
    • NonReporting
    • Notifications
    • Notification
    • BLVNotification
    • BLVPortFull
    • BLVPortFallback
    • PortCallHistory
    • PortCallHistoryItem
    • Positions
    • Position
    • PositionInfo
    • RegistrationResponse
    • ShipDetails
    • ShipSanctions
    • ShipSanction
    • VesselTrackingResponse
    • VesselTransactionsResponse
    • Transaction
    • TransactionPutBody
    • TransactionPutResponse
    • TransactionRescreenResponse
    • LastPosition
    • ScreeningNotification
    • ScreeningResult
    • UserDetails
    • UserProfile
    • Error
    • InvalidContainerNumberResponse
    • VesselRegistrationBody
    • VesselTrackingRequest
    • BLRegistrationBody
    • AdditionalEntitySearchResponse
    • AdditionalEntity
    • AdditionalEntitiesRequestSchema
    • TrackingAdditionalEntity
    • TrackingAdditionalEntitiesResponse
    • TrackingAdditionalEntityInput
    • TrackingAdditionalEntitiesPutBody
    • TrackingAdditionalEntitiesPutResponse
    • TrackingAdditionalEntitiesDeleteBody
    • RemovedAdditionalEntity
    • TrackingAdditionalEntitiesDeleteResponse
    • TrackingAdditionalEntityError
    • FeatureDisabledError
    • ObjectNotFoundError
    • TransactionValidationError
    • VoyageUpdateRequest
    • VoyageUpdateResponse
    • PTracMeta
    • PTracVessel
    • PTracVesselSearchResponse
    • DuplicateTransactionError
  1. Start Here

PurpleTRAC

Screening and tracking for vessels, bills of lading and containers. You submit something for screening, PurpleTRAC returns compliance results against watchlists and movement data, and you can then keep it under tracking for as long as you need.
PurpleTRAC is a separate product from Insights, on its own host, with its own authentication. If you already integrate against Insights, nothing carries over.

When to use it#

You want toStart at
Check a vessel against sanctions and watchlists, and get a report you can fileScreening
Follow a vessel after screening, and be told when something happensTracking
Verify a bill of lading and follow it to its destinationBill of Lading
Screen a container against its carrier recordContainers
Find a vessel before you screen itGeneral

What is in it#

Screening
Submit a vessel, then read watchlist checks on the ship, its companies and its flag countries, plus movement history, non-reporting periods and a PDF report.
Tracking
Positions and event notifications for as long as a screened vessel stays tracked, and a trade report when tracking stops.
Bill of Lading
Screen a bill of lading, track it to its destination, and download screening and tracking reports.
Containers
Screen a container against its carrier record and download the container report.
Getting Started
The transaction id, the three workflows, and what your account configuration controls.
Authentication
The username and API key pair, and where they go on a request.

Everything hangs off a transaction id#

Screening a vessel for the first time creates a transaction id. Almost every other call needs it: fetching results, enabling tracking, rescreening, downloading a report. Bills of lading and containers work the same way, each with their own id.
So the first call in any PurpleTRAC integration is a screening call, and the id it returns is what you store.
Getting Started walks through what comes back and what to do with it.

What your account can reach#

Three parts of PurpleTRAC are sold as addons and are switched on per account: Carbon Rating, Bill of Lading Verification and Container Screening. If yours is not enabled, those endpoints return 403, which here means the feature is off rather than that your credentials are wrong.
Your account configuration also sets watchlist selection, flag and company history lookback periods, non-reporting gap thresholds and the severity bands on individual checks. Those choices change what your results say, so it is worth knowing what was agreed at onboarding. Your Pole Star representative holds the settings and can amend them later.
Authentication here is not the Insights API key
PurpleTRAC takes a username and an API key as query parameters. That is a legacy scheme still in production, and we are migrating everything to API keys. See Authentication.

Related#

Errors & Status Codes
The error shapes PurpleTRAC returns, and why 403 means something different here.
Testing & Sandbox
Trying calls without credentials, and running the collection in Postman.
FAQ
Archiving, screening duration, two movement-history sources, and how long to track.
Modified at 2026-10-01 09:29:33
Next
Getting started
Built with