Create Search Request

2min
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.
AUTHENTICATION
Authorization
Bearer
Bearer
QUERY PARAMETERS
min_score
number
Example: 0.75
Minimum confidence score filter (0.1 = low confidence, 1.0 = high confidence, default is 0.75).
data_source
string
*
Example: CAP,SDN
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 onward. See a list of all supported sources here.
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-LISTS includes all our Sanctions lists (excluding FBI and Interpol). HIGH-RISK-JURISDICTIONS* covers all jurisdiction lists.
name
string
*
Example: juan
Name of a person or entity
name_scoring_weight
integer
Example: 6
Relative weight (1 to 10) of the name for the confidence_score calculation (default is 9).
entity_type
string
Example: Individual
Type of entity (individual, entity, vessel, aircraft).
entity_type_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).
country_residence
string
Example: FR, ES
Country of residency (ISO2)
country_residence_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).
date_of_birth
string
Date of Birth YYYY-MM-DD.
date_of_birth_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the date_of_birth in the score calculation (default is 3).
year_of_birth
integer
Example: 1980
Year of Birth in format YYYY
year_of_birth_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the year_of_birth in the score calculation (default is 3).
nationality
string
Example: FR,GR
Nationality of person (the data format needs to be in ISO2).
nationality_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the nationalities in the score calculation (default is 3).
citizenship
string
Example: FR,GR
Citizenship (Country ISO2).
citizenship_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the citizenships in the score calculation (default is 3).
place_of_birth
string
Example: FR
Place of birth (City).
place_of_birth_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the place_of_birth in the score calculation (default is 3).
address
string
Example: PARIS Île-de-France
Address, can be used as a sole search parameter from version 2.1 onwards.
address_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the address in the score calculation (defaults to 3).
vessel_imo
string
Example: 1223ES
Vessel IMO search. Can be used as the sole query parameter.
vessel_imo_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the vessel_imo in the score calculation (default is 3).
aircraft_id
string
Example: 23THR2
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_weight
integer
Example: 3
Relative weight (1 to 10) of the aircraft_id in the score calculation (default is 3).
wallet_address
string
Example: 82pE31FzKSQpvXXHfMzfMe329BcsZoMNQ3
Crypto Wallet address (comma separated wallet addresses).
wallet_address_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the wallet_address in the score calculation (default is 3).
email
string
Example: some@here.com,other@there.org
Email address (comma separated if multiple addresses).
email_scoring_weight
integer
Example: 3
Relative weight (1 to 10) of the emails in the score calculation (default is 3).
RESPONSES
200
OK
SearchResponse
count
integer
total number or records in the result
next
string
url to fetch the next page of results if any
previous
string
url to fetch the previous page of results if any
results
SearchResultEntity[]
401
Error message when there is no token provided.
Error401
detail
string
Error reason
403
Error message when you don't have the appropriate plan.
Error403
detail
string
Error reason
4XX
Problem with request structure.
FormError
field_name
string
array
﻿
﻿
Authorization & API Version
Create Batch Screening Request
Docs powered by
Archbee