Vessel screening

List screenings

Returns your screening history newest-first, as summary rows — id, IMO, your customer_reference, the sanctions status, ownership band and vetting grade. This is the audit view: filter by created_after/created_before to produce "everything we screened in Q3", or by customer_reference to find the screening behind one of your orders. Fetch the full record with GET /api/v1/screenings/{id}. Pagination is KEYSET, not offset: pass the returned next_cursor as cursor. An offset walk over an append-only log silently skips rows when new screenings land mid-page, which in an audit export is a missing record, not a cosmetic glitch. ownership_opacity and vetting_grade are null when the hull was not assessed — a summary never looks more certain than the record it summarises. "Which of my questions are still open" is status=INCOMPLETE&superseded=false: every row carries superseded_by, the later record that answered it (see the resolution block on the full record).

Required scope: vessel:screen.

get/api/v1/screenings

Request

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

Query parameters

limitinteger

Rows per page, 1-200. Default 50.

cursorstring

The next_cursor from the previous page, passed back unmodified. Opaque: it encodes both sort keys so a page boundary inside a group of same-timestamp screenings resumes exactly where it stopped instead of skipping the rest of that group.

imostring

Only screenings of this hull.

customer_referencestring

Exact match on the reference you supplied.

created_afterstring date-time

ISO 8601 lower bound, inclusive.

created_beforestring date-time

ISO 8601 upper bound, inclusive.

status'GREEN' | 'AMBER' | 'RED' | 'INCOMPLETE'

Only screenings with this sanctions.status. Case-sensitive; any other value is a 422.

supersededboolean

true: only records a later screening of the same hull has answered (superseded_by set). false: only records still standing on their own — with status=INCOMPLETE, the questions still open.

Response

Successful response.

next_cursorstring nullable

Pass as cursor for the next page, unmodified. Null on the last page.

has_moreboolean required

Changes

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