Generates and downloads a CSV report of screening audit events within the specified time range.

The start of the time range to include in the report, inclusive.

from

The end of the time range to include in the report, inclusive.

The audit action type to filter the report by.

action

Unique correlation ID for distributed tracing. If not provided, the server generates one.

X-Correlation-Id

API version. Required for all Avalara public APIs.

avalara-version

Optional client identifier for telemetry and support: "AppName; AppVersion; Adapter; MachineName".

X-Avalara-Client

Returns a CSV file containing the screening audit events for the specified time range.

Returns an error if the date range or action filter is invalid.

Returns an error if the request lacks a valid authentication token.

Forbidden. The caller is authenticated but lacks the required role.

Too many requests. Retry after the delay in the Retry-After header.

Returns an error if the server encounters an unexpected condition that prevents it from completing the request.

Re-screens previously cleared parties against updated watchlist data within a configurable lookback window. The operation runs asynchronously; poll the URL in the Operation-Location response header for status and results.

Returns aggregate statistics across all ingested sanctions data.

Returns all configured sanctions source lists with summary information.

Returns the sanctions programs associated with a specific source list.

The code of the source list to retrieve programs for.

code

Returns the sanctions programs associated with the specified source list.

Returns a paginated history of watchlist data ingestion runs.

The source list code to filter results by.

sourceListCode

Number of items to skip (offset). Example: `$skip=20` skips the first 20 records.

$skip

Maximum number of items to return. Default: 10.

$top

Sorting criteria: `property direction`, comma-separated. Example: `requestedAt desc, id asc`.

$orderby

Searches sanctioned entities with optional filters for source list, entity type, status, and program.

The free-text search query to match against sanctioned entity data.

entityType

status

programCode

Returns a paginated list of sanctioned entities matching the specified search and filters.

Returns full details of a single sanctioned entity including aliases, addresses, and identifiers.

The unique identifier of the sanctioned entity.

Returns the full details of the requested sanctioned entity, including aliases, addresses, and identifiers.

Returns an error if the specified entity is not found.

Starts event-driven screening triggered by an upstream business system. The operation runs asynchronously; poll the URL in the Operation-Location response header for status and results.

Returns the screening run identifier and status for the accepted event.

Returns an error if the request fails validation.

Queues a batch of parties for asynchronous screening. Returns immediately with `202 Accepted`, a run ID, and an `Operation-Location` header pointing at the run. Per-party results for both successfully and unsuccessfully screened parties are not returned inline; poll `GET /v1/screening/runs/{runId}/results` (via the `Operation-Location` header) to retrieve them. Results are returned in the same order as the submitted `parties` array, so callers can correlate each result with its request item by index/position in the collection; each result also carries the echoed `inputParty.externalPartyId` as an alternative correlation key.

Returns the screening run identifier, status, and party count for the accepted batch.

Screens one or more parties against all active watchlists and returns results synchronously. The `results` array reports the outcome for every party that was screened and is returned in the same order as the input `parties` array; callers can correlate each result with its request item by position or by the echoed `inputParty.externalPartyId`. Each entry's `decision` reflects that party's individual screening outcome. The request is validated as a whole: if any party is invalid the entire request is rejected with `400` and no partial results are returned.

Returns the overall decision and per-party screening results.

Returns an error if any party in the request fails validation.

Screens parties using AI-powered matching for improved accuracy on ambiguous names. The `results` array reports the outcome for every party that was screened and is returned in the same order as the input `parties` array; callers can correlate each result with its request item by position or by the echoed `inputParty.externalPartyId`. Each entry's `decision` reflects that party's individual screening outcome. The request is validated as a whole: if any party is invalid the entire request is rejected with `400` and no partial results are returned.

Returns the overall decision and per-party AI-enhanced screening results.

Returns a paginated list of screening runs, filterable by status, decision, review status, and trigger type. Use excludeTrigger to omit a specific trigger type (e.g. excludeTrigger=API_BATCH to hide batch runs).

