Transaction Screening Operations

These operations apply to one transaction, any time after screening starts. To change what happens to future transactions, update your policy instead; see Compliance Policies.

Transaction states

State	API	What you can do
Screening	`status` is `PENDING_AML_SCREENING`	Wait, or rescreen if it takes longer than expected.
Accepted (Accept or Alert)	`status` moves past `PENDING_AML_SCREENING`; the screening result’s `status` is `Completed`	Nothing required. Read the result for details.
Rejected (outgoing)	`status` is `REJECTED`, with a screening `subStatus` such as `REJECTED_AML_SCREENING`	Bypass it if the block was a false positive.
Frozen (incoming)	`subStatus` is `AUTO_FREEZE` or `FROZEN_MANUALLY`	Unfreeze it once you have reviewed the case.

A Reject or Freeze outcome on an outgoing transaction rejects it; nothing is frozen, because no funds moved. A transaction can stay in PENDING_AML_SCREENING because of network confirmation delays between Fireblocks and your provider; this usually resolves on its own. See Sub-statuses for every subStatus value. For several destinations, the most restrictive result decides; see Compliance Policies.

What you can do through the API

Task	Applies to	Permission	Console	API
Read the result	Any screened transaction	All roles	Transaction History > Transaction Details	`GET /screening/transaction/{txId}`
Bypass	Outgoing transactions only, after screening has rejected or failed them.	Owner, Admin	Transaction History > Transaction Details	`POST /screening/transaction/{txId}/bypass_screening_policy`
Rescreen	Incoming transactions only, after screening rejected or failed them; returns the transaction to PENDING_AML_SCREENING. Optionally clears the linked Travel Rule message. Not available for frozen transactions.	All roles	Transaction History > Transaction Details	`POST /screening/transaction/{txId}/rescreen`
Freeze	Incoming transactions	Admin, Non-Signing Admin	No	`POST /transactions/{txId}/freeze`
Unfreeze	Frozen transactions	Owner, Admin, Non-Signing Admin	Transaction History > Transaction Details	`POST /transactions/{txId}/unfreeze`

Bypass creates a new transaction, with the API user as initiator, that skips screening. The original stays rejected.
Rescreen returns the transaction to pending screening. Set resetTravelRuleMessage to true to discard the existing Travel Rule message.
Freeze makes the funds unspendable: the full amount for account-based assets, all the transaction’s UTXOs for UTXO-based assets.

The four actions accept an optional Idempotency-Key header, valid for 24 hours. Permissions are workspace defaults: bypass and unfreeze can be blocked workspace-wide, after which they require a Fireblocks Support ticket. See Workspace-wide limits.

Read the result

const { data } = await fireblocks.compliance.getScreeningFullDetails({ txId });
console.log(data.status, data.aml?.verdict, data.aml?.risk);

Field	Description
`aml`	The final AML/KYT result.
`tr`	The Travel Rule result.
`amlList`	Every AML/KYT result recorded, including those before a rescreen.
`status`	Screening progress across checks, for example `AMLStarted`, `AMLCompleted`, `TRStarted`, `TRCompleted`, `Completed`.

Each result in aml, tr, and amlList includes:

Field	Description
`provider`	The provider that ran the check.
`verdict`	The provider’s verdict, for example `PASS`.
`risk`	Provider-specific risk level, for example `lowRisk`.
`screeningStatus`	Status of this check, for example `COMPLETED`. A check can finish while the transaction is still in later checks.
`bypassReason`	Why screening was skipped, for example `PASSED_BY_POLICY` or `UNSUPPORTED_ASSET`.
`customerRefId`	The Customer Reference ID the result is attributed to.
`payload`	The provider’s raw response; structure differs by provider.

To be notified instead of polling, see Compliance Events & Webhooks.

Limitations

GET /screening/transaction/{txId} does not include Address Registry Screening results.

On the Help Center

To read a result or act on a transaction in the Console, see Transaction Screening Operations.

Get Started

Transactions

API Co-Signers

Webhooks

Workspace & Security

Identity & Compliance

Manage Wallets

Smart Contracts & Tokenization

Treasury & Trading

Gas Management

Payments

Embedded Wallets

Offchain Signing

Direct Custody Wallets

Integrations

Assets & NFTs

Canton

Key Link

Transaction states

What you can do through the API

Read the result

Limitations

On the Help Center

​Transaction states

​What you can do through the API

​Read the result

​Limitations

​On the Help Center

Transaction states

What you can do through the API

Read the result

Limitations

On the Help Center