GET/api/v1/screen
Screen vessels against sanctions lists
Up to 50 vessels (more than one per request needs Pro or any paid API plan; a Free key screens one vessel per request) screened by identifier against every sanctions list Voydar holds whose source permits API use (OFAC SDN, UK, Canada, EU and New Zealand today; a list without that right, such as the French asset-freeze register while its licence is confirmed, is named under `notScreened` and `withheld`, never screened): a designation matches when its IMO (or a listed IMO) or its MMSI equals the vessel's. Names are never matched, so no match means no designation carrying that identifier. Each vessel lists its active and past designations with the list's own facts and source link.
1 credit per vesselKey required
| Name | In | Description |
|---|---|---|
| ids(required) | query | Comma list of up to 50 IMO numbers or "mmsi-" identifiers. |
| lists | query | Comma list of lists to screen: ofac, uk, canada, eu, new-zealand, france (default all whose source permits API use). |
curl -H "Authorization: Bearer $VOYDAR_API_KEY" \
https://www.voydar.com/api/v1/screen?ids=9811000,9166778Response (abridged)
{
"type": "screen",
"method": "Identifier match only: …",
"count": 2,
"sanctionedCount": 1,
"data": [
{ "query": "9166778", "imo": 9166778, "name": "…", "sanctioned": true,
"activeDesignations": [ { "list": "ofac_sdn", "listName": "OFAC SDN list", "program": "…", "listedAt": null, "matchedOn": "imo", "sourceUrl": "…" } ],
"pastDesignations": [] },
{ "query": "9811000", "imo": 9811000, "name": "EVER GIVEN", "sanctioned": false, "activeDesignations": [], "pastDesignations": [] }
],
"withheld": [],
"attribution": [ "…" ], "license": [ "…" ], "sources": ["ofac_sdn"]
}