API Reference
...
API Endpoints
Sanctions Screening
Create Batch Screening Request
1min
POST
Authentication
Authorization
Bearer
Body Parameters
body
BatchQueryRequestPayload
*
Description
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
*
min_score
number
data_source
string
*
name
string
name_scoring_weight
integer
nationality
string
nationality_scoring_weight
integer
citizenship
string
citizenship_scoring_weight
integer
place_of_birth
string
place_of_birth_scoring_weight
integer
date_of_birth
string
date_of_birth_scoring_weight
integer
year_of_birth
integer
year_of_birth_scoring_weight
integer
address
string
address_scoring_weight
integer
country_residence
string
country_residence_scoring_weight
integer
entity_type
string<individual | entity | vessel | aircraft>
entity_type_scoring_weight
integer
vessel_imo
string
vessel_imo_scoring_weight
integer
aircraft_id
string
aircraft_id_scoring_weight
integer
wallet_address
string
wallet_address_scoring_weight
integer
email
string
email_scoring_weight
integer
Responses
201
Created
BatchQueriesListResponseEntity
id
string
timestamp
string
processed
boolean
result_count
integer
url
string
401
Error message when there is no token provided.
Error401
detail
string
403
Error message when you don't have the appropriate plan.
Error403
detail
string