Skip to main content
POST
Preflight

Authorizations

X-API-Key
string
header
required

Service-account API key (tfk_test_/tfk_live_).

Body

application/json
quoteResponse
Selected candidate · object
required

The candidate to preflight, passed back exactly as it appeared in the quotes response. The plan is computed against this candidate's terms and the user's current on-chain state.

Response

Successful Response

quoteId
string
required

Candidate the plan applies to.

ready
boolean
required

True when nothing stands between you and submission - the remaining nextActions are just the signature and the POST.

nextActions
PreflightNextAction · object[]
required

Ordered execution plan; empty when the candidate is immediately submittable.

fundingLock
enum<string> | null

Lock mechanism preflight selected for pulling the input - your code stays the same whichever it picks.

Available options:
Permit2,
EIP-3009,
ResourceLock
lockDetails
Permit2Lock · object

Permit2 funding lock: one reusable approval of the Permit2 contract, after which each order authorizes its own pull inside the signature.