Add an address exception for a screening vendor
Adds one address allow or deny entry. An ALLOW entry exempts the address from the customer’s own rules only — the sanctions floor evaluates above it, so a sanctioned address stays blocked.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the environment
36^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"95b11417-f18f-457f-8804-68e361f9164f"
Screening vendor the policy belongs to
Screening vendor a policy belongs to. Deliberately not ProviderEnum, which
is a 44-value auth/social/onramp list of which only these two are screening
vendors. The Dynamic sanctions provider is absent because the sanctions floor
is generated from code and is not configurable.
trmWalletScreening, chainalysisAddressScreening Body
Adds one address exception to the (environment, vendor) list. Omit chain to apply it to every chain, and appliesToScope to apply it at every screening moment.
The address to except, in its native casing.
1 - 256Whether the entry exempts the address from the customer's own rules, or
blocks it. Both evaluate below the sanctions floor, so ALLOW can never
unblock a sanctioned address.
ALLOW, DENY ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE, SUI, SPARK, TRON, APTOS, TON, STELLAR, ALEO, TEMPO, MIDNIGHT Which scopes an address entry applies to. Separate from
ScreeningPolicyScopeEnum because ALL is meaningful here and meaningless
on a policy row. ALL is the default and the overwhelmingly common intent —
a blocked actor is normally blocked everywhere — and narrowing is available
for the customer who wants it.
ALL, SIGN_IN, TRANSACTION Human-readable label to identify this entry in the dashboard.
255Response
The created address entry
A customer address exception, belonging to the (environment, vendor) pair
rather than to one policy — a denylist should have one answer to "is this
actor blocked?" whichever screening moment is being resolved. Matched by a
chain-aware fold of the address, not a plain lowercase, because base58 and
base32 chains are case-significant. An absent chain applies the entry to
every chain.
36^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"95b11417-f18f-457f-8804-68e361f9164f"
The address, in the casing it was submitted with.
Which scopes an address entry applies to. Separate from
ScreeningPolicyScopeEnum because ALL is meaningful here and meaningless
on a policy row. ALL is the default and the overwhelmingly common intent —
a blocked actor is normally blocked everywhere — and narrowing is available
for the customer who wants it.
ALL, SIGN_IN, TRANSACTION Whether the entry exempts the address from the customer's own rules, or
blocks it. Both evaluate below the sanctions floor, so ALLOW can never
unblock a sanctioned address.
ALLOW, DENY ETH, EVM, FLOW, SOL, ALGO, STARK, COSMOS, BTC, ECLIPSE, SUI, SPARK, TRON, APTOS, TON, STELLAR, ALEO, TEMPO, MIDNIGHT Human-readable label to identify this entry in the dashboard.
255ISO 8601 timestamp of when the entry was added.