Remove additional entities from a tracked vessel

Remove one or more additional entities from a vessel which is currently tracking, so that they are no longer screened for the remainder of the tracking period.

This is a soft delete. The entity records are retained against the transaction and remain visible in previously generated screening reports, but they are excluded from all future screening and no longer appear in the additional entity GET response.

Removing entities triggers an Additional Entity Removed notification and clears any outstanding Associated Company on Global Sanction List notifications which were raised against the removed entities.

This method requires the Additional Entity Ship Tracking feature to be enabled on the account, and the transaction must be in a tracking status - either ready to track ("R") or approved ("A").

Every id in the request must reference an entity which is currently active on the transaction. If any id does not, the whole request is rejected and no entities are removed.

Refer to Managing Additional Entities to see how to use this endpoint in a vessel tracking workflow.

curl --location --request DELETE 'https://api.polestar-production.com/purpletrac/v1/transaction//additional_entity?username=undefined&api_key=%3Capi-key%3E' \ --header 'Content-Type: application/json' \ --data '{ "ids": [ 4521 ] }'

Remove additional entities from a tracked vessel

Request

Responses