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

Request fields

1 fields
checkout_idRequiredstring (uuid)

Checkout request identifier returned by orders/checkout/request.

Headers (1)
AuthorizationRequired
OAuth Bearer token with the listed scopes and current resource authorization.

Complete request schema: McpCheckoutReference

Request example

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/orders/checkout/get' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{"checkout_id":"11111111-1111-4111-8111-111111111111"}'

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