Developer centerv1.0.0
Documentation menu
Data models

SearchQuery

Fields, types and constraints for the SearchQuery public API model.

Normalized search request accepted as query parameters or a JSON body.

Fields

FieldTypeConstraintExampleVisibility
name *

Legal name, display name or known alias to search.

stringminLength: 2 · maxLength: 160"AEROCARIBBEAN AIRLINES"Public contract
type

Entity or identifier type.

EntityType{}Public contract
gender

Optional gender value for person records.

string"example"Public contract
birthDate

Birth date filter in YYYY, YYYY-MM or YYYY-MM-DD format.

stringpattern: ^\d{4}(-\d{2}(-\d{2})?)?$"example"Personal context
nationality

Nationality filter for person records.

string"example"Personal context
country

Entity, identifier or address country.

string"example"Personal context
source

Canonical sanctions data source.

stringenum: OFAC | MASAK | EU_RESTRICTED | UK_HMT | UN_CONSOLIDATED | OFAC_SDN | OFAC_ALT | EU | UK | UN"OFAC"Public contract
sources

Canonical data sources included in the search.

string[][]Public contract
identifier

Single identifier value for a GET request.

string"example"Personal context
identifiers

Typed identifiers for a POST request.

SearchIdentifier[][]Personal context
page

One-based page number.

integermin: 11Public contract
pageSize

Requested or returned records per page.

integermin: 1 · max: 10025Public contract

Machine-readable schema

The model is published under the same name in the JSON Schema bundle.

JSON Schema

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.