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

Request fields

2 fields
submission_idRequiredstring (uuid)

Import submission ID returned when the import was created.

preview_rowsOptionalinteger | null

Number of source rows to include in the inspection preview. Minimum: 1. Maximum: 100.

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

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.