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 

Retrieve Batch Screening Results

2min
GET

This endpoint will return your BatchQuery results. The BatchQuery will have a BatchResult for each of the searches in the batch, including all parsing errors in your payload or file. If the BatchQuery is still being processed you will be getting the second response type in the description bellow.

AUTHENTICATION
Authorization
string
Bearer
RESPONSES
200
OK
object
id
string
string representation of the object's unique identifier
timestamp
string
url to fetch the next page of results if any
result_count
integer
Number of batch results with actual matches.
batch_results
BatchResultListResponse[]
parsing_errors
BatchQueryParsingErrorEntity[]
file_urls
object
An object that collects all the possible download urls together for the customer convenience.
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




PREVIOUS
List Batch Screening Requests
NEXT
Delete Batch Screening Results
Docs powered by archbee