website logo
⌘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 your CRM
Changelog
Resources
FAQs
Sanctions & Watchlists
Legal Documents
Customer Support
Docs powered by archbee 
0min

List Screenings

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.

QUERY PARAMETERS
timestampstring

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_timestampstring

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_timestampstring

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_sanctionsstring
Filter by searches that were sanctions searches.
is_pepstring
Filter by searches that were PEP searches.
is_mediastring
Filter by searches that were media searches.
result_countnumber
Filter by searches that returned that amount of results in the response.
name_hashstring
Filter by searches which's hashed name is coincident.
pagenumber
Filter by searches that used that parameter in the request.
uuidstring

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
401
Error message if no token provided.
Error401
detailstring
Error reason
403
Error message when you don't have the appropriate plan.
Error403
detailstring
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_namestring
array
Updated 08 Nov 2022
UP NEXT
List API Tokens
Docs powered by archbee