E-File Magic

Orders

Submit an order

Purchase the selected services and submit an order for processing.

POST
/api/v1/orders/submit
Authentication
OAuth 2.0 access token
Required scopes
orders.submit
Idempotency key
Required
Rate-limit cost
100 units

Request fields

9 fields
expected_policy_versionRequiredinteger

Policy version returned by the order preview. Minimum: 1.

expected_total_minorRequiredinteger

Expected order total from preview, in the currency's minor units. Minimum: 0.

filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

funding_aliasRequiredstring

Approved funding alias configured for the connection. Minimum characters: 1. Maximum characters: 64.

order_signature_cryptoRequiredstring

Minimum characters: 1. Maximum characters: 16384.

service_codesRequiredarray<string>

Services to include in the order. Review availability and pricing with preview first. Must include efile and e_delivery. State E-File is not currently available: new state_efile requests return HTTP 400 invalid_request with message 'State E-File is not currently available.'. State Reporting File (irs_spec_file) remains available. Historical response identities are unchanged. Minimum items: 2. Maximum items: 4. Items must be unique.

terms_acceptedRequiredtrue

Records the caller's acceptance of the specified terms. Value: true.

terms_versionRequiredstring

Version of the terms accepted for this order. Minimum characters: 1. Maximum characters: 64.

tax_yearOptionalinteger | null

Tax year of the filer and forms being processed. Allowed values: 2022, 2023, 2024, 2025, 2026.

Headers (3)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
Idempotency-KeyRequired
Opaque caller-generated key bound to resolved tenant, connection, and actor scope.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.

Complete request schema: ApiV1OrderSubmitRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/orders/submit' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Idempotency-Key: <unique-operation-key>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace placeholders with your own values. Use the API resource origin provided for your environment.

Create request.json using the documented fields. Field descriptions are not sample values.

Retrying a request? Keep the same idempotency key and body after an uncertain result. A different key can repeat the action.