Cargo screening

Get a cargo screening

Replays a stored cargo screening verbatim, including the methodology_version it ran under.

Required scope: cargo:screen.

get/api/v1/cargo-screenings/{id}

Request

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

Path parameters

idstring uuid required

Response

Successful response.

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.