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

How to use this endpoint

Provide filer and year, not a recipient selection. The user chooses services, payment and terms in checkout; opening the email does not charge or submit. Requests deduplicate by connection, user, filer, year, workflow and day. Checkout emails expire 24 hours after the original request. action=remind resends after at least five minutes, up to three sends per link, and invalidates older links without extending the original expiration. The response contains delivery metadata only. Reuse the same key after an uncertain result.

Choose workflow=efile for final filing services or workflow=tin_matching for a separate optional Bulk TIN Matching order. Different workflows have independent email identities; requesting matching does not replace a filing link. The human confirms services and follows ordinary order checkout. Read filing readiness first and offer matching only when tin_matching.advice=offer_matching.

The efile service is displayed as Combined Federal/State e-File (CF/SF). E-File Magic participates in the IRS CF/SF program for eligible filings. The API service_code remains efile; this display name does not change pricing or filing eligibility.

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

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.