Ship & Flag Watchlist check

Production

https://api.polestar-production.com

GET

/purpletrac/v1/shipsanction

Retrieves all ship and flag sanction checks associated with a particular screening.

Refer to Watchlist Checks for an example of how to use this endpoint in practice.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

api_key: ********************

Query Params

Responses

🟢200OK

application/json

Watchlist hits against the vessel itself and against its flag.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/purpletrac/v1/shipsanction?username=undefined&limit=undefined&offset=undefined&screenresult=undefined&api_key=%3Capi-key%3E'

Response Example

200 - Default (incl. pagination)

{
    "meta": {
        "limit": 100,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 4
    },
    "objects": [
        {
            "compliance_id": 3458,
            "entity_name": "FELICITY",
            "entity_type": "ship",
            "id": 291026,
            "ignored": false,
            "resource_uri": "/api/v1/shipsanction/291026",
            "sanction_name": "OFAC - Specially Designated National List",
            "screenresult": "/api/v1/screenresult/14837195",
            "severity": "CRITICAL",
            "since_date": "2013-03-14",
            "to_date": "2016-01-16"
        },
        {
            "compliance_id": 3458,
            "entity_name": "FELICITY",
            "entity_type": "ship",
            "id": 291026,
            "ignored": false,
            "resource_uri": "/api/v1/shipsanction/291026",
            "sanction_name": "OFAC - Executive Order 13599",
            "screenresult": "/api/v1/screenresult/14837195",
            "severity": "CRITICAL",
            "since_date": "2016-01-16",
            "to_date": "2018-11-05"
        },
        {
            "compliance_id": 3458,
            "entity_name": "FELICITY",
            "entity_type": "ship",
            "id": 291026,
            "ignored": false,
            "resource_uri": "/api/v1/shipsanction/291026",
            "sanction_name": "OFAC - Specially Designated National List",
            "screenresult": "/api/v1/screenresult/14837195",
            "severity": "CRITICAL",
            "since_date": "2018-11-05",
            "to_date": null
        }
    ]
}

Modified at 2026-09-18 08:35:54

Retrieve a list of transactions and their screening results

Company Watchlist check