Restricted Party Screening

POST/v1/compliance/restricted-party-screening$0.05 per call

Screen parties against the trade.gov Consolidated Screening List — 25,000+ entries from OFAC SDN, BIS Entity List, and 12+ other federal watchlists.

Send an Idempotency-Key header to retry safely.

Request body

Field	Type	Description
partiesrequired	array of object	max 50 items
parties[].namerequired	string	max length 500
parties[].countryoptional	string	ISO-2/3 country code max length 3
parties[].addressoptional	string	max length 1000
parties[].typeoptional	string	Party role, free text up to 50 characters (for example CONSIGNEE, INTERMEDIATE_CONSIGNEE, END_USER, PURCHASER, USPPI, FREIGHT_FORWARDER) max length 50

Response fields

Field	Type	Description
success	boolean	e.g. `true`
data	object
data.id	string	e.g. `rps_8fa6fad621cab112`
data.screeningDate	string	e.g. `2026-11-04T09:01:07.982Z`
data.totalPartiesScreened	number	e.g. `1`
data.totalMatches	number	e.g. `0`
data.overallResult	string	e.g. `CLEAR`
data.results	array
data.results[].party	object
data.results[].result	string	e.g. `CLEAR`
data.results[].matchCount	number	e.g. `0`
data.results[].matches	array
data.listsScreened	array
data.listsScreened[].name	string	e.g. `Nonproliferation Sanctions (ACN) - State Department`
data.listsScreened[].authority	string	e.g. `U.S. Government`
data.listsScreened[].lastUpdated	string	e.g. `2026-11-04`
data.listVersion	string	e.g. `58f4d6155f88d413`
data.listRetrievedAt	string	e.g. `2026-11-03T10:30:35.601Z`
data.listSource	string	e.g. `trade.gov Consolidated Screening List (database sync)`
data.screeningId	string	e.g. `cmw1w074f00lg2lrc5uzocyts`
meta	object
meta.requestId	string	e.g. `rps_8fa6fad621cab112`
meta.timestamp	string	e.g. `2026-11-04T09:01:07.982Z`
meta.processingTimeMs	number	e.g. `1428`
meta.dataSource	object
meta.dataSource.name	string	e.g. `ComplianceGrid`
meta.dataSource.provenance	string	e.g. `computed`

Fields are read from a real response captured 2026-11-04, shortened. Optional fields may be absent in other responses.

Errors

400 invalid request
401 missing or bad key
403 not in your plan
429 rate limited, see Retry-After
402 payment required
5xx retry with backoff

Error bodies and codes are described in Error codes and troubleshooting.

curl -X POST "https://api.compliancegrid.ai/v1/compliance/restricted-party-screening" \
  -H "Authorization: Bearer $CG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "parties": [
      {
        "name": "Acme Widgets Ltd",
        "country": "GB",
        "type": "CONSIGNEE"
      }
    ]
  }'

Try it in the sandbox

Runs against sandbox.api.compliancegrid.ai with your own sandbox key, which stays in this browser. Sandbox responses are mock data. Get a free key.

Sandbox key

Remember for this tab

Request body (JSON)

Example response · captured from production 2026-11-04 · shortened

{
  "success": true,
  "data": {
    "id": "rps_8fa6fad621cab112",
    "screeningDate": "2026-11-04T09:01:07.982Z",
    "totalPartiesScreened": 1,
    "totalMatches": 0,
    "overallResult": "CLEAR",
    "results": [
      {
        "party": {
          "name": "Acme Widgets Ltd",
          "country": "GB",
          "type": "CONSIGNEE"
        },
        "result": "CLEAR",
        "matchCount": 0,
        "matches": []
      }
    ],
    "listsScreened": [
      {
        "name": "Nonproliferation Sanctions (ACN) - State Department",
        "authority": "U.S. Government",
        "lastUpdated": "2026-11-04"
      },
      {
        "name": "Capta List (CAP) - Treasury Department",
        "authority": "OFAC",
        "lastUpdated": "2026-11-04"
      }
    ],
    "listVersion": "58f4d6155f88d413",
    "listRetrievedAt": "2026-11-03T10:30:35.601Z",
    "listSource": "trade.gov Consolidated Screening List (database sync)",
    "screeningId": "cmw1w074f00lg2lrc5uzocyts"
  },
  "meta": {
    "requestId": "rps_8fa6fad621cab112",
    "timestamp": "2026-11-04T09:01:07.982Z",
    "processingTimeMs": 1428,
    "dataSource": {
      "name": "ComplianceGrid",
      "provenance": "computed"
    }
  }
}