Skip to main content
POST
MCP scope: dac.read Use this endpoint to see which spending rule a withdrawal from your sub-account would match, and what would happen: allowed, needs approval, or blocked. Nothing is created, reserved or sent. Use it before you send a withdrawal, or when you’re setting up rules. It evaluates the sub-account your API key belongs to, in the same way as a real withdrawal:
  • Rules are checked lowest cap first, and on equal caps the rule needing more approvals comes first.
  • The first matching rule wins. If no rule matches, the withdrawal is blocked.
  • Rolling (Hourly) caps include the sub-account’s recent withdrawals.

Body Parameters

string
required
The asset, for example USDT_TRC20.
number
required
The amount in the asset, 0 or more. Finrock converts it to USD at the current price, the same way it does for spending rule caps.
string
required
Where the funds would go. One of EXTERNAL, SUBACCOUNT, EXCHANGE, STAKE, SWAP or RAMP.
string
Required for EXTERNAL, SUBACCOUNT and EXCHANGE: the address, the sub-account ID, or the exchange name. Not used for STAKE, SWAP or RAMP.
string
A destination tag or memo. It only matters when a whitelist entry is limited to a tag.
string
By default, the withdrawal is evaluated as sent by an API key. Pass Admin to see how a withdrawal from a dashboard user would be treated.

Response

A request that passes validation always returns HTTP 200, even when the withdrawal would be blocked. Check allowed.
boolean
false if no rule allows the withdrawal, or if the matching rule can’t currently be used.
string | null
Allow (goes straight through) or NeedsApproval. null when no rule matched.
object | null
The matching rule, as rule_guid and rule_title. It can be set even when allowed is false, if the rule matched but can’t be used.
integer
How many of the named approvers must approve. 0 for Allow.
object[]
The named approvers who could approve this withdrawal. Each has user_id, first_name and last_name.
string | null
Why the withdrawal would be blocked. null when allowed is true.

What the simulation doesn’t check

The simulation checks spending rules only. It doesn’t check your balance, fees, the address format or the withdrawal plan, so a withdrawal it says is allowed can still fail when you send it. Results can also change before the real send, because rules, prices, signers or recent withdrawals may change.
  • On MPC wallets, the named people give their approval by signing the transaction. There’s no separate approval step.
  • Transfers within the same sub-account are never subject to spending rules.
  • HSM wallets have no spending rules.

Errors

These return HTTP 400 with the standard error object. Authentication and scope errors are the same as for other endpoints. See HTTP Status Codes.