Submit a vessel for screening

Production

https://api.polestar-production.com

POST

/purpletrac/v1/registration

Registers the vessel by providing the IMO number in the body and triggers the screening workflow.

Refer to Screening Vessels for an example of how this endpoints integrates into the vessel screening workflow

Request

Authorization

API Key

Add parameter in query

api_key

Example:

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

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The vessel was accepted for screening. Carries the transaction id every other vessel endpoint takes.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Simple IMO submissionInclude Carbon RatingInclude P&I Club screeningInclude Custom ReferenceInclude Additional Entities (single)Include Additional Entities (multiple)Include Additional Entities (incl. not parameter)

curl --location 'https://api.polestar-production.com/purpletrac/v1/registration?username=undefined&api_key=%3Capi-key%3E' \
--header 'Content-Type: application/json' \
--data '{
    "registered_name": "9221126"
}'

Response Example

200 - Simple IMO submission

{
    "added_via": "MANUAL",
    "carbon_rating": false,
    "client_reference": null,
    "registered_name": "9183934",
    "resource_uri": "/api/v1/registration/None",
    "transaction_id": 1825356
}

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

Carbon rating

Retrieve a list of transactions and their screening results