Search for entities in sanction lists
Changed onSearch for entities in the sanction lists based on the provided parameters
Request
- Base URLhttp://localhost:8084
- URLhttp://localhost:8084/v2/search
- Authnone declared
Query parameters
Name of the entity to search for
Source list to filter entity
Original list identifier
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.
Alternative names for the entity
Maximum number of results to return (default 10, max 100)
Minimum match threshold for search results
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.
Client-provided ID for request tracking
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.
Comma-separated list of source IDs to debug
Output format for the search response (default watchman). May also be set via the Accept header.
Gender of the person (for type=person)
Birth date of the person (for type=person) in YYYY-MM-DD, YYYY-MM, or YYYY format
Death date of the person (for type=person) in YYYY-MM-DD, YYYY-MM, or YYYY format
Titles of the person (for type=person)
Creation date of the business/organization in YYYY-MM-DD, YYYY-MM, or YYYY format
Dissolution date of the business/organization in YYYY-MM-DD, YYYY-MM, or YYYY format
Type of aircraft (for type=aircraft)
ICAO code of the aircraft (for type=aircraft)
Model of the aircraft (for type=aircraft) or vessel (for type=vessel)
Serial number of the aircraft (for type=aircraft)
Build date of the aircraft (for type=aircraft) or vessel (for type=vessel) in YYYY-MM-DD, YYYY-MM, or YYYY format
Flag/country of the aircraft (for type=aircraft) or vessel (for type=vessel)
IMO number of the vessel (for type=vessel)
Type of vessel (for type=vessel)
MMSI of the vessel (for type=vessel)
Call sign of the vessel (for type=vessel)
Owner of the vessel (for type=vessel)
Tonnage of the vessel (for type=vessel)
Gross registered tonnage of the vessel (for type=vessel)
Email address of the entity
Alternative parameter for email address of the entity
Alternative parameter for email addresses of the entity
Phone number of the entity
Alternative parameter for phone number of the entity
Alternative parameter for phone numbers of the entity
Fax number of the entity
Alternative parameter for fax number of the entity
Alternative parameter for fax numbers of the entity
Website of the entity. Scheme, path, and a leading www. are ignored so https://www.example.com/about matches a listed www.example.com.
Alternative parameter for websites of the entity. Same host matching as website.
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.
Alternative parameter for domain. Same Public Suffix List matching as domain.
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.
Alias of swift. ISO 9362 SWIFT/BIC code.
Address of the entity
Alternative parameter for addresses of the entity
Cryptocurrency address of the entity in format CURRENCY:ADDRESS (e.g., XBT:x123456)
Alternative parameter for cryptocurrency addresses of the entity
Passport identifier in country:identifier format
Driver's license identifier in country:identifier format
National ID in country:identifier format
Tax ID in country:identifier format
Social Security Number in country:identifier format
Cedula identifier in country:identifier format
CURP identifier in country:identifier format
CUIT identifier in country:identifier format
Electoral identifier in country:identifier format
Business registration number in country:identifier format
Commercial registry number in country:identifier format
Birth certificate number in country:identifier format
Refugee ID in country:identifier format
Diplomatic passport identifier in country:identifier format
Personal ID in country:identifier format
Citizenship identifier in country:identifier format
Nationality identifier in country:identifier format
Response
Successful search
Changes
- info
added the new optional
queryrequest parameterbic - info
added the new optional
queryrequest parameterswift - info
added the optional property
//////to the response with the status - info
added the optional property
/to the response with the status
- info
- info
added the new optional
queryrequest parameterdomain - info
added the new optional
queryrequest parameterdomains - info
added the optional property
///////to the response with the status - info
added the optional property
//to the response with the status
- info