The screening status to filter results by.

The overall decision to filter results by.

decision

reviewStatus

trigger

The trigger type to exclude from the results.

excludeTrigger

The external reference identifier to filter results by, for example the originating intake request identifier.

externalReferenceId

Returns a paginated list of screening runs matching the specified filters.

List screening runs with optional filters.

Returns the full details of a single screening run.

The unique identifier of the screening run.

runId

Returns the full details of the requested screening run.

Returns an error if the specified run is not found.

Returns paginated screening results with match details for each party in the run. Results are returned in the same order as the originally submitted `parties` array, so callers can correlate each result with its request item by index/position; each result also carries `inputParty.externalPartyId` as an alternative correlation key. Every party - successful or unsuccessful - is reported: each result's `status` is `SCREENED` for a successfully screened party or `FAILED` otherwise, and `errorMessage` carries the failure detail when `status` is `FAILED` (null for successful parties).

Returns a paginated list of screening results with match details for each party in the run.

Returns recent runs ordered by request time, including per-party decision summaries.

Returns a paginated list of recent screening runs, including per-party decision summaries.

List recent screening runs with party results.

Returns paginated batch screening runs (trigger = API_BATCH) ordered by request time, each including per-party decision summaries. Supports optional status, decision, and review-status filters.

Returns a paginated list of batch screening runs, including per-party decision summaries.

List batch screening runs with per-party results.

Returns the current screening configuration for the tenant, or defaults if not yet configured.

Returns the tenant's current screening configuration, or default values if none has been configured.

Creates or updates the screening configuration for the tenant.

The unique identifier of the user performing the update.

x-authenticated-user-id

Returns the updated screening configuration.

Returns an error if the request contains invalid configuration values.

Applies a manual override decision to an individual screening result.

The unique identifier of the screening result.

resultId

Returns the screening result with the applied override decision.

Returns an error if the specified run or result is not found.

Confirms the automatic decision for an individual screening result as reviewed.

Escalates a screening run to a designated reviewer for further analysis.

Returns the updated case status after escalation.

Records a final decision on an escalated screening case.

Returns the updated case status after the decision is applied.

Overrides the overall screening run decision with a manual determination.

Returns the screening run with the applied override decision.

Accepts the screening run results as reviewed and approved.

Returns the screening run with the updated review status reflecting acceptance.

Triggers a manual fetch and ingestion of all configured remote watchlists.

Returns the fetch and ingestion outcome for each configured watchlist.

Triggers a manual fetch and ingestion of a specific watchlist by its list code.

listCode

Returns the fetch and ingestion outcome for the specified watchlist.

Uploads and synchronously processes a watchlist file for the specified source list.

Returns the ingestion run identifier and processing status for the uploaded file.

Returns an error if the specified list code is unknown or disabled.

Returns an error if the server fails to read or process the uploaded file.

tradeHubVDPS

The business event details and parties to screen.

The final decision to record on the escalated case, along with the reason.

The details of the escalation, including the reviewer to escalate to and the reason.

Elapsed fetch/ingest time as an ISO 8601 duration.

The manual override decision to apply to the screening result.

Bad Request

The source list and lookback settings used to determine which previously cleared parties to re-screen.

The manual override decision to apply to the screening run.

Effective decision after any manual review (falls back to the auto decision).

Failure detail when status is FAILED; null for successfully screened parties.

Manual override decision, when this result was overridden.

Optional evidence reference captured at review time.

Standardized reason code captured at review time.

The tenant's screening configuration to create or update.

JWT token obtained from Avalara Identity service

Avalara XB Team

Denied-party screening engine providing ad-hoc, batch, and event-driven screening against global sanctions and watchlists.

Proprietary

TradeHub Vendor Denied Party Screening API

Number of seconds to wait before retrying

URL to poll for the status and result of the long-running operation.