E-File Magic

Saved filing reviews

Prepare a saved filing review

Prepare a fixed selection for the authorizing user to review.

POST
/api/v1/filing-reviews/prepare
Authentication
OAuth 2.0 access token
Required scopes
orders.previewrecipients.readforms.readfilers.read
Idempotency key
Required
Rate-limit cost
15 units

Request fields

5 fields
filer_idRequiredstring (uuid)

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

filer_versionRequiredinteger

Current filer version used to check that the reviewed filer has not changed. Minimum: 1.

recipientsRequiredarray<object>

Recipients and current versions included in the saved filing review. Distinct original recipients and their current versions. Minimum items: 1. Maximum items: 10.

Nested fields (2)

recipient_idRequiredstring (uuid)

Type: string (uuid).

versionRequiredinteger

Minimum: 1.

servicesRequiredobject

Unknown fields are rejected.

Nested fields (3)

irs_spec_fileRequiredboolean

Type: boolean.

print_mailRequiredboolean

Type: boolean.

state_efileRequiredfalse

Direct State E-File is unavailable. Value: false.

tupleRequiredobject

Unknown fields are rejected.

Nested fields (4)

form_idRequiredstring

Exact form identifier from the annual catalog.

schema_releaseRequiredstring

Exact release returned for this form/year/revision.

schema_revRequired3

Value: 3.

tax_yearRequiredinteger

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

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