0min
Create Search Request

GET
This endpoint allows creating search requests against our Sanctions Lists and Criminal Watchlists database. Before starting with the integration it is very important to understand how the search and our confidence scoring model works. Please refer to our Best Practices for more information.
QUERY PARAMETERS
min_scorenumber
Minimum confidence score results have to match (0.1 = low confidence, 1.0 = high confidence, default is 0.75).
data_sourcestring*
The short_name of the data source/s (comma separated) you'd like to include for your search. This parameter is mandatory in API version 2.1 and forward.
ALL includes all of our covered data_sources (see a list of the covered data sources in our Resources section.) CRIME includes FBI and INTERPOL data sources. SANCTIONS includes all our Sanctions lists (excluding FBI and Interpol).
namestring*
Name of a person or entity
name_scoring_weightinteger
Relative weight (1 to 10) of the name for the confidence_score calculation (defaults is 6).
nationalitystring
Nationality of person (the data format needs to be in ISO2).
nationality_scoring_weightinteger
Relative weight (1 to 10) of the nationalities in the score calculation (defaults is 3).
citizenshipstring
Citizenship (Country ISO2)
citizenship_scoring_weightinteger
Relative weight (1 to 10) of the citizenships in the score calculation (default is 3).
place_of_birthstring
Place of birth (City).
place_of_birth_scoring_weightinteger
Relative weight (1 to 10) of the place_of_birth in the score calculation (default is 3).
date_of_birthstring
Date of Birth YYYY-MM-DD
date_of_birth_scoring_weightinteger
Relative weight (1 to 10) of the date_of_birth in the score calculation (default is 3).
year_of_birthinteger
Year of Birth in format YYYY
year_of_birth_scoring_weightinteger
Relative weight (1 to 10) of the year_of_birth in the score calculation (default is 3).
addressstring
Address, can be used as a sole search parameter from version 2.1 onwards.
address_scoring_weightinteger
Relative weight (1 to 10) of the address in the score calculation (defaults to 3).
country_residencestring
Country of residency (ISO2)
country_residence_scoring_weightinteger
Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).
entity_typestring
Type of entity (individual, entity, vessel, aircraft).
entity_type_scoring_weightinteger
Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).
vessel_imostring
Vessel IMO search. Can be used as the sole query parameter.
vessel_imo_scoring_weightinteger
Relative weight (1 to 10) of the vessel_imo in the score calculation (default is 3).
aircraft_idstring
Aircraft identifier (will search in 'aircraft_serial_identification' or 'aircraft_mode_s_transponder_code' db fields). Can be used as the only query parameter.
aircraft_id_scoring_weightinteger
Relative weight (1 to 10) of the aircraft_id in the score calculation (default is 3).
wallet_addressstring
Crypto Wallet address (comma separated wallet addresses).
wallet_address_scoring_weightinteger
Relative weight (1 to 10) of the wallet_address in the score calculation (default is 3).
emailstring
Email address (comma separated if multiple addresses).
email_scoring_weightinteger
Relative weight (1 to 10) of the emails in the score calculation (default is 3).
RESPONSES
200
OK
SearchResponse
countinteger
total number or records in the result
nextstring
url to fetch the next page of results if any
previousstring
url to fetch the previous page of results if any
results
SearchResultEntity[]
401
Error message when token is missing.
Error401
detailstring
Error reason
403
Error message when you don't have the appropriate plan.
Error403
detailstring
Error reason
4XX
Problem with request structure.
FormError
field_namestring
array
Updated 08 Nov 2022
UP NEXT
Create Batch Screening Request
Docs powered by archbee