Skip to main content
POST
Screen a transaction payload for sanctioned addresses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

The sender and statically-encoded envelope destinations are extracted and screened server-side.

chain
enum<string>
required
Available options:
ETH,
EVM,
FLOW,
SOL,
ALGO,
STARK,
COSMOS,
BTC,
ECLIPSE,
SUI,
SPARK,
TRON,
APTOS,
TON,
STELLAR,
ALEO,
TEMPO,
MIDNIGHT
context
object
required

Chain-specific transaction payload; exactly one shape must be provided.

chainId
string

Network identifier, recorded for audit/logging only — screening is per chain family.

Maximum string length: 128
senderAddress
string

The transaction sender; screened alongside the extracted destinations.

Required string length: 1 - 256

Response

Screening verdict

Allow/block screening verdict; undecodable payloads and provider errors fail open to allow.

decision
enum<string>
required
Available options:
allow,
block
blockedAddresses
string[]

The sanctioned addresses that caused a block verdict.

sanctionCheckId
string

Identifier of the persisted sanction check backing a block verdict.

Last modified on August 1, 2026