Vessel monitors

Monitor a hull

Watches one hull and emits vessel_risk.changed when its sanctions status, ownership opacity, or vetting grade moves. Re-screened every 24 hours — the cadence matches how often the underlying lists actually publish, so a shorter interval would spend quota re-reading the same file. The first run establishes a baseline and emits vessel_monitor.ready, never a change event. Each run consumes one screening unit.

With a TEST key the monitor is created but never scheduled and never metered: next_run_at comes back null and no screening runs. Drive it with POST /api/v1/vessel-monitors/{id}/simulate to fire a real vessel_risk.changed event at your endpoint on demand, which is how you prove a handler works before going live.

Required scope: vessel:monitor.

post/api/v1/vessel-monitors

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/vessel-monitors
  • Auth: one of:
    • HTTP bearer
    • API key in header X-ArcNautical-Key

Headers

Idempotency-Keystring required

Required for resource-creating POST requests. The same key and identical body replay the original response for 24 hours; a different body returns idempotency_conflict.

Request body

imostring required

Hull to watch. Same acceptance rules as CreateScreeningRequest.

customer_referencestring

Response

Vessel monitor created.

idstring uuid required
imostring required
imo_check_digit_validboolean
status'active' required
next_run_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.