Get the PurpleTRAC Screening Report PDF

Production

https://api.polestar-production.com

GET

/purpletrac/v1/screening_report

Retrieves the PurpleTRAC screening report PDF once it has been created.

Refer to Screening Vessels to see how to use this endpoint in the screening workflow.

Request

Authorization

API Key

Add parameter in query

api_key

Example:

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

Query Params

Responses

🟢200OK

application/pdf

The screening report as a PDF.

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.polestar-production.com/purpletrac/v1/screening_report?username=undefined&transaction_id=undefined&document_id=undefined&api_key=%3Capi-key%3E'

Response Example

401 - Success Example

{
    "error": {
        "code": 401,
        "message": "Unauthorized access"
    }
}

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

Carbon rating details

Submit a vessel for rescreening