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

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

Response fields

11 fields
content_typeAlways returnedstring

Type: string.

detected_import_kindAlways returnedstring

Determined from uploaded file contents. Native Publication 1220 uses pub1220. Allowed values: "unknown", "standard_template", "inline_filer_template", "pub1220", "advanced_mapping".

file_nameAlways returnedstring

Type: string.

filer_idMay be omittedstring | null (uuid)

Type: string | null (uuid).

has_moreAlways returnedboolean

Type: boolean.

providerAlways returnedstring

Allowed values: "spreadsheet", "custom_spreadsheet", "generic_spreadsheet", "quickbooks_online", "xero", "bill", "zoho_books", "freshbooks", "business_central".

submission_idAlways returnedstring (uuid)

Type: string (uuid).

target_scopeAlways returnedstring

Allowed values: "single_filer", "multi_filer".

total_rowsAlways returnedinteger

Minimum: 0.

total_rows_exactAlways returnedboolean

Type: boolean.

versionAlways returnedinteger

Minimum: 1.

Complete response schema: ApiV1ImportInspectResponse

Structure · HTTP 200
{
  "data": {
    "content_type": "string",
    "detected_import_kind": "string",
    "file_name": "string",
    "filer_id": "string | null (uuid)",
    "has_more": "boolean",
    "provider": "string",
    "submission_id": "string (uuid)",
    "target_scope": "string",
    "total_rows": "integer",
    "total_rows_exact": "boolean",
    "version": "integer"
  },
  "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.