Cargo screening

Screen a cargo

Screens a goods description, and an HS code when you have one, against the Common High Priority Items List (the 50 six-digit HS headings the US, EU, UK and Japan jointly identify as items Russia seeks for its weapons programmes), against the discharge jurisdiction, and — for medicine and medical devices — against the published humanitarian general-licence context. Returns OK, WARNING or CRITICAL.

Every response names the lists it read in lists_screened AND the lists it did NOT read in lists_not_screened. This is NOT an export-control classification: it does not assign an ECCN or an EU dual-use category and it does not assess end use or end user. Read lists_not_screened before relying on an OK.

Supplying imo carries that hull last known sanctions verdict onto the response so cargo risk and vessel risk are read together. It never screens the vessel for you: an unscreened hull is reported as unscreened, never as clear.

Required scope: cargo:screen.

post/api/v1/cargo-screenings

Request

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

goods_descriptionstring required

What the cargo is, e.g. "ball bearings for main engine".

hs_codestring

Six-digit HS heading or longer national code. When supplied it is authoritative and the description is not keyword-matched.

discharge_countrystring

ISO 3166-1 alpha-2 discharge country. Moves the verdict, so membership is enforced, not just shape: XX, SU, YU, AN and UK all return 422 with the replacement named (UK is not a code — the United Kingdom is GB). Omit the field entirely if the destination is genuinely unknown; the response then says no jurisdiction assessment was made, rather than reporting the destination as clean.

imostring

Optional hull, to carry its last known sanctions verdict onto the response.

customer_referencestring

Your own identifier, e.g. the purchase order.

Response

Cargo screened.

idstring uuid required
status'OK' | 'WARNING' | 'CRITICAL' required

The SHIPMENT decision — the worse of the cargo verdict and the named hull last known sanctions verdict. Clean cargo onto a sanctioned hull is not an OK. Act on this field.

status_basis'cargo' | 'vessel'

Which side drove the top-line status.

cargo_status'OK' | 'WARNING' | 'CRITICAL'

The goods verdict alone, ignoring the vessel.

goods_descriptionstring required
hs_codestring nullable
customer_referencestring nullable
match_basis'hs_code' | 'description' | 'null' nullable
lists_screenedstring[] required

Exactly what this screen read.

lists_not_screenedstring[] required

Exactly what it did NOT read. Read this before relying on an OK.

methodology_versionstring
screened_atstring date-time
expires_atstring date-time
disclaimerstring

Changes

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