Skip to main content
POST
/
customers
/
api
/
identity
/
can-transfer
curl -X POST "https://api.trusset.org/customers/api/identity/can-transfer" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: trusset_abc123xy_secret..." \
  -d '{
    "from": "0xAbC123dEf456789012345678901234567890AbCd",
    "to": "0x1234567890abcdef1234567890abcdef12345678",
    "amount": "1000.0",
    "fromBalance": "5000.0",
    "toBalance": "200.0"
  }'
{
  "success": true,
  "data": {
    "allowed": true,
    "from": "0xAbC123dEf456789012345678901234567890AbCd",
    "to": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-06-15T12:00:00.000Z"
  }
}
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

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

Response Fields

success
boolean
Request status
data
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.
curl -X POST "https://api.trusset.org/customers/api/identity/can-transfer" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: trusset_abc123xy_secret..." \
  -d '{
    "from": "0xAbC123dEf456789012345678901234567890AbCd",
    "to": "0x1234567890abcdef1234567890abcdef12345678",
    "amount": "1000.0",
    "fromBalance": "5000.0",
    "toBalance": "200.0"
  }'
{
  "success": true,
  "data": {
    "allowed": true,
    "from": "0xAbC123dEf456789012345678901234567890AbCd",
    "to": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-06-15T12:00:00.000Z"
  }
}