v1

latestOpenAPI 3.0.2Apache 2.02026-07-1762135.5 KB

Search for entities in sanction lists

Search for entities in the sanction lists based on the provided parameters

get/v2/search

Query parameters

namestring

Name of the entity to search for

sourcestring

Source list to filter entity

sourceIDstring

Original list identifier

type'person' | 'business' | 'organization' | 'aircraft' | 'vessel'

Type of entity to search for

altNamesstring[]

Alternative names for the entity

limitinteger

Maximum number of results to return (default 10, max 100)

minMatchnumber float

Minimum match threshold for search results

requestIDstring

Client-provided ID for request tracking

debugboolean

Enable debug mode for additional information

debugSourceIDsstring

Comma-separated list of source IDs to debug

format'watchman' | 'senzing' | 'senzing/json' | 'senzing/jsonl' | 'senzing/ndjson'

Output format for the search response (default watchman). May also be set via the Accept header.

genderstring

Gender of the person (for type=person)

birthDatestring

Birth date of the person (for type=person) in YYYY-MM-DD, YYYY-MM, or YYYY format

deathDatestring

Death date of the person (for type=person) in YYYY-MM-DD, YYYY-MM, or YYYY format

titlesstring[]

Titles of the person (for type=person)

createdstring

Creation date of the business/organization in YYYY-MM-DD, YYYY-MM, or YYYY format

dissolvedstring

Dissolution date of the business/organization in YYYY-MM-DD, YYYY-MM, or YYYY format

aircraftTypestring

Type of aircraft (for type=aircraft)

icaoCodestring

ICAO code of the aircraft (for type=aircraft)

modelstring

Model of the aircraft (for type=aircraft) or vessel (for type=vessel)

serialNumberstring

Serial number of the aircraft (for type=aircraft)

builtstring

Build date of the aircraft (for type=aircraft) or vessel (for type=vessel) in YYYY-MM-DD, YYYY-MM, or YYYY format

flagstring

Flag/country of the aircraft (for type=aircraft) or vessel (for type=vessel)

imoNumberstring

IMO number of the vessel (for type=vessel)

vesselTypestring

Type of vessel (for type=vessel)

mmsistring

MMSI of the vessel (for type=vessel)

callSignstring

Call sign of the vessel (for type=vessel)

ownerstring

Owner of the vessel (for type=vessel)

tonnageinteger

Tonnage of the vessel (for type=vessel)

grossRegisteredTonnageinteger

Gross registered tonnage of the vessel (for type=vessel)

emailstring[]

Email address of the entity

emailAddressstring[]

Alternative parameter for email address of the entity

emailAddressesstring[]

Alternative parameter for email addresses of the entity

phonestring[]

Phone number of the entity

phoneNumberstring[]

Alternative parameter for phone number of the entity

phoneNumbersstring[]

Alternative parameter for phone numbers of the entity

faxstring[]

Fax number of the entity

faxNumberstring[]

Alternative parameter for fax number of the entity

faxNumbersstring[]

Alternative parameter for fax numbers of the entity

websitestring[]

Website of the entity

websitesstring[]

Alternative parameter for websites of the entity

addressstring[]

Address of the entity

addressesstring[]

Alternative parameter for addresses of the entity

cryptoAddressstring[]

Cryptocurrency address of the entity in format CURRENCY:ADDRESS (e.g., XBT:x123456)

cryptoAddressesstring[]

Alternative parameter for cryptocurrency addresses of the entity

gov_passportstring

Passport identifier in country:identifier format

gov_drivers-licensestring

Driver's license identifier in country:identifier format

gov_national-idstring

National ID in country:identifier format

gov_tax-idstring

Tax ID in country:identifier format

gov_ssnstring

Social Security Number in country:identifier format

gov_cedulastring

Cedula identifier in country:identifier format

gov_curpstring

CURP identifier in country:identifier format

gov_cuitstring

CUIT identifier in country:identifier format

gov_electoralstring

Electoral identifier in country:identifier format

gov_business-registrationstring

Business registration number in country:identifier format

gov_commercial-registrystring

Commercial registry number in country:identifier format

gov_birth-certificatestring

Birth certificate number in country:identifier format

gov_refugee-idstring

Refugee ID in country:identifier format

gov_diplomatic-passportstring

Diplomatic passport identifier in country:identifier format

gov_personal-idstring

Personal ID in country:identifier format

gov_citizenshipstring

Citizenship identifier in country:identifier format

gov_nationalitystring

Nationality identifier in country:identifier format

Response

Successful search