Search for entities in sanction lists

Changed on

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

get/v2/search

Request

  • Base URL
    http://localhost:8084
  • URL
    http://localhost:8084/v2/search
  • Auth
    none declared

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'

Entity type partition (person, business, organization, aircraft, vessel). Optional. Omit to search every type (slower). A wrong type searches only that partition and can miss the hit. GET fields such as birthDate and gov_* are only read when type is set.

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

algorithm'jaro-winkler' | 'soundex' | 'soft-bidist' | 'soft-bisim' | 'editex' | 'nsim' | 'nsim-3' | 'double-metaphone' | 'beider-morse'

String matching algorithm. Defaults to jaro-winkler. Phonetic options (soundex, double-metaphone, beider-morse) boost Jaro-Winkler. Inner scorers (soft-bidist, soft-bisim, editex, nsim, nsim-3) replace the token metric.

requestIDstring

Client-provided ID for request tracking

boolean
OR
number float

Include field-level score pieces on returned hits. true/yes/1 attaches debug to every returned result. A number such as 0.80 attaches debug only when match is at least that score. Debug is computed after ranking, only for those hits.

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. Scheme, path, and a leading www. are ignored so https://www.example.com/about matches a listed www.example.com.

websitesstring[]

Alternative parameter for websites of the entity. Same host matching as website.

domainstring[]

DNS name to match against websites and email hosts. Every label from the query host down to eTLD+1 (Public Suffix List) is tried, so mail.suex.io matches a listed suex.io. Public suffixes (co.uk, ru) are ignored. Consumer mail hosts extracted from emails (gmail, yahoo, mail.ru) are not indexed.

domainsstring[]

Alternative parameter for domain. Same Public Suffix List matching as domain.

swiftstring[]

ISO 9362 SWIFT/BIC code. 8- and 11-character forms match on the first eight characters (XXX is the head office). Always read, including when type is omitted. Alias of bic. A matching SWIFT/BIC scores 1.0.

bicstring[]

Alias of swift. ISO 9362 SWIFT/BIC code.

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

Changes

    • info

      added the new optional query request parameter bic

    • info

      added the new optional query request parameter swift

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the new optional query request parameter domain

    • info

      added the new optional query request parameter domains

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property // to the response with the status