Documentation menu
SearchQuery
Fields, types and constraints for the SearchQuery public API model.
Normalized search request accepted as query parameters or a JSON body.
Fields
| Field | Type | Constraint | Example | Visibility |
|---|---|---|---|---|
name *Legal name, display name or known alias to search. | string | minLength: 2 · maxLength: 160 | "AEROCARIBBEAN AIRLINES" | Public contract |
typeEntity or identifier type. | EntityType | — | {} | Public contract |
genderOptional gender value for person records. | string | — | "example" | Public contract |
birthDateBirth date filter in YYYY, YYYY-MM or YYYY-MM-DD format. | string | pattern: ^\d{4}(-\d{2}(-\d{2})?)?$ | "example" | Personal context |
nationalityNationality filter for person records. | string | — | "example" | Personal context |
countryEntity, identifier or address country. | string | — | "example" | Personal context |
sourceCanonical sanctions data source. | string | enum: OFAC | MASAK | EU_RESTRICTED | UK_HMT | UN_CONSOLIDATED | OFAC_SDN | OFAC_ALT | EU | UK | UN | "OFAC" | Public contract |
sourcesCanonical data sources included in the search. | string[] | — | [] | Public contract |
identifierSingle identifier value for a GET request. | string | — | "example" | Personal context |
identifiersTyped identifiers for a POST request. | SearchIdentifier[] | — | [] | Personal context |
pageOne-based page number. | integer | min: 1 | 1 | Public contract |
pageSizeRequested or returned records per page. | integer | min: 1 · max: 100 | 25 | Public contract |
Machine-readable schema
The model is published under the same name in the JSON Schema bundle.
JSON SchemaDecision boundary
An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.