E-File Magic

Deliverables

Get a deliverable

Read the available files and instructions for one order's deliverable.

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

Request fields

2 fields
order_idRequiredstring (uuid)

ID of the order to read or download from.

service_codeOptionalstring | null

Service whose deliverable you want to read or request. Allowed values: "efile", "e_delivery", "state_efile", "print_mail", "irs_spec_file".

Headers (2)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.

Complete request schema: ApiV1OrderDeliverableGetRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/orders/deliverables/get' \
  --header 'Authorization: Bearer <access-token>' \
  --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.