E-File Magic

PDFs

Preview recipient PDFs

Generate recipient forms using the selected annual template.

POST
/api/v1/recipients/print
Authentication
OAuth 2.0 access token
Required scopes
recipients.readforms.readdocuments.readtax_ids.read
Idempotency key
Required
Rate-limit cost
25 units

Request fields

5 fields
filer_idRequiredstring (uuid)

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

form_idRequiredstring

Form identifier from the catalog for this tax year and schema revision.

recipient_idRequiredstring (uuid)

ID of the recipient within the selected filer.

schema_revRequiredinteger

Exact application schema revision selected from the form catalog. Minimum: 1.

tax_yearRequiredinteger

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

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: CreateRecipientPrintRequest

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