{ "info": { "name": "ArcNautical API v1", "description": "Vessel sanctions screening, monitors, fleets, cargo screening, voyage risk, webhooks and exports. Two folders need no key at all. For the rest, set `apiKey` in the ArcNautical environment to a key minted at https://arcnautical.com/arcnautical.html#/developer-api (self-serve, no approval step). Guide: https://arcnautical.com/developers/ · Reference: https://arcnautical.com/developers/reference/ · Contract: https://arcnautical.com/api/v1/openapi.json", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://arcnautical.com", "type": "string" }, { "key": "apiKey", "value": "", "type": "string", "description": "arc_live_… or arc_test_… — mint one self-serve at #/developer-api. Prefer the environment variable of the same name." } ], "item": [ { "name": "Public vessel check", "description": { "content": "Unauthenticated hull screening. IP rate-limited, cached, and not retained against a customer. Requires no key and no account — this is the endpoint the documentation leads with.", "type": "text/plain" }, "item": [ { "name": "Screen a hull by IMO (no key)", "request": { "name": "Screen a hull by IMO (no key)", "description": { "content": "Screens one hull against sanctions, ownership opacity, and vetting. Requires NO API key and no account. Rate-limited to 100 requests/hour per IP and cached for one hour. The response reports X-RateLimit-Limit, -Remaining and -Reset so a client can pace itself without being refused first. Results are not retained against a customer and carry no quota. This screens a VESSEL, not a voyage — voyage scoring is POST /api/v1/voyage-assessments and needs a key.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessels", ":imo", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "9274446", "key": "imo", "description": "(Required) Seven-digit IMO number." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "noauth" } }, "response": [ { "name": "Screening verdict.", "originalRequest": { "url": { "path": [ "api", "v1", "vessels", ":imo", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "imo", "description": "(Required) Seven-digit IMO number." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Requests allowed per hour, per IP.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Verdicts are cached for one hour. INCOMPLETE is never cached.", "key": "Cache-Control", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"imo\": \"9274446\",\n \"sanctions\": {\n \"status\": \"RED\",\n \"detail\": \"4 confirmed matches on vessel identifier.\",\n \"detailKey\": \"verdict.sanctions.confirmed_match_other\",\n \"detailParams\": {\n \"count\": 4\n },\n \"coverageComplete\": true,\n \"coverageGaps\": [],\n \"identityScope\": \"current-name-and-identifiers\"\n },\n \"ownership\": {\n \"opacity\": \"MEDIUM\",\n \"score\": 40\n },\n \"vetting\": {\n \"grade\": \"E\",\n \"score\": 90,\n \"status\": \"unacceptable\"\n },\n \"assessed\": true,\n \"checkedAt\": \"2026-09-12T08:10:40.616Z\",\n \"provider\": \"ArcNautical\",\n \"fullReport\": \"https://arcnautical.com/check?imo=9274446\",\n \"docs\": \"https://github.com/SaltyTaro/vessel-check-api\",\n \"tier\": \"keyless\",\n \"tierDetail\": \"Verdict summary only. The authenticated record names every sanctions match with its source list, programme and confidence class, reports each source separately, and is retained as a citable screening record. If you already hold an API key, use it here — this endpoint ignores credentials.\",\n \"fullRecord\": \"https://arcnautical.com/developers\"\n}", "cookie": [] }, { "name": "Per-IP hourly rate limit exceeded.", "originalRequest": { "url": { "path": [ "api", "v1", "vessels", ":imo", "check" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "imo", "description": "(Required) Seven-digit IMO number." } ] }, "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Port lookup", "description": { "content": "Unauthenticated UN/LOCODE resolution. Routes are addressed by LOCODE, so this is how a caller turns a port name into one. Every LOCODE validation error points here.", "type": "text/plain" }, "item": [ { "name": "Find a port by name, country, or UN/LOCODE (no key)", "request": { "name": "Find a port by name, country, or UN/LOCODE (no key)", "description": { "content": "Resolves a port name to the UN/LOCODE that route.origin and route.destination require. Requires NO API key. Covers the ports the routing graph can compute against, so a code returned here is guaranteed to be routable. An exact LOCODE match is returned first, which makes this also the way to confirm a code you already hold. Every result carries match_score and match_type so a caller can tell a confident resolution from a weak one programmatically rather than trusting position in the list.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "ports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "rotterdam", "description": "(Required) Port name, country, or UN/LOCODE. Minimum two characters, case-insensitive." }, { "disabled": false, "key": "limit", "value": "20", "description": "Maximum ports to return." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "noauth" } }, "response": [ { "name": "Matching ports, best match first. An empty array means no port matched.", "originalRequest": { "url": { "path": [ "api", "v1", "ports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Static reference data, cached for ten minutes.", "key": "Cache-Control", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"ports\": [\n {\n \"locode\": \"\",\n \"name\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"match_score\": \"\",\n \"match_type\": \"\"\n },\n {\n \"locode\": \"\",\n \"name\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"lat\": \"\",\n \"lon\": \"\",\n \"match_score\": \"\",\n \"match_type\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or too-short query, or a limit outside 1-100. Uses the standard ApiErrorEnvelope.", "originalRequest": { "url": { "path": [ "api", "v1", "ports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Vessel screening", "description": { "content": "The authenticated screening record for one hull, or a batch of up to 50: every sanctions match with its source list and confidence class, ownership opacity, the graded vetting factors, and per-source freshness. Retained ten years. Metered on its own allowance (5,000 live a month).", "type": "text/plain" }, "item": [ { "name": "List screenings", "request": { "name": "List screenings", "description": { "content": "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.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-200. Default 50." }, { "disabled": false, "key": "cursor", "value": "", "description": "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." }, { "disabled": false, "key": "imo", "value": "", "description": "Only screenings of this hull." }, { "disabled": false, "key": "customer_reference", "value": "", "description": "Exact match on the reference you supplied." }, { "disabled": false, "key": "created_after", "value": "", "description": "ISO 8601 lower bound, inclusive." }, { "disabled": false, "key": "created_before", "value": "", "description": "ISO 8601 upper bound, inclusive." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"screenings\": [\n {\n \"id\": \"\",\n \"imo\": \"\",\n \"created_at\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"ownership_opacity\": \"\",\n \"vetting_grade\": \"\",\n \"assessed\": \"\"\n },\n {\n \"id\": \"\",\n \"imo\": \"\",\n \"created_at\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"ownership_opacity\": \"\",\n \"vetting_grade\": \"\",\n \"assessed\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Screen one hull", "request": { "name": "Screen one hull", "description": { "content": "Synchronously screens one vessel against OFAC SDN, OpenSanctions, EU FSD, UN Consolidated and UK OFSI. The HULL IDENTIFIER (IMO/MMSI) is matched against the lists that publish vessel records — OFAC SDN, OpenSanctions, EU FSD and UK OFSI. The UN Consolidated List publishes individuals and entities only and carries no vessel records, so it contributes at the name and ownership-chain layer rather than by hull identifier. Returns the sanctions verdict with its match evidence, the ownership-opacity band, the A-E vetting grade with its five weighted factors, and per-source freshness. Typically 5-15 seconds — a screen reads several upstream lists, so budget a longer client timeout than a voyage assessment needs. Use POST /api/v1/screening-batches for a fleet. An INCOMPLETE result (the hull could not be named, so no list was read against a name) is stored and replays under the same Idempotency-Key like any other, but it is NOT charged: `unit_charged` is false and the quota headers already reflect the refund.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"9274446\",\n \"customer_reference\": \"order-48213\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Screening completed.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Monthly unit limit of the allowance this operation draws on (voyage assessments or screenings), for the authenticated key environment.", "key": "X-ArcNautical-Quota-Limit", "value": "" }, { "disabled": false, "description": "Units of that allowance remaining in the current UTC monthly period, AFTER this call settled — on a screening that came back INCOMPLETE the unit was refunded and this already reflects it.", "key": "X-ArcNautical-Quota-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when that monthly allowance resets.", "key": "X-ArcNautical-Quota-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"imo\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"vessel_name\": \"\",\n \"sanctions\": {\n \"status\": \"\",\n \"detail\": \"\",\n \"coverage_complete\": \"\",\n \"coverage_gaps\": [\n \"\",\n \"\"\n ],\n \"matches\": [\n {\n \"source\": \"\",\n \"name\": \"\",\n \"match_type\": \"\",\n \"confidence\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ],\n \"confidence_class\": \"\",\n \"record_type\": \"\",\n \"drove_verdict\": \"\",\n \"screened_name\": \"\"\n },\n {\n \"source\": \"\",\n \"name\": \"\",\n \"match_type\": \"\",\n \"confidence\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ],\n \"confidence_class\": \"\",\n \"record_type\": \"\",\n \"drove_verdict\": \"\",\n \"screened_name\": \"\"\n }\n ],\n \"retry_after\": \"\"\n },\n \"ownership\": {\n \"opacity\": \"\",\n \"score\": \"\"\n },\n \"vetting\": {\n \"grade\": \"\",\n \"score\": \"\",\n \"status\": \"\",\n \"assessed\": \"\",\n \"factors\": [\n {\n \"factor\": \"\",\n \"score\": \"\",\n \"weight_pct\": \"\",\n \"observed\": \"\"\n },\n {\n \"factor\": \"\",\n \"score\": \"\",\n \"weight_pct\": \"\",\n \"observed\": \"\"\n }\n ],\n \"detention_count\": \"\",\n \"vessel_age\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n }\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"identity_sources\": [\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n },\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n }\n ],\n \"identity_basis\": \"\",\n \"unit_charged\": \"\",\n \"notices\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\",\n \"resets_at\": \"\"\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\",\n \"resets_at\": \"\"\n }\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"vessel_name\": \"\",\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve one screening", "request": { "name": "Retrieve one screening", "description": { "content": "Retrieves a previous screening owned by the authenticated customer, replayed VERBATIM — the same verdict, evidence and methodology_version that were returned when it ran. Screenings are retained as compliance evidence for 10 years, matching the OFAC recordkeeping requirement that took effect on 2025-03-12, so a record stays retrievable for as long as a regulator may ask for it. Operational objects (assessments, batches, idempotency keys) keep the shorter 30-day window.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"imo\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"vessel_name\": \"\",\n \"sanctions\": {\n \"status\": \"\",\n \"detail\": \"\",\n \"coverage_complete\": \"\",\n \"coverage_gaps\": [\n \"\",\n \"\"\n ],\n \"matches\": [\n {\n \"source\": \"\",\n \"name\": \"\",\n \"match_type\": \"\",\n \"confidence\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ],\n \"confidence_class\": \"\",\n \"record_type\": \"\",\n \"drove_verdict\": \"\",\n \"screened_name\": \"\"\n },\n {\n \"source\": \"\",\n \"name\": \"\",\n \"match_type\": \"\",\n \"confidence\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ],\n \"confidence_class\": \"\",\n \"record_type\": \"\",\n \"drove_verdict\": \"\",\n \"screened_name\": \"\"\n }\n ],\n \"retry_after\": \"\"\n },\n \"ownership\": {\n \"opacity\": \"\",\n \"score\": \"\"\n },\n \"vetting\": {\n \"grade\": \"\",\n \"score\": \"\",\n \"status\": \"\",\n \"assessed\": \"\",\n \"factors\": [\n {\n \"factor\": \"\",\n \"score\": \"\",\n \"weight_pct\": \"\",\n \"observed\": \"\"\n },\n {\n \"factor\": \"\",\n \"score\": \"\",\n \"weight_pct\": \"\",\n \"observed\": \"\"\n }\n ],\n \"detention_count\": \"\",\n \"vessel_age\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n }\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"identity_sources\": [\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n },\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n }\n ],\n \"identity_basis\": \"\",\n \"unit_charged\": \"\",\n \"notices\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\",\n \"resets_at\": \"\"\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\",\n \"resets_at\": \"\"\n }\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Screen a fleet", "request": { "name": "Screen a fleet", "description": { "content": "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.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"9274446\",\n {\n \"imo\": \"9141285\",\n \"customer_reference\": \"order-48214\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Batch accepted for processing.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Monthly unit limit of the allowance this operation draws on (voyage assessments or screenings), for the authenticated key environment.", "key": "X-ArcNautical-Quota-Limit", "value": "" }, { "disabled": false, "description": "Units of that allowance remaining in the current UTC monthly period, AFTER this call settled — on a screening that came back INCOMPLETE the unit was refunded and this already reflects it.", "key": "X-ArcNautical-Quota-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when that monthly allowance resets.", "key": "X-ArcNautical-Quota-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"total_count\": \"\",\n \"submitted_count\": \"\",\n \"accepted_count\": \"\",\n \"failed_count\": \"\",\n \"duplicate_count\": \"\",\n \"created_at\": \"\",\n \"duplicates\": [\n {\n \"index\": \"\",\n \"imo\": \"\",\n \"first_index\": \"\"\n },\n {\n \"index\": \"\",\n \"imo\": \"\",\n \"first_index\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imos\": [\n \"\"\n ],\n \"include_vetting\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get screening batch status", "request": { "name": "Get screening batch status", "description": { "content": "Returns batch status, counts, timestamps, and errors.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"total_count\": \"\",\n \"completed_count\": \"\",\n \"failed_count\": \"\",\n \"error_body\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List screening batch items", "request": { "name": "List screening batch items", "description": { "content": "Returns cursor-paginated per-hull screening results and partial failures.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_index\": \"\",\n \"status\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"screening_id\": \"\",\n \"result_body\": {\n \"id\": \"\",\n \"imo\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"vessel_name\": \"\",\n \"sanctions\": {\n \"status\": \"\",\n \"detail\": \"\",\n \"coverage_complete\": \"\",\n \"coverage_gaps\": [\n \"\",\n \"\"\n ],\n \"matches\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"retry_after\": \"\"\n },\n \"ownership\": {\n \"opacity\": \"\",\n \"score\": \"\"\n },\n \"vetting\": {\n \"grade\": \"\",\n \"score\": \"\",\n \"status\": \"\",\n \"assessed\": \"\",\n \"factors\": [\n {\n \"factor\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"observed\": {\n \"value\": \"\"\n }\n },\n {\n \"factor\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"observed\": {\n \"value\": \"\"\n }\n }\n ],\n \"detention_count\": \"\",\n \"vessel_age\": \"\",\n \"score_floor\": {\n \"basis\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n },\n \"weighted_score\": {\n \"value\": \"\"\n }\n }\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"identity_sources\": [\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n },\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n }\n ],\n \"identity_basis\": \"\",\n \"unit_charged\": \"\",\n \"notices\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"used\": {\n \"value\": \"\"\n },\n \"remaining\": {\n \"value\": \"\"\n },\n \"resets_at\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"used\": {\n \"value\": \"\"\n },\n \"remaining\": {\n \"value\": \"\"\n },\n \"resets_at\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n \"error_body\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"attempts\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"item_index\": \"\",\n \"status\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"screening_id\": \"\",\n \"result_body\": {\n \"id\": \"\",\n \"imo\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"vessel_name\": \"\",\n \"sanctions\": {\n \"status\": \"\",\n \"detail\": \"\",\n \"coverage_complete\": \"\",\n \"coverage_gaps\": [\n \"\",\n \"\"\n ],\n \"matches\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"retry_after\": \"\"\n },\n \"ownership\": {\n \"opacity\": \"\",\n \"score\": \"\"\n },\n \"vetting\": {\n \"grade\": \"\",\n \"score\": \"\",\n \"status\": \"\",\n \"assessed\": \"\",\n \"factors\": [\n {\n \"factor\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"observed\": {\n \"value\": \"\"\n }\n },\n {\n \"factor\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"observed\": {\n \"value\": \"\"\n }\n }\n ],\n \"detention_count\": \"\",\n \"vessel_age\": \"\",\n \"score_floor\": {\n \"basis\": {\n \"value\": \"\"\n },\n \"value\": {\n \"value\": \"\"\n },\n \"explanation\": {\n \"value\": \"\"\n },\n \"weighted_score\": {\n \"value\": \"\"\n }\n }\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"identity_sources\": [\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n },\n {\n \"register\": \"\",\n \"named\": \"\",\n \"reachable\": \"\",\n \"name\": \"\"\n }\n ],\n \"identity_basis\": \"\",\n \"unit_charged\": \"\",\n \"notices\": [\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"used\": {\n \"value\": \"\"\n },\n \"remaining\": {\n \"value\": \"\"\n },\n \"resets_at\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"code\": \"\",\n \"message\": \"\",\n \"remedy\": \"\",\n \"docs\": \"\",\n \"previous_screening_id\": \"\",\n \"previous_screened_at\": \"\",\n \"previous_status\": \"\",\n \"retry_after\": \"\",\n \"quota\": {\n \"limit\": {\n \"value\": \"\"\n },\n \"used\": {\n \"value\": \"\"\n },\n \"remaining\": {\n \"value\": \"\"\n },\n \"resets_at\": {\n \"value\": \"\"\n }\n }\n }\n ]\n },\n \"error_body\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"attempts\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "screening-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Vessel monitors", "description": { "content": "A standing subscription per hull. We re-screen on our schedule and deliver an event only when the verdict moves, so a book need not be re-screened to stay current.", "type": "text/plain" }, "item": [ { "name": "Monitor a hull", "request": { "name": "Monitor a hull", "description": { "content": "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.\n\nWith 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.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"9274446\",\n \"customer_reference\": \"supplier-book\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Vessel monitor created.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"imo\": \"\",\n \"status\": \"\",\n \"next_run_at\": \"\",\n \"imo_check_digit_valid\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List vessel monitors", "request": { "name": "List vessel monitors", "description": { "content": "Vessel monitors for the authenticated customer and environment, newest first. Paginated: pass the `next_cursor` from the previous page and stop when `has_more` is false. `changed_since` is the cheap way to ask the only question that matters daily — which hulls in my book moved — without walking the whole collection.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." }, { "disabled": false, "key": "imo", "value": "", "description": "Only the monitor watching this hull." }, { "disabled": false, "key": "customer_reference", "value": "", "description": "Only monitors carrying this reference." }, { "disabled": false, "key": "status", "value": "", "description": "Filter by monitor state." }, { "disabled": false, "key": "degraded", "value": "", "description": "Only monitors whose last run could not read the lists (true), or only healthy ones (false)." }, { "disabled": false, "key": "changed_since", "value": "", "description": "Only monitors whose verdict changed at or after this time." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"monitors\": [\n {\n \"id\": \"\",\n \"imo\": \"\",\n \"status\": \"\",\n \"vessel_name\": \"\",\n \"customer_reference\": \"\",\n \"baseline_verdict\": \"\",\n \"previous_verdict\": \"\",\n \"verdict_changed_at\": \"\",\n \"degraded\": \"\",\n \"last_screening_id\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"imo\": \"\",\n \"status\": \"\",\n \"vessel_name\": \"\",\n \"customer_reference\": \"\",\n \"baseline_verdict\": \"\",\n \"previous_verdict\": \"\",\n \"verdict_changed_at\": \"\",\n \"degraded\": \"\",\n \"last_screening_id\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "imo", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "status", "value": "" }, { "key": "degraded", "value": "" }, { "key": "changed_since", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Monitor many hulls at once", "request": { "name": "Monitor many hulls at once", "description": { "content": "Enrols up to 500 hulls in one request, and is SAFE TO RE-RUN: a hull already monitored comes back as `already_monitored` with its existing id rather than an error, so a nightly \"sync my fleet list\" job needs no local mirror of what we already hold.\n\nAnswers `200` with a per-item outcome rather than failing the whole request on one bad hull — a sync of 400 hulls containing three malformed IMOs enrols 397 and names the three. Each `results[]` entry carries `status`: `created`, `already_monitored`, `invalid` (with `message`), or `limit_exceeded`.\n\nThe account monitor cap still applies and is consumed in list order. It is not arbitrary: each monitor run spends one screening unit (two on a change), so a filled cap at the 24h cadence costs about 1,500 units a month. Read `monitor_limit` and `monitors_used` on the response to see where you stand.\n\nWith a TEST key the whole book is created but never scheduled and never metered, so you can rehearse a fleet sync at full size for nothing. Fire events with POST /api/v1/vessel-monitors/{id}/simulate.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"9274446\",\n \"customer_reference\": \"supplier-book\"\n },\n {\n \"imo\": \"9141285\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Per-hull outcomes. Check each result rather than only the HTTP status.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created\": \"\",\n \"already_monitored\": \"\",\n \"invalid\": \"\",\n \"limit_exceeded\": \"\",\n \"results\": [\n {\n \"index\": \"\",\n \"status\": \"\",\n \"imo\": \"\",\n \"id\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"message\": \"\"\n },\n {\n \"index\": \"\",\n \"status\": \"\",\n \"imo\": \"\",\n \"id\": \"\",\n \"imo_check_digit_valid\": \"\",\n \"message\": \"\"\n }\n ],\n \"monitor_limit\": \"\",\n \"monitors_used\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "batch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"monitors\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Every change across the whole book", "request": { "name": "Every change across the whole book", "description": { "content": "One feed of every monitor event on the account, newest first, instead of one request per monitor. This is the reconciliation surface: webhooks are the live path, but a delivery that exhausts its retries is gone, and a customer who has not built an endpoint has no other way to catch up. Poll this after an outage, or use it instead of webhooks entirely.\n\nEvent types: `baseline` (first successful screen, not a change), `changed`, `degraded` (the lists could not be read — NOT a clean result), and `recovered`.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." }, { "disabled": false, "key": "since", "value": "", "description": "Only events at or after this time." }, { "disabled": false, "key": "until", "value": "", "description": "Only events at or before this time." }, { "disabled": false, "key": "imo", "value": "", "description": "Only events for this hull." }, { "disabled": false, "key": "event_type", "value": "", "description": "Filter by event type." }, { "disabled": false, "key": "severity", "value": "", "description": "Filter by change severity." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"id\": \"\",\n \"monitor_id\": \"\",\n \"imo\": \"\",\n \"event_type\": \"\",\n \"created_at\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"opacity_band\": \"\",\n \"vetting_grade\": \"\",\n \"severity\": \"\",\n \"change_body\": [\n \"\",\n \"\"\n ],\n \"screening_id\": \"\"\n },\n {\n \"id\": \"\",\n \"monitor_id\": \"\",\n \"imo\": \"\",\n \"event_type\": \"\",\n \"created_at\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"opacity_band\": \"\",\n \"vetting_grade\": \"\",\n \"severity\": \"\",\n \"change_body\": [\n \"\",\n \"\"\n ],\n \"screening_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", "events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "imo", "value": "" }, { "key": "event_type", "value": "" }, { "key": "severity", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get vessel monitor", "request": { "name": "Get vessel monitor", "description": { "content": "Returns one vessel monitor with its current baseline verdict and the verdict it replaced.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"imo\": \"\",\n \"status\": \"\",\n \"vessel_name\": \"\",\n \"customer_reference\": \"\",\n \"baseline_verdict\": \"\",\n \"previous_verdict\": \"\",\n \"verdict_changed_at\": \"\",\n \"degraded\": \"\",\n \"last_screening_id\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Pause or resume vessel monitor", "request": { "name": "Pause or resume vessel monitor", "description": { "content": "Pausing stops re-screening and stops consuming quota. Resuming queues the next run immediately.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"imo\": \"\",\n \"status\": \"\",\n \"vessel_name\": \"\",\n \"customer_reference\": \"\",\n \"baseline_verdict\": \"\",\n \"previous_verdict\": \"\",\n \"verdict_changed_at\": \"\",\n \"degraded\": \"\",\n \"last_screening_id\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete vessel monitor", "request": { "name": "Delete vessel monitor", "description": { "content": "Soft-deletes the monitor. History is retained for 90 days and the hull can be monitored again.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"deleted\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get vessel monitor history", "request": { "name": "Get vessel monitor history", "description": { "content": "Returns the monitor timeline — baseline, confirmed changes, and data-degraded or recovered events — newest first.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"events\": [\n {\n \"event_type\": \"\",\n \"created_at\": \"\",\n \"sanctions_status\": \"\",\n \"opacity_band\": \"\",\n \"vetting_grade\": \"\",\n \"severity\": \"\",\n \"change_body\": \"\",\n \"screening_id\": \"\"\n },\n {\n \"event_type\": \"\",\n \"created_at\": \"\",\n \"sanctions_status\": \"\",\n \"opacity_band\": \"\",\n \"vetting_grade\": \"\",\n \"severity\": \"\",\n \"change_body\": \"\",\n \"screening_id\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Fire a test webhook event", "request": { "name": "Fire a test webhook event", "description": { "content": "Delivers a vessel_risk.changed event for this monitor on demand, without screening anything and without consuming a screening unit. Test keys only.\n\nThis exists so you can prove your webhook handler works BEFORE you go live. Without it the first event you ever receive is a production one, about a real hull, whenever that hull happens to move — which is not something you can write a handler against or demonstrate to a security reviewer.\n\nThe event travels the same path as a real one: same envelope, same HMAC signature, same five-attempt retry schedule, and it appears in GET /api/v1/webhook-deliveries like any other. It is marked simulated: true and carries a sim_-prefixed screening_id, so it can never be mistaken for a real finding, and it is also written to the monitor history so those reads are exercisable too.\n\nRefused with 403 on a live key: a synthetic risk change on a live monitor would enter your compliance record as a real finding about a real vessel.\n\nCheck queued_to_endpoints in the response. Zero means no ACTIVE test endpoint subscribes to vessel_risk.changed, which otherwise looks identical to a handler that silently failed.\n\nRequired scope: vessel:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Event queued to your test webhook endpoints.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"simulated\": \"\",\n \"change\": \"\",\n \"monitor_id\": \"\",\n \"imo\": \"\",\n \"event_type\": \"\",\n \"severity\": \"\",\n \"queued_to_endpoints\": \"\",\n \"warning\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "vessel-monitors", ":id", "simulate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"change\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Fleets", "description": { "content": "Named sets of hulls with an exposure roll-up and a change feed, for asking what moved since a cursor instead of re-screening the whole book.", "type": "text/plain" }, "item": [ { "name": "Register a fleet", "request": { "name": "Register a fleet", "description": { "content": "Registers a named list of hulls you care about, so you do not have to manage a subscription per vessel. A fleet holds MEMBERSHIP only and stores no verdict of its own: exposure and changes are read live from your screenings, so a fleet summary can never drift from the screening records behind it. Duplicate IMOs in the list are de-duplicated. Registering a fleet does NOT screen it and reserves no quota — call POST /api/v1/fleets/{id}/refresh when you want the hulls screened, so a bill is never started by an upload you were only staging.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Supplier book\",\n \"imos\": [\n \"9274446\",\n \"9141285\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Fleet registered. Not yet screened.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"vessel_count\": \"\",\n \"created_at\": \"\",\n \"screened\": \"\",\n \"next_step\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"imos\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List fleets", "request": { "name": "List fleets", "description": { "content": "Every fleet on this key environment, newest first, with its vessel count.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fleets\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"vessel_count\": \"\",\n \"created_at\": \"\",\n \"screened\": \"\",\n \"next_step\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"vessel_count\": \"\",\n \"created_at\": \"\",\n \"screened\": \"\",\n \"next_step\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a fleet", "request": { "name": "Get a fleet", "description": { "content": "The fleet and its full membership, including the customer_reference you attached to each hull.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"vessel_count\": \"\",\n \"vessels\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"added_at\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"added_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Add or remove vessels", "request": { "name": "Add or remove vessels", "description": { "content": "Renames the fleet and/or edits membership. add and remove take the same shapes as the create list. Adding a hull already present updates its customer_reference rather than duplicating it, so re-uploading your master list is safe to repeat.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"vessel_count\": \"\",\n \"added\": \"\",\n \"removed\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"add\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ],\n \"remove\": [\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n },\n {\n \"imo\": \"\",\n \"customer_reference\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete a fleet", "request": { "name": "Delete a fleet", "description": { "content": "Removes the grouping. The screenings it grouped are evidence and remain retrievable by id and through GET /api/v1/screenings — deleting a fleet never deletes an audit trail.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"deleted\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Fleet exposure summary", "request": { "name": "Fleet exposure summary", "description": { "content": "Current position across the fleet, from each hull latest screening: counts by sanctions status, ownership band and vetting grade, plus the RED/AMBER hulls listed with the screening id that says so. Read unscreened_count first — hulls you registered but have never screened are NOT clean, they are unknown, and they are counted separately rather than folded into a band. Likewise ownership NOT_ASSESSED is its own bucket, never averaged into MEDIUM.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fleet_id\": \"\",\n \"vessel_count\": \"\",\n \"screened_count\": \"\",\n \"unscreened_count\": \"\",\n \"name\": \"\",\n \"assessed_count\": \"\",\n \"oldest_screening_at\": \"\",\n \"sanctions\": {\n \"\": \"\"\n },\n \"ownership_opacity\": {\n \"\": \"\"\n },\n \"vetting_grades\": {\n \"\": \"\"\n },\n \"flagged\": [\n {\n \"imo\": \"\",\n \"sanctions_status\": \"\",\n \"screening_id\": \"\",\n \"screened_at\": \"\"\n },\n {\n \"imo\": \"\",\n \"sanctions_status\": \"\",\n \"screening_id\": \"\",\n \"screened_at\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "exposure" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "What moved in this fleet", "request": { "name": "What moved in this fleet", "description": { "content": "Hulls whose verdict changed between their two most recent screenings, newest first, with the from/to values, whether the move was a worsening, and the severity. Uses the same change definition as vessel monitors and the watch email, so those three can never disagree about what counts as a move. A hull we could not assess is not reported as a change: absence of a measurement is not a movement.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "", "description": "Only changes observed at or after this ISO 8601 time." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fleet_id\": \"\",\n \"changes\": [\n {\n \"imo\": \"\",\n \"changed_at\": \"\",\n \"screening_id\": \"\",\n \"previous_screening_id\": \"\",\n \"severity\": \"\",\n \"changes\": [\n {\n \"field\": \"\",\n \"label\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"worse\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"worse\": \"\"\n }\n ]\n },\n {\n \"imo\": \"\",\n \"changed_at\": \"\",\n \"screening_id\": \"\",\n \"previous_screening_id\": \"\",\n \"severity\": \"\",\n \"changes\": [\n {\n \"field\": \"\",\n \"label\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"worse\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"worse\": \"\"\n }\n ]\n }\n ],\n \"since\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "changes" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Screen every hull in the fleet", "request": { "name": "Screen every hull in the fleet", "description": { "content": "Queues a screening for every member, chunked into the same batch machinery as POST /api/v1/screening-batches and processed by the same worker. Reserves one screening unit per hull up front. Returns the batch ids so you can poll GET /api/v1/screening-batches/{id}, then read the result through the fleet exposure and changes endpoints.\n\nRequired scope: vessel:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "name": "Screening queued.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Monthly unit limit of the allowance this operation draws on (voyage assessments or screenings), for the authenticated key environment.", "key": "X-ArcNautical-Quota-Limit", "value": "" }, { "disabled": false, "description": "Units of that allowance remaining in the current UTC monthly period, AFTER this call settled — on a screening that came back INCOMPLETE the unit was refunded and this already reflects it.", "key": "X-ArcNautical-Quota-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when that monthly allowance resets.", "key": "X-ArcNautical-Quota-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"fleet_id\": \"\",\n \"queued_vessels\": \"\",\n \"batch_ids\": [\n \"\",\n \"\"\n ],\n \"status\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "fleets", ":id", "refresh" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Cargo screening", "description": { "content": "Commodity, origin and discharge screening against sanctions programmes and export controls.", "type": "text/plain" }, "item": [ { "name": "Screen a cargo", "request": { "name": "Screen a cargo", "description": { "content": "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.\n\nEvery 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.\n\nSupplying 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.\n\nRequired scope: cargo:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"Marine gas oil, 500 mt\",\n \"hs_code\": \"271019\",\n \"discharge_country\": \"AE\",\n \"imo\": \"9274446\",\n \"customer_reference\": \"order-48215\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Cargo screened.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"goods_description\": \"\",\n \"lists_screened\": [\n \"\",\n \"\"\n ],\n \"lists_not_screened\": [\n \"\",\n \"\"\n ],\n \"status_basis\": \"\",\n \"cargo_status\": \"\",\n \"hs_code\": \"\",\n \"customer_reference\": \"\",\n \"match_basis\": \"\",\n \"matches\": [\n {\n \"list\": \"\",\n \"hs6\": \"\",\n \"tier\": \"\",\n \"description\": \"\",\n \"basis\": \"\"\n },\n {\n \"list\": \"\",\n \"hs6\": \"\",\n \"tier\": \"\",\n \"description\": \"\",\n \"basis\": \"\"\n }\n ],\n \"destination\": {\n \"class\": \"\",\n \"label\": \"\",\n \"basis\": \"\"\n },\n \"humanitarian\": {\n \"medical_goods\": \"\",\n \"medical_goods_basis\": \"\",\n \"general_licence_status\": \"\",\n \"general_licence\": \"\",\n \"exclusions\": [\n {\n \"kind\": \"\",\n \"authority\": \"\",\n \"published_text\": \"\",\n \"matched_text\": \"\",\n \"certainty\": \"\",\n \"effect\": \"\",\n \"threshold\": {\n \"quantity\": \"\",\n \"operator\": \"\",\n \"value\": \"\",\n \"unit\": \"\",\n \"stated_value\": \"\",\n \"resolves_with\": \"\"\n },\n \"note\": \"\"\n },\n {\n \"kind\": \"\",\n \"authority\": \"\",\n \"published_text\": \"\",\n \"matched_text\": \"\",\n \"certainty\": \"\",\n \"effect\": \"\",\n \"threshold\": {\n \"quantity\": \"\",\n \"operator\": \"\",\n \"value\": \"\",\n \"unit\": \"\",\n \"stated_value\": \"\",\n \"resolves_with\": \"\"\n },\n \"note\": \"\"\n }\n ],\n \"conditions\": [\n \"\",\n \"\"\n ],\n \"list_edition\": {\n \"name\": \"\",\n \"authority\": \"\",\n \"published\": \"\",\n \"source_url\": \"\",\n \"source_sha256\": \"\",\n \"retrieved_at\": \"\",\n \"item_count\": \"\",\n \"lines_without_matcher\": \"\"\n }\n },\n \"vessel\": {\n \"imo\": \"\",\n \"sanctions_status\": \"\",\n \"screening_id\": \"\",\n \"screened_at\": \"\",\n \"note\": \"\"\n },\n \"methodology_version\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"disclaimer\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List cargo screenings", "request": { "name": "List cargo screenings", "description": { "content": "Your cargo screening history, newest first, for audit. Filter by status, customer_reference or date range. Same opaque keyset cursor as the vessel screening list. Retained for the same evidence window.\n\nRequired scope: cargo:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-200. Default 50." }, { "disabled": false, "key": "cursor", "value": "", "description": "next_cursor from the previous page, unmodified." }, { "disabled": false, "key": "status", "value": "", "description": "OK, WARNING or CRITICAL." }, { "disabled": false, "key": "customer_reference", "value": "", "description": "Exact match on your own reference." }, { "disabled": false, "key": "created_after", "value": "", "description": "ISO 8601 lower bound, inclusive." }, { "disabled": false, "key": "created_before", "value": "", "description": "ISO 8601 upper bound, inclusive." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"cargo_screenings\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"goods_description\": \"\",\n \"hs_code\": \"\",\n \"discharge_country\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a cargo screening", "request": { "name": "Get a cargo screening", "description": { "content": "Replays a stored cargo screening verbatim, including the methodology_version it ran under.\n\nRequired scope: cargo:screen.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"goods_description\": \"\",\n \"lists_screened\": [\n \"\",\n \"\"\n ],\n \"lists_not_screened\": [\n \"\",\n \"\"\n ],\n \"status_basis\": \"\",\n \"cargo_status\": \"\",\n \"hs_code\": \"\",\n \"customer_reference\": \"\",\n \"match_basis\": \"\",\n \"matches\": [\n {\n \"list\": \"\",\n \"hs6\": \"\",\n \"tier\": \"\",\n \"description\": \"\",\n \"basis\": \"\"\n },\n {\n \"list\": \"\",\n \"hs6\": \"\",\n \"tier\": \"\",\n \"description\": \"\",\n \"basis\": \"\"\n }\n ],\n \"destination\": {\n \"class\": \"\",\n \"label\": \"\",\n \"basis\": \"\"\n },\n \"humanitarian\": {\n \"medical_goods\": \"\",\n \"medical_goods_basis\": \"\",\n \"general_licence_status\": \"\",\n \"general_licence\": \"\",\n \"exclusions\": [\n {\n \"kind\": \"\",\n \"authority\": \"\",\n \"published_text\": \"\",\n \"matched_text\": \"\",\n \"certainty\": \"\",\n \"effect\": \"\",\n \"threshold\": {\n \"quantity\": \"\",\n \"operator\": \"\",\n \"value\": \"\",\n \"unit\": \"\",\n \"stated_value\": \"\",\n \"resolves_with\": \"\"\n },\n \"note\": \"\"\n },\n {\n \"kind\": \"\",\n \"authority\": \"\",\n \"published_text\": \"\",\n \"matched_text\": \"\",\n \"certainty\": \"\",\n \"effect\": \"\",\n \"threshold\": {\n \"quantity\": \"\",\n \"operator\": \"\",\n \"value\": \"\",\n \"unit\": \"\",\n \"stated_value\": \"\",\n \"resolves_with\": \"\"\n },\n \"note\": \"\"\n }\n ],\n \"conditions\": [\n \"\",\n \"\"\n ],\n \"list_edition\": {\n \"name\": \"\",\n \"authority\": \"\",\n \"published\": \"\",\n \"source_url\": \"\",\n \"source_sha256\": \"\",\n \"retrieved_at\": \"\",\n \"item_count\": \"\",\n \"lines_without_matcher\": \"\"\n }\n },\n \"vessel\": {\n \"imo\": \"\",\n \"sanctions_status\": \"\",\n \"screening_id\": \"\",\n \"screened_at\": \"\",\n \"note\": \"\"\n },\n \"methodology_version\": \"\",\n \"screened_at\": \"\",\n \"expires_at\": \"\",\n \"disclaimer\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "cargo-screenings", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Voyage assessments", "description": { "content": "Synchronous and batch route risk scoring by UN/LOCODE, retained for audit.", "type": "text/plain" }, "item": [ { "name": "List voyage assessments", "request": { "name": "List voyage assessments", "description": { "content": "Returns your assessment history newest-first as summary rows: id, your customer_reference, the route, the score, the risk level and the confidence. This is the audit view. Until 2026-09-05 there was no way to enumerate what you had scored — a caller had to persist every returned id at the moment of creation or the record was unreachable, and assessments expire, so \"I will fetch it later\" had a deadline you could not list against. Fetch the full record with GET /api/v1/voyage-assessments/{id}, or archive the lot with POST /api/v1/exports (resource voyage_assessments) before it expires. Pagination is KEYSET, not offset: pass the returned next_cursor back as cursor. Assessments written by one batch share a timestamp, and an offset walk over them silently skips rows — in an audit export that is a missing record. Route geometry is NOT included in the summary: it is ~87% of an assessment body and nobody paging an index wants it.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-200. Default 50." }, { "disabled": false, "key": "cursor", "value": "", "description": "The next_cursor from the previous page, passed back unmodified." }, { "disabled": false, "key": "customer_reference", "value": "", "description": "Exact match on the reference you supplied at creation." }, { "disabled": false, "key": "origin_locode", "value": "", "description": "UN/LOCODE of the origin port." }, { "disabled": false, "key": "dest_locode", "value": "", "description": "UN/LOCODE of the destination port." }, { "disabled": false, "key": "created_after", "value": "", "description": "ISO 8601 lower bound, inclusive." }, { "disabled": false, "key": "created_before", "value": "", "description": "ISO 8601 upper bound, inclusive." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assessments\": [\n {\n \"id\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"distance_nm\": \"\",\n \"score\": \"\",\n \"risk_level\": \"\",\n \"confidence\": \"\"\n },\n {\n \"id\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"distance_nm\": \"\",\n \"score\": \"\",\n \"risk_level\": \"\",\n \"confidence\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"next_cursor\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "customer_reference", "value": "" }, { "key": "origin_locode", "value": "" }, { "key": "dest_locode", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Score one voyage", "request": { "name": "Score one voyage", "description": { "content": "Synchronously scores one voyage and retains the assessment for 30 days.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_reference\": \"lane-NLRTM-CNSHA-001\",\n \"route\": {\n \"origin\": {\n \"locode\": \"NLRTM\"\n },\n \"destination\": {\n \"locode\": \"CNSHA\"\n },\n \"vessel_type\": \"container\",\n \"load_condition\": \"laden\",\n \"speed_knots\": 16,\n \"dwt_tonnes\": 100000\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Assessment created.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Monthly unit limit of the allowance this operation draws on (voyage assessments or screenings), for the authenticated key environment.", "key": "X-ArcNautical-Quota-Limit", "value": "" }, { "disabled": false, "description": "Units of that allowance remaining in the current UTC monthly period, AFTER this call settled — on a screening that came back INCOMPLETE the unit was refunded and this already reflects it.", "key": "X-ArcNautical-Quota-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when that monthly allowance resets.", "key": "X-ArcNautical-Quota-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n },\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"cached\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\",\n \"include_geometry\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Retrieve one assessment", "request": { "name": "Retrieve one assessment", "description": { "content": "Retrieves a previous assessment owned by the authenticated customer.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n },\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"cached\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessments", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create voyage assessment batch", "request": { "name": "Create voyage assessment batch", "description": { "content": "Validates and enqueues one batch of voyage routes. The per-batch cap is entitlement-specific — read live_max_routes / test_max_routes from GET /api/v1/usage rather than assuming a number. Self-serve keys carry 10. Only accepted route items reserve quota.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_reference\": \"q3-lanes\",\n \"routes\": [\n {\n \"customer_reference\": \"lane-001\",\n \"route\": {\n \"origin\": {\n \"locode\": \"BEANR\"\n },\n \"destination\": {\n \"locode\": \"USNYC\"\n },\n \"vessel_type\": \"container\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Batch accepted for processing.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Monthly unit limit of the allowance this operation draws on (voyage assessments or screenings), for the authenticated key environment.", "key": "X-ArcNautical-Quota-Limit", "value": "" }, { "disabled": false, "description": "Units of that allowance remaining in the current UTC monthly period, AFTER this call settled — on a screening that came back INCOMPLETE the unit was refunded and this already reflects it.", "key": "X-ArcNautical-Quota-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when that monthly allowance resets.", "key": "X-ArcNautical-Quota-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"total_count\": \"\",\n \"accepted_count\": \"\",\n \"failed_count\": \"\",\n \"created_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"routes\": [\n {\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n }\n ],\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get batch status", "request": { "name": "Get batch status", "description": { "content": "Returns batch status, counts, timestamps, and errors.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"total_count\": \"\",\n \"completed_count\": \"\",\n \"failed_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"error_body\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List batch items", "request": { "name": "List batch items", "description": { "content": "Returns cursor-paginated batch item results and partial failures.\n\nRequired scope: voyage:score.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"item_index\": \"\",\n \"customer_reference\": \"\",\n \"status\": \"\",\n \"assessment_id\": \"\",\n \"result_body\": {\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n },\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n }\n ],\n \"cached\": \"\"\n },\n \"error_body\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"attempts\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"item_index\": \"\",\n \"customer_reference\": \"\",\n \"status\": \"\",\n \"assessment_id\": \"\",\n \"result_body\": {\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n },\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n }\n ],\n \"cached\": \"\"\n },\n \"error_body\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n },\n {\n \"field\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"attempts\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "voyage-assessment-batches", ":id", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Corridor monitors", "description": { "content": "Standing route-risk subscriptions that deliver an event when a corridor score changes.", "type": "text/plain" }, "item": [ { "name": "Create corridor monitor", "request": { "name": "Create corridor monitor", "description": { "content": "Creates a live six-hour corridor monitor and queues the first baseline immediately. Test keys cannot create corridor monitors. The sandbox currently covers VESSEL monitors only — see POST /api/v1/vessel-monitors/{id}/simulate — so a webhook handler is best rehearsed there.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer_reference\": \"lane-NLRTM-CNSHA\",\n \"route\": {\n \"origin\": {\n \"locode\": \"NLRTM\"\n },\n \"destination\": {\n \"locode\": \"CNSHA\"\n },\n \"vessel_type\": \"container\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Monitor created and baseline queued.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"next_run_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"route\": {\n \"origin\": \"\",\n \"destination\": \"\",\n \"via\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n },\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd_per_tonne\": \"\"\n },\n \"customer_reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List corridor monitors", "request": { "name": "List corridor monitors", "description": { "content": "Lists live corridor monitors owned by the customer.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"monitors\": [\n {\n \"id\": \"\",\n \"status\": \"\",\n \"route_request\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"customer_reference\": \"\",\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd\": \"\"\n },\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_reference\": \"\",\n \"baseline_result\": {\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n },\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n }\n ],\n \"cached\": \"\"\n },\n \"baseline_score\": \"\",\n \"baseline_level\": \"\",\n \"confidence\": \"\",\n \"last_run_at\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"\",\n \"route_request\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"customer_reference\": \"\",\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd\": \"\"\n },\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_reference\": \"\",\n \"baseline_result\": {\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n },\n \"summary\": {\n \"value\": \"\"\n },\n \"event_count\": {\n \"value\": \"\"\n },\n \"signal_score\": {\n \"value\": \"\"\n },\n \"weight_pct\": {\n \"value\": \"\"\n },\n \"contribution_pct\": {\n \"value\": \"\"\n },\n \"contribution_band\": {\n \"value\": \"\"\n },\n \"sets_floor\": {\n \"value\": \"\"\n },\n \"relative_rank\": {\n \"value\": \"\"\n }\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"risk_level\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n }\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n },\n {\n \"country_code\": {\n \"value\": \"\"\n },\n \"country_name\": {\n \"value\": \"\"\n },\n \"risk_category\": {\n \"value\": \"\"\n },\n \"route_fraction\": {\n \"value\": \"\"\n },\n \"sanctions\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n },\n {\n \"source\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"checked_at\": {\n \"value\": \"\"\n },\n \"basis\": {\n \"value\": \"\"\n },\n \"message\": {\n \"value\": \"\"\n },\n \"label\": {\n \"value\": \"\"\n }\n }\n ],\n \"cached\": \"\"\n },\n \"baseline_score\": \"\",\n \"baseline_level\": \"\",\n \"confidence\": \"\",\n \"last_run_at\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get corridor monitor", "request": { "name": "Get corridor monitor", "description": { "content": "Retrieves one corridor monitor.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"next_run_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Pause or resume corridor monitor", "request": { "name": "Pause or resume corridor monitor", "description": { "content": "Updates one monitor status to active or paused.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"\",\n \"route_request\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"customer_reference\": \"\",\n \"vessel_type\": \"\",\n \"load_condition\": \"\",\n \"speed_knots\": \"\",\n \"dwt_tonnes\": \"\",\n \"fuel_type\": \"\",\n \"bunker_price_usd\": \"\"\n },\n \"next_run_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"customer_reference\": \"\",\n \"baseline_result\": {\n \"id\": \"\",\n \"route\": {\n \"origin_locode\": \"\",\n \"dest_locode\": \"\",\n \"via_waypoints\": [\n {\n \"lat\": \"\",\n \"lon\": \"\"\n },\n {\n \"lat\": \"\",\n \"lon\": \"\"\n }\n ],\n \"distance_nm\": \"\",\n \"geometry\": \"\"\n },\n \"score\": \"\",\n \"risk_level\": \"\",\n \"drivers\": [\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n },\n {\n \"source\": \"\",\n \"label\": \"\",\n \"summary\": \"\",\n \"event_count\": \"\",\n \"signal_score\": \"\",\n \"weight_pct\": \"\",\n \"contribution_pct\": \"\",\n \"contribution_band\": \"\",\n \"sets_floor\": \"\",\n \"relative_rank\": \"\"\n }\n ],\n \"jwc_intersected_areas\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"risk_level\": \"\",\n \"route_fraction\": \"\"\n }\n ],\n \"eez_transit\": [\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n },\n {\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"risk_category\": \"\",\n \"route_fraction\": \"\",\n \"sanctions\": {\n \"is_sanctioned\": \"\",\n \"regimes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n ],\n \"confidence\": \"\",\n \"missing_sources\": [\n \"\",\n \"\"\n ],\n \"methodology_version\": \"\",\n \"disclaimer\": \"\",\n \"assessed_at\": \"\",\n \"expires_at\": \"\",\n \"customer_reference\": \"\",\n \"score_floor\": {\n \"basis\": \"\",\n \"value\": \"\",\n \"explanation\": \"\",\n \"weighted_score\": \"\"\n },\n \"sources\": [\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n },\n {\n \"source\": \"\",\n \"status\": \"\",\n \"checked_at\": \"\",\n \"basis\": \"\",\n \"message\": \"\",\n \"label\": \"\"\n }\n ],\n \"cached\": \"\"\n },\n \"baseline_score\": \"\",\n \"baseline_level\": \"\",\n \"confidence\": \"\",\n \"last_run_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"action\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete corridor monitor", "request": { "name": "Delete corridor monitor", "description": { "content": "Deletes one corridor monitor.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get corridor monitor history", "request": { "name": "Get corridor monitor history", "description": { "content": "Returns up to 90 days of score and material-change history.\n\nRequired scope: voyage:monitor.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "cursor", "value": "", "description": "Opaque cursor returned by the previous page." }, { "disabled": false, "key": "limit", "value": "50", "description": "Maximum items to return. A value above the maximum is refused with 422, not clamped." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"history\": [\n {\n \"id\": \"\",\n \"assessment_id\": \"\",\n \"event_type\": \"\",\n \"score\": \"\",\n \"risk_level\": \"\",\n \"confidence\": \"\",\n \"driver_summary\": [\n \"\",\n \"\"\n ],\n \"change_body\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"assessment_id\": \"\",\n \"event_type\": \"\",\n \"score\": \"\",\n \"risk_level\": \"\",\n \"confidence\": \"\",\n \"driver_summary\": [\n \"\",\n \"\"\n ],\n \"change_body\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"next_cursor\": \"\",\n \"has_more\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "corridor-monitors", ":id", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "cursor", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Webhooks", "description": { "content": "HMAC-SHA256 signed delivery of every event type, with delivery history and redelivery.", "type": "text/plain" }, "item": [ { "name": "Create webhook endpoint", "request": { "name": "Create webhook endpoint", "description": { "content": "Creates an environment-specific HTTPS webhook endpoint after SSRF-safe URL validation.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/arcnautical/webhooks\",\n \"event_types\": [\n \"vessel_risk.changed\",\n \"screening_batch.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Webhook endpoint created; the signing secret is shown once.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"secret\": \"\",\n \"created_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": { "content": "Lists environment-specific webhook endpoints.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"endpoints\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get webhook endpoint", "request": { "name": "Get webhook endpoint", "description": { "content": "Retrieves one webhook endpoint.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Update webhook endpoint", "request": { "name": "Update webhook endpoint", "description": { "content": "Updates endpoint URL, status, or event subscriptions.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"is_active\": \"\",\n \"event_types\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete webhook endpoint", "request": { "name": "Delete webhook endpoint", "description": { "content": "Deletes one webhook endpoint.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deleted\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Send test webhook", "request": { "name": "Send test webhook", "description": { "content": "Queues and delivers a signed test event to one endpoint.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"queued\": \"\",\n \"delivered\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-endpoints", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Resource identifier." } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List webhook deliveries", "request": { "name": "List webhook deliveries", "description": { "content": "The delivery record for every event we tried to send you, newest first, including the ones that gave up. Delivery is attempted immediately, then after 5min, 30min, 2h and 12h; after the fifth failure the status is dead and it will NOT be retried.\n\nFilter with status=dead to find events you never received. dead_count and in_flight_count are account-wide, not page-local, so they answer \"is anything of mine lost right now\" rather than \"on this page\".\n\nA dead delivery is not the end: replay it with POST /api/v1/webhook-deliveries/{id}/redeliver.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-200. Default 50." }, { "disabled": false, "key": "cursor", "value": "", "description": "next_cursor from the previous page, unmodified." }, { "disabled": false, "key": "status", "value": "", "description": "Delivery state. Use dead for events that gave up after every retry." }, { "disabled": false, "key": "event_type", "value": "", "description": "One event type, for example vessel_risk.changed." }, { "disabled": false, "key": "endpoint_id", "value": "", "description": "Only deliveries to this endpoint." }, { "disabled": false, "key": "created_after", "value": "", "description": "ISO 8601 lower bound, inclusive." }, { "disabled": false, "key": "created_before", "value": "", "description": "ISO 8601 upper bound, inclusive." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"deliveries\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"status\": \"\",\n \"attempt\": \"\",\n \"created_at\": \"\",\n \"endpoint_id\": \"\",\n \"endpoint_url\": \"\",\n \"status_code\": \"\",\n \"error\": \"\",\n \"next_retry_at\": \"\",\n \"delivered_at\": \"\",\n \"replay_of\": \"\",\n \"payload\": {\n \"\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"status\": \"\",\n \"attempt\": \"\",\n \"created_at\": \"\",\n \"endpoint_id\": \"\",\n \"endpoint_url\": \"\",\n \"status_code\": \"\",\n \"error\": \"\",\n \"next_retry_at\": \"\",\n \"delivered_at\": \"\",\n \"replay_of\": \"\",\n \"payload\": {\n \"\": \"\"\n }\n }\n ],\n \"has_more\": \"\",\n \"dead_count\": \"\",\n \"in_flight_count\": \"\",\n \"next_cursor\": \"\",\n \"retry_schedule\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "event_type", "value": "" }, { "key": "endpoint_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get a webhook delivery", "request": { "name": "Get a webhook delivery", "description": { "content": "One delivery record including the payload exactly as it was signed and transmitted, so you can re-verify the HMAC signature yourself rather than take our word for what we sent.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"status\": \"\",\n \"attempt\": \"\",\n \"created_at\": \"\",\n \"endpoint_id\": \"\",\n \"endpoint_url\": \"\",\n \"status_code\": \"\",\n \"error\": \"\",\n \"next_retry_at\": \"\",\n \"delivered_at\": \"\",\n \"replay_of\": \"\",\n \"payload\": {\n \"\": \"\"\n }\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Replay a webhook delivery", "request": { "name": "Replay a webhook delivery", "description": { "content": "Queues a fresh attempt at an event, for when your endpoint was down while we were retrying. Accepted immediately, then the same five-attempt schedule.\n\nThis inserts a NEW delivery and leaves the original exactly as it ended. The record that an event failed five times is part of your audit trail, and a successful replay must not be able to erase it. The two are linked by replay_of and share an event_id.\n\nRefuses with 409 if the delivery is still in flight (it will retry on its own), if the endpoint has been deleted, or if the endpoint is disabled.\n\nRequired scope: webhooks:manage.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"replay_of\": \"\",\n \"event_id\": \"\",\n \"status\": \"\",\n \"event_type\": \"\",\n \"note\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "webhook-deliveries", ":id", "redeliver" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Exports", "description": { "content": "One file for a whole resource — screenings, cargo screenings, access log — instead of a paging loop.", "type": "text/plain" }, "item": [ { "name": "Export records to a file", "request": { "name": "Export records to a file", "description": { "content": "Start a bulk export and get back an id. The file is built in the background and downloaded from GET /api/v1/exports/{id}/download once status is completed — typically within a minute.\n\nThis is the answer to \"give me everything we screened in Q3\". It is a job rather than a large GET because a year of a real fleet does not fit inside a request timeout, and a response that dies halfway looks like a partial answer.\n\nThe row count is measured BEFORE the job is created. If the range holds more than 500,000 rows the request is refused with the real number, rather than producing a file that is silently short — an export missing rows is worse than no export, because everyone downstream treats it as complete.\n\nIf you leave filters.created_before out, it is pinned to the moment of the request and returned to you. That makes the export reproducible: without it, a job picked up a minute later would include rows written in between, and the same \"Q3\" request would produce a different file tomorrow.\n\nAn export reserves no quota and screens nothing. It reads records you already hold, and is governed by the same scope that governs reading them one at a time.\n\nRequired scope: any one of vessel:screen, cargo:screen, logs:read, whichever governs the resource you name.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Generated per Send. For a production gate derive it from the question (screening::) so a repeat of the same hull today replays free — see /developers/#screening.", "key": "Idempotency-Key", "value": "{{$guid}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"screenings\",\n \"format\": \"jsonl\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "name": "Export accepted and queued.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"resource\": \"\",\n \"format\": \"\",\n \"status\": \"\",\n \"filters\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"estimated_row_count\": \"\",\n \"row_count\": \"\",\n \"byte_size\": \"\",\n \"checksum_sha256\": \"\",\n \"download_url\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"download_count\": \"\",\n \"downloaded_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "(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.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"resource\": \"\",\n \"format\": \"csv\",\n \"filters\": {\n \"created_after\": \"\",\n \"created_before\": \"\",\n \"imo\": \"\",\n \"customer_reference\": \"\",\n \"sanctions_status\": \"\",\n \"status\": \"\",\n \"outcome\": \"\",\n \"method\": \"\",\n \"endpoint\": \"\",\n \"key_id\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "List your exports", "request": { "name": "List your exports", "description": { "content": "Exports created on this account and environment, newest first. Only resources your key holds the scope for are listed.\n\nRequired scope: any one of vessel:screen, cargo:screen, logs:read, whichever governs the resource you name.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-100. Default 25." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"exports\": [\n {\n \"id\": \"\",\n \"resource\": \"\",\n \"format\": \"\",\n \"status\": \"\",\n \"filters\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"estimated_row_count\": \"\",\n \"row_count\": \"\",\n \"byte_size\": \"\",\n \"checksum_sha256\": \"\",\n \"download_url\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"download_count\": \"\",\n \"downloaded_at\": \"\",\n \"completed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"resource\": \"\",\n \"format\": \"\",\n \"status\": \"\",\n \"filters\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"estimated_row_count\": \"\",\n \"row_count\": \"\",\n \"byte_size\": \"\",\n \"checksum_sha256\": \"\",\n \"download_url\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"download_count\": \"\",\n \"downloaded_at\": \"\",\n \"completed_at\": \"\"\n }\n ],\n \"retention_days\": \"\",\n \"max_rows\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "exports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Check an export", "request": { "name": "Check an export", "description": { "content": "Poll until status is completed, then follow download_url. download_url is absent until there is something to download, so readiness never has to be inferred from a status string next to a URL that would fail.\n\nStatuses: queued, running, completed, failed. A failed export carries the machine error under error.\n\nRequired scope: any one of vessel:screen, cargo:screen, logs:read, whichever governs the resource you name.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"resource\": \"\",\n \"format\": \"\",\n \"status\": \"\",\n \"filters\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"estimated_row_count\": \"\",\n \"row_count\": \"\",\n \"byte_size\": \"\",\n \"checksum_sha256\": \"\",\n \"download_url\": \"\",\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n },\n \"download_count\": \"\",\n \"downloaded_at\": \"\",\n \"completed_at\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Delete an export", "request": { "name": "Delete an export", "description": { "content": "Removes the export and its file immediately, rather than waiting for the 7-day expiry. The records the file was built from are untouched — an export is a copy, never the original.\n\nRequired scope: any one of vessel:screen, cargo:screen, logs:read, whichever governs the resource you name.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Download an export file", "request": { "name": "Download an export file", "description": { "content": "Returns the generated file. CSV carries a UTF-8 byte-order mark so vessel names render correctly in Excel — read it with encoding=\"utf-8-sig\" in Python. JSONL has no BOM, and each line is exactly the record the single-resource endpoint returns.\n\nThe SHA-256 of the file is returned in X-ArcNautical-Export-Sha256 and on the export resource, so an archived copy can be proven years later to be the one we generated.\n\n409 export_not_ready means the file is still building; 410 export_unavailable means it has expired or been deleted. Both are recoverable — poll, or create a new export.\n\nRequired scope: the scope governing the exported resource.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET" }, "response": [ { "name": "The export file.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "attachment, with a filename naming the resource, environment and creation time.", "key": "Content-Disposition", "value": "" }, { "disabled": false, "description": "SHA-256 of the file body, hex. Matches checksum_sha256 on the export resource.", "key": "X-ArcNautical-Export-Sha256", "value": "" }, { "disabled": false, "description": "Number of records in the file, excluding the CSV header row.", "key": "X-ArcNautical-Export-Rows", "value": "" }, { "key": "Content-Type", "value": "text/csv" } ], "body": "", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Export is not finished building.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "exports", ":id", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Export id." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "name": "Account", "description": { "content": "Usage, quotas and the access log for the authenticated key.", "type": "text/plain" }, "item": [ { "name": "Read your API access log", "request": { "name": "Read your API access log", "description": { "content": "Every authenticated request made with a key on this account, in this environment, newest first. The audit answer to \"who used our key, against what, and when\" — including the refusals, which is usually the half worth reading.\n\nRows carry the source IP the edge observed, the user agent, the key that was used, the HTTP status, the machine error_code on a refusal, and the request_id you were given at the time, so a line here joins directly to your own logs and to any support conversation about it.\n\nUnauthenticated requests are absent by construction: a rejected key carries no account to attribute it to. Calls that set the synthetic header ARE recorded — the header is caller-supplied, and an audit log you can opt out of by sending a header is not an audit log. Retained for 365 days.\n\nRequired scope: logs:read.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "", "description": "Rows per page, 1-200. Default 50." }, { "disabled": false, "key": "cursor", "value": "", "description": "next_cursor from the previous page, unmodified." }, { "disabled": false, "key": "status", "value": "", "description": "One HTTP status code, for example 403." }, { "disabled": false, "key": "outcome", "value": "", "description": "success (status under 400) or failure (400 and above)." }, { "disabled": false, "key": "method", "value": "", "description": "One HTTP method." }, { "disabled": false, "key": "endpoint", "value": "", "description": "Templated path with ids collapsed, for example /api/v1/screenings/{id}." }, { "disabled": false, "key": "key_id", "value": "", "description": "Only calls made with this key. The key id from the developer portal, never the key itself." }, { "disabled": false, "key": "created_after", "value": "", "description": "ISO 8601 lower bound, inclusive." }, { "disabled": false, "key": "created_before", "value": "", "description": "ISO 8601 upper bound, inclusive." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_log\": [\n {\n \"id\": \"\",\n \"occurred_at\": \"\",\n \"method\": \"\",\n \"path\": \"\",\n \"endpoint\": \"\",\n \"status\": \"\",\n \"ok\": \"\",\n \"error_code\": \"\",\n \"duration_ms\": \"\",\n \"request_id\": \"\",\n \"source_ip\": \"\",\n \"user_agent\": \"\",\n \"key_id\": \"\",\n \"key_prefix\": \"\"\n },\n {\n \"id\": \"\",\n \"occurred_at\": \"\",\n \"method\": \"\",\n \"path\": \"\",\n \"endpoint\": \"\",\n \"status\": \"\",\n \"ok\": \"\",\n \"error_code\": \"\",\n \"duration_ms\": \"\",\n \"request_id\": \"\",\n \"source_ip\": \"\",\n \"user_agent\": \"\",\n \"key_id\": \"\",\n \"key_prefix\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"environment\": \"\",\n \"retention_days\": \"\",\n \"next_cursor\": \"\",\n \"note\": \"\"\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "access-log" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "" }, { "key": "cursor", "value": "" }, { "key": "status", "value": "" }, { "key": "outcome", "value": "" }, { "key": "method", "value": "" }, { "key": "endpoint", "value": "" }, { "key": "key_id", "value": "" }, { "key": "created_after", "value": "" }, { "key": "created_before", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get usage", "request": { "name": "Get usage", "description": { "content": "Returns live and test usage, limits, remaining units, reset time, and monitor capacity.\n\nRequired scope: usage:read.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "name": "Successful response.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"product_code\": \"\",\n \"environment\": \"\",\n \"assessments\": {\n \"live\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"reserved\": \"\",\n \"remaining\": \"\",\n \"reset\": \"\"\n },\n \"test\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"reserved\": \"\",\n \"remaining\": \"\",\n \"reset\": \"\"\n }\n },\n \"batches\": {\n \"live_max_routes\": \"\",\n \"test_max_routes\": \"\"\n },\n \"monitors\": {\n \"limit\": \"\",\n \"used\": \"\",\n \"remaining\": \"\",\n \"cadence_hours\": \"\",\n \"history_days\": \"\"\n },\n \"concurrency\": {\n \"screenings_per_customer\": \"\",\n \"screenings_global\": \"\",\n \"enriched_screenings_global\": \"\",\n \"enriched_queue_max_wait_ms\": \"\",\n \"enriched_queue_per_customer\": \"\",\n \"assessments_per_customer\": \"\",\n \"requests_per_minute_per_key\": \"\"\n }\n}", "cookie": [] }, { "name": "Missing or invalid API key.\n\n`code` is one of:\n\n- `unauthorized` — No credential was supplied.\n- `invalid_api_key` — The key is unknown, revoked, expired, or its prefix does not match the environment.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "The monthly allowance for this resource is used up. The refused request is NOT metered. message states used/limit and the reset instant; a replay under an Idempotency-Key already answered is still free and is not metered, reads are never metered, and a test-environment key has its own allowance.\n\n`code` is one of:\n\n- `quota_exhausted` — The monthly allowance for this resource is spent. GET /api/v1/usage carries the reset date.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Idempotency conflict.\n\n`code` is one of:\n\n- `idempotency_conflict` — This Idempotency-Key was already used with a different body. Never resolves — use a new key.\n- `idempotency_in_progress` (retryable) — The original request with this key is still running, and this retry waited for it (up to 30s) without it finishing. Retry with the same key: the next retry waits again and returns the original result the moment it lands, flagged X-ArcNautical-Idempotent-Joined: true. Carries Retry-After.\n- `export_not_ready` (retryable) — The export job has not finished. Poll it; carries Retry-After.\n- `delivery_in_flight` (retryable) — That webhook delivery is being attempted right now.\n- `endpoint_disabled` — The webhook endpoint is disabled. Re-enable it first.\n- `endpoint_deleted` — The webhook endpoint no longer exists.\n- `monitor_limit_exceeded` — Corridor monitor ceiling reached. Delete one first.\n- `vessel_monitor_limit_exceeded` — Vessel monitor ceiling reached. Delete one first.\n- `vessel_monitor_exists` — A monitor already watches this hull.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Request or route validation failed. Also returned for a body field this endpoint does not read — field_violations names it and lists the accepted keys.\n\n`code` is one of:\n\n- `validation_failed` — One or more fields are invalid; field_violations names each one.\n- `route_not_found` — Both ports are known but no sea route connects them.\n- `export_too_large` — The requested range exceeds the per-export row cap. Narrow the filters and export in parts.\n- `webhook_url_blocked` — The URL resolves to a private, loopback or link-local address.\n- `webhook_url_unresolvable` — The URL host does not resolve.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] }, { "name": "Rate limit exceeded.\n\n`code` is one of:\n\n- `rate_limit_exceeded` (retryable) — Over the per-key request rate. Shed RATE; back off to X-RateLimit-Reset.\n- `concurrency_limit` (retryable) — Over your own in-flight ceiling. Shed CONCURRENCY, or use the batch endpoint. Retry-After carries a live estimate, not a fixed number.\n- `service_concurrency_limit` (retryable) — The shared pool is full and your account is within its allowance. A graded screen QUEUES for that pool first and is served round-robin between accounts, so this means the queue itself ran out of time — you were not stuck behind one customer's batch. Reducing your fan-out will NOT help; retry unchanged after Retry-After. include_vetting: false skips this queue entirely, and /api/v1/screening-batches is not subject to it at all.\n- `export_concurrency_limit` (retryable) — Too many exports building at once. Wait for one to finish.", "originalRequest": { "url": { "path": [ "api", "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "disabled": false, "description": "Request identifier supplied by the caller or generated by ArcNautical.", "key": "X-Request-Id", "value": "" }, { "disabled": false, "description": "Per-key requests allowed in the current one-minute window.", "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": "Requests remaining in the current one-minute window.", "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": "UTC timestamp when the current one-minute rate-limit window resets.", "key": "X-RateLimit-Reset", "value": "" }, { "disabled": false, "description": "Retry delay in seconds when a retry is appropriate.", "key": "Retry-After", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"request_id\": \"\",\n \"field_violations\": [\n {\n \"field\": \"\",\n \"message\": \"\"\n },\n {\n \"field\": \"\",\n \"message\": \"\"\n }\n ]\n}", "cookie": [] } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }