E-File Magic

Checkout invitations

Get checkout email status

Read the delivery and expiration of a checkout email request.

POST
/api/v1/orders/checkout/get
Authentication
OAuth 2.0 access token
Required scopes
orders.read
Idempotency key
Not required
Rate-limit cost
1 unit

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

7 fields
checkout_idAlways returnedstring (uuid)

Type: string (uuid).

deliveryAlways returnedstring

Allowed values: "sending", "sent", "failed", "uncertain".

expires_atAlways returnedinteger

Type: integer.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

retry_afterAlways returnedinteger

Minimum: 0.

tax_yearAlways returnedinteger

Allowed values: 2022, 2023, 2024, 2025, 2026.

workflowAlways returnedstring

Allowed values: "efile", "tin_matching".

Complete response schema: McpCheckoutReceipt

Structure · HTTP 200
{
  "data": {
    "checkout_id": "string (uuid)",
    "delivery": "string",
    "expires_at": "integer",
    "filer_id": "string (uuid)",
    "retry_after": "integer",
    "tax_year": "integer",
    "workflow": "string"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.