website logo
Navigate through spaces
⌘K
Getting Started
Overview
Creating Your Account
Testing sanctions.io
Implementation
Implementation Guide
Best Practices
API Reference
Authorization & API Version
API Endpoints
Solutions
Manual Batch Screening
Sanctions Screening for SAP®
Sanctions Screening for BigID®
Integrating with Low-Code Tools
Changelog
Resources
FAQs
Sanctions & Watchlists
Legal Documents
Customer Support
Docs powered by archbee 

List Screenings

2min
GET

This endpoint will provide a list of queries performed, filtered by the parameters provided. We do not store the parameters of your request for data privacy reasons but we use a hash algorithm (one direction only) that enables us to store how you searched, but not what you searched for.

AUTHENTICATION
Authorization
string
Bearer
QUERY PARAMETERS
timestamp
string

Filter by searches after the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone.

from_timestamp
string

Filter by searches after (including) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone. (only available after version 2.1)

to_timestamp
string

Filter by searches before (not including) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone. (only available in version 2.1+)

is_sanctions
string
Filter by searches that were sanctions searches.
is_pep
string
Filter by searches that were PEP searches.
is_media
string
Filter by searches that were media searches.
result_count
number
Filter by searches that returned that amount of results in the response.
name_hash
string
Filter by searches which's hashed name is coincident.
page
number
Filter by searches that used that parameter in the request.
uuid
string

Each API request is stored with its own UUID, the stored UUID is returned in the response when you search for them, if you specify a UUID in this request you can get 1 result at most.

RESPONSES
200
OK
HistoricSearchResponse
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
HistoricSearchResultEntity[]
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
When there are form errors the response structure will be like this. In the case provided there was a problem in the field "name".
FormError
field_name
string
array




PREVIOUS
Manage Subscriptions
NEXT
List API Tokens
Docs powered by archbee