Skip to main content
POST
Checks the on-chain compliance module to determine whether a transfer between two addresses would be allowed. The check evaluates both sender and receiver identity status, investor type restrictions, country rules, and balance limits configured in the instance’s compliance contracts. Use this as a pre-flight check before submitting transfer transactions to avoid on-chain reverts.

Request Body

string
required
Sender wallet address.
string
required
Receiver wallet address.
string
default:"0"
Transfer amount as a human-readable string (e.g., "1000.5").
string
default:"0"
Current balance of the sender. Used for balance-based compliance rules.
string
default:"0"
Current balance of the receiver. Used for balance-based compliance rules.

Response Fields

boolean
Request status
object
Compliance check result. Structure depends on the compliance module configuration. Typically includes an allowed boolean and, when the transfer is blocked, a reason or violations array describing which rules failed.