Order Intent

Creating an order intent merely requires the order type. Remaining order inputs can be incrementally patched. If a required input is absent, the "requires_action" validation will flag this missing information. The status of the order intent will highlight the stage of the process.

Requires Action

Indicates that certain validations need correction before proceeding with confirming the OrderIntent. Refer to the "requires_action" object for detailed validation error information.


When an order intent is canceled, it transitions to a terminal canceled state.

Requires Confirmation

Once all validations have been addressed, the order intent is ready for confirmation. Upon confirmation, an order is created, and you will receive the new investment order's ID.


Once an order intent is confirmed, it transitions to a terminal confirmed state. When querying for order intents confirmed intents are filtered out by default.