E-File Magic

Imports

Inspect an import

Inspect the uploaded file and return its detected format and preview.

POST
/api/v1/imports/submissions/inspect
Authentication
OAuth 2.0 access token
Required scopes
imports.readtax_ids.read
Idempotency key
Not required
Rate-limit cost
2 units

How to use this endpoint

Upload the source file before inspection. This public endpoint is read-only; configure spreadsheet mapping before starting. Inspection alone does not create recipients.

A detected pub1220 file uses a separate multi-filer workflow in the signed-in application. Its preview describes original returns, excludes G/C corrections, and reports whether counts are partial. Use Imports → Spreadsheets & 1220 to acquire that file; the filer-bound public API cannot launch it. Malformed framing or control totals can block inspection. Security format_error contains only a redacted record/byte diagnostic.

The signed-in Imports and Import Services screens share one combined standard template for 2022–2026. Its required Filer Information Filing Year drives standard-template acquisition, and missing or year-inapplicable columns and deleted optional form tabs are tolerated. This download change adds no endpoint or request field; the External Filing API retains its documented filer-bound mapping workflow and annual validation.

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