Vessel screening

Screen a fleet

Validates and enqueues up to 50 hulls. Asynchronous by necessity, not by preference: a screen takes seconds and a fleet of 50 would exceed any reasonable request timeout. Poll GET /api/v1/screening-batches/{id} or subscribe to the screening_batch.completed webhook. The per-batch cap is entitlement-specific — read max_hulls from GET /api/v1/usage. Only accepted hulls reserve quota.

Required scope: vessel:screen.

post/api/v1/screening-batches

Request

  • Base URL: https://arcnautical.com
  • URL: https://arcnautical.com/api/v1/screening-batches
  • 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

include_vettingboolean

Batch-level default for every item, so a volume run need not repeat the flag per hull. An item that sets its own value wins. See CreateScreeningRequest.include_vetting.

Response

Batch accepted for processing.

idstring uuid required
status'queued' | 'completed' required
total_countinteger required

Items created, and what completion is measured against: total_count === completed_count + failed_count when the batch finishes. Excludes de-duplicated repeats.

submitted_countinteger required

IMOs you posted, before de-duplication.

accepted_countinteger required

Distinct hulls that passed validation. Only these reserve quota.

failed_countinteger required
duplicate_countinteger required

Repeats of a hull already in this batch. Not screened and NOT BILLED — six identical IMOs are one unit, not six. Fleets have always de-duplicated; batches now match them.

created_atstring date-time required

Changes

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