Compliance

Rescreen a rejected transaction

Re-runs compliance screening on an incoming transaction that was rejected or failed by screening checks, moving it back to pending screening. This endpoint is only applicable to incoming transactions with a rejected/failed AML screening status.

post/screening/transaction/{txId}/rescreen

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/screening/transaction/:txId/rescreen/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

txIdstring required

The transaction id that was rejected by screening checks

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

resetTravelRuleMessageboolean

When true, clears the existing travel rule message on the transaction before rescreening.

Response

Rescreen result

successboolean required

Whether the rescreen was triggered successfully

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.