E-File Magic

Checkout invitations

Email a checkout invitation

Invite the verified user who authorized the connection to review and submit a filer’s order.

POST
/api/v1/orders/checkout/request
Authentication
OAuth 2.0 access token
Required scopes
orders.previewfilers.read
Idempotency key
Required
Rate-limit cost
5 units

Request fields

4 fields
filer_idRequiredstring (uuid)

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

tax_yearRequiredinteger

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

actionOptionalstring

Request the initial checkout email or explicitly remind the authorizing user. Allowed values: "request", "remind". Default: "request".

workflowOptionalstring

Separate human checkout intent. Filing checkout never offers TIN Matching as an add-on. Use tin_matching for a distinct optional order before filing. Allowed values: "efile", "tin_matching". Default: "efile".

Headers (2)
AuthorizationRequired
OAuth Bearer token with the listed scopes and current resource authorization.
Idempotency-KeyRequired
Reuse the same key and request after an uncertain response.

Complete request schema: RequestMcpCheckout

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/orders/checkout/request' \
  --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.