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

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

immediate response

immediate response fields

11 fields
execution_modeAlways returned"immediate"

Value: "immediate".

expires_at_epochAlways returnedinteger

Type: integer.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

form_idAlways returnedstring

Type: string.

page_countAlways returnedinteger

Type: integer.

recipient_idAlways returnedstring (uuid)

Type: string (uuid).

schema_revAlways returnedinteger

Type: integer.

statement_countAlways returnedinteger

Type: integer.

tax_yearAlways returnedinteger

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

transaction_countAlways returnedinteger

Type: integer.

urlAlways returnedstring (uri)

Type: string (uri).

scheduled response

scheduled response fields

11 fields
already_scheduledAlways returnedboolean

Type: boolean.

chunk_sizeAlways returnedinteger

Type: integer.

download_urlMay be omittedstring (uri)

Type: string (uri).

execution_modeAlways returned"scheduled"

Value: "scheduled".

export_idAlways returnedstring (uuid)

Type: string (uuid).

filer_idAlways returnedstring (uuid)

Type: string (uuid).

form_idMay be omittedstring

Type: string.

modeAlways returnedstring

Allowed values: "all", "corrected", "uncorrected".

recipient_form_countAlways returnedinteger

Type: integer.

statusAlways returnedstring

Allowed values: "queued", "processing", "merging", "completed", "failed".

tax_yearAlways returnedinteger

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

Complete response schema: ApiV1RecipientPrintResponse

Structure · HTTP 200
{
  "data": "object | object",
  "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.