Consolidated Screening List data contract

Provenance

PublisherU.S. Consolidated Screening List

Sourcehttps://www.trade.gov/consolidated-screening-list

API basehttps://data.trade.gov/consolidated_screening_list/v1

Docshttps://developer.trade.gov/apis

Freshness & coverage

FreshnessScheduled · every P1D — Official tools refresh daily at 5:00 AM Eastern.

GeographicGlobal

Temporal… → present — Current consolidated source-list records; this connector does not expose historical snapshots.

AuthenticationCredentials required (API key)

Caveats

⚠ A returned record is a potential match; verify official source lists before acting.

Methods (3)

searchRestrictedParties

read

Screen a business or person for sanctions and U.S. export restrictions.

Required paramsname

Entitiesrestricted-party

Paginationoffset (offsetField: offset, limitField: limit)

FreshnessScheduled · every P1D

Input schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Legal entity or person name."
    },
    "fuzzyName": {
      "type": "boolean",
      "default": true
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      },
      "maxItems": 25
    },
    "countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 80
      },
      "maxItems": 25
    },
    "type": {
      "type": "string",
      "enum": [
        "Entity",
        "Individual",
        "Vessel",
        "Aircraft"
      ]
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Output schema

{
  "type": "object",
  "properties": {
    "screeningStatus": {
      "type": "string",
      "enum": [
        "potential_match",
        "no_potential_match"
      ]
    },
    "query": {
      "type": "object",
      "additionalProperties": true
    },
    "total": {
      "type": "integer"
    },
    "matches": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "searchedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "sourcesUsed": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "disclaimer": {
      "type": "string"
    }
  },
  "required": [
    "screeningStatus",
    "query",
    "total",
    "matches",
    "searchedAt",
    "sourcesUsed",
    "disclaimer"
  ],
  "additionalProperties": true
}

⚠ No potential match is not a compliance determination.

Potential matches require official-list verification.

listSources

read

List source-list metadata exposed by the CSL service.

Entitiesrestricted-party-list

Paginationnone

FreshnessScheduled · every P1D

Output schema

{
  "type": "object",
  "properties": {
    "sources": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "disclaimer": {
      "type": "string"
    }
  },
  "required": [
    "sources",
    "disclaimer"
  ],
  "additionalProperties": true
}

getServiceInfo

read

Describe CSL coverage, credentials, freshness, and match semantics.

Entitiesservice-metadata

Paginationnone

FreshnessScheduled · every P1D (source-level)

Output schema

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string"
    },
    "auth": {
      "type": "string"
    },
    "freshness": {
      "type": "string"
    },
    "methods": {
      "type": "object",
      "additionalProperties": true
    },
    "disclaimer": {
      "type": "string"
    }
  },
  "required": [
    "service",
    "auth",
    "freshness",
    "methods",
    "disclaimer"
  ],
  "additionalProperties": true
}