Sign in

v3

OpenAPI 3.1.02026-08-03124249.6 KB
Matching

Simple entity search

Search endpoint for matching entities based on a simple piece of text, e.g. a name. This can be used to implement a simple, user-facing search. For proper entity matching, the multi-property matching API should be used instead.

Search queries can include field-specific fitlers, wildcards and fuzzy searches. See also: search API documentation.

get/search/{dataset}

Path parameters

datasetstring required

Data source or collection name to scope the query to.

Example:default

Data source or collection name to scope the query to.

Query parameters

qstring
schemastring
include_datasetstring[]

Limit the results to entities that are part of at least one of the given datasets.

Limit the results to entities that are part of at least one of the given datasets.

exclude_datasetstring[]
exclude_schemastring[]
changed_sincestring nullable
countriesstring[]
topicsstring[]
datasetsstring[]
filterstring[]

Use the syntax field:value to filter on a specific field. Properties are indexed as fields named properties.birthDate:1985.

Use the syntax field:value to filter on a specific field. Properties are indexed as fields named properties.birthDate:1985.

limitinteger
offsetinteger
sortstring[]
targetboolean nullable

Please specify a list of topics of concern, instead.

Please specify a list of topics of concern, instead.

fuzzyboolean
simpleboolean
facetsFacet[]
filter_op'AND' | 'OR'

Logic to use when combining multiple filters on the same field (topics, countries, datasets). Please specify AND for new integrations (to override a legacy default) and when building a faceted user interface.

Response

Successful Response

limitinteger required
offsetinteger
facetsobject required

Example response

{
  "limit": 20,
  "total": {
    "value": 42,
    "relation": "eq"
  },
  "results": [
    {
      "id": "NK-A7z....",
      "caption": "John Doe",
      "schema": "LegalEntity",
      "properties": {
        "name": [
          "John Doe"
        ]
      },
      "datasets": [
        "us_ofac_sdn"
      ],
      "referents": [
        "ofac-1234"
      ],
      "first_seen": "2026-07-31T20:37:29.825277Z",
      "last_seen": "2026-07-31T20:37:29.825277Z",
      "last_change": "2026-07-31T20:37:29.825277Z"
    }
  ]
}