Create Batch Screening Request
2min
POST
AUTHENTICATION
Authorization
string
Bearer
BODY PARAMETERS
body
BatchQueryRequestPayload
*A list (array) of search queries, using the described schema. A maximum of 10k records is supported via API processing, for bigger payloads please use our [file upload endpoint ](https://api.sanctions.io/search/batch/upload/)
external_identifier
string
*Your own internal ID for the data record (customer/business partner). It will help you map the results to your own systems.
min_score
number
Minimum confidence-score results will have to match. (We recommend starting with a score of 0.75, which is a good starting point for most customers. More information in our "Best Practices" document.)
data_source
string
*The `short_name` of the data source/s (comma separated) you want to use for your search. The example uses only CAP or SDN as data sources. This parameter is mandatory in API version 2.1 and forward.
**Special keywords** we accept special data_sources keywords to group together data_sources making it easier to define the desired data sources.
**ALL** this keyword will include all 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
Name of a person or entity.
name_scoring_weight
integer
Relative weight (1 to 10) of the name for the confidence_score calculation (defaults is 9).
nationality
string
Nationality (the data format needs to be in ISO2).
nationality_scoring_weight
integer
Relative weight (1 to 10) of the nationalities in the score calculation (default is 3).
citizenship
string
Citizenship (format ISO2).
citizenship_scoring_weight
integer
Relative weight (1 to 10) of the citizenships in the score calculation (default is 3).
place_of_birth
string
Place of birth (City).
place_of_birth_scoring_weight
integer
Relative weight (1 to 10) of the place_of_birth in the score calculation (default is 3).
date_of_birth
string
Date of birth YYYY-MM-DD.
date_of_birth_scoring_weight
integer
Relative weight (1 to 10) of the date_of_birth in the score calculation (default is 3).
year_of_birth
integer
Integer, year of birth in format YYYY.
year_of_birth_scoring_weight
integer
Relative weight (1 to 10) of the year_of_birth in the score calculation (default is 3).
address
string
Address
address_scoring_weight
integer
Relative weight (1 to 10) of the address in the score calculation (defaults to 3).
country_residence
string
Country (ISO2) of residence
country_residence_scoring_weight
integer
Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).
entity_type
string<individual | entity | vessel | aircraft>
Type of entity (individual, entity, vessel, aircraft).
entity_type_scoring_weight
integer
Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).
vessel_imo
string
Vessel IMO search. Can be used as the only query parameter.
vessel_imo_scoring_weight
integer
Relative weight (1 to 10) of the vessel_imo in the score calculation (default is 3).
aircraft_id
string
Aircraft identifier (will search in 'aircraft_serial_identification' or 'aircraft_mode_s_transponder_code' db fields). Can be used as the sole query parameter.
aircraft_id_scoring_weight
integer
Relative weight (1 to 10) of the aircraft_id in the score calculation (default is 3).
wallet_address
string
Crypto Wallet Address (comma separated wallet addresses).
wallet_address_scoring_weight
integer
Relative weight (1 to 10) of the wallet_address in the score calculation (default is 3).
email
string
Emails address (comma separated if multiple addresses).
email_scoring_weight
integer
Relative weight (1 to 10) of the emails in the score calculation (default is 3).
RESPONSES
201
Created
BatchQueriesListResponseEntity
id
string
string representation of the object's unique identifier
timestamp
string
datetime the request was received
processed
boolean
Boolean the BatchQuery is already processed.
result_count
integer
Number of result queries with actual results in the batch.
url
string
url to fetch the batch screening results if any
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