MAmagnetictax
Submissions

Poll a submission (status + output documents)

Rate-limited per API key. Prefer webhooks (submission_updated_webhook_url) over polling; a 429 with Retry-After means back off.

get/v1/submissions/{submission_id}

Request

  • Base URL
    https://api.magnetictax.com
  • URL
    https://api.magnetictax.com/v1/submissions/{submission_id}
  • Auth
    HTTP bearer

Response

OK

cancellation_code'encrypted_file' | 'unsupported_file' | 'empty_file' | 'outdated_tax_software_file' | 'tax_software_input_mismatch' | 'multiple_tax_software_files' | 'unextractable_zip' | 'mismatched_client' | 'proconnect_link_failed' | 'axcess_client_missing_ssn' | 'unsupported_return_type' | 'cancelled_by_firm' | 'client_deleted' | 'other' nullable

Stable, machine-readable cancellation reason (present only when status is 'cancelled').

cancellation_reasonstring nullable

Human-readable reason (present only when status is 'cancelled').

client_idinteger
created_atstring date-time
expected_completion_atstring date-time nullable
idinteger
is_resubmissionboolean

True when this submission inherited from a prior completed one for the same client + tax year.

is_sandboxboolean

Present and true ONLY for submissions created in a sandbox organization (never worked by a preparer, no firm emails, no internal notifications). Omitted entirely for normal submissions.

resubmission_ofinteger nullable

Id of the prior submission this one resubmits, or null.

status'received' | 'processing' | 'completed' | 'cancelled'
tax_softwarestring nullable
tax_yearinteger

Example response

{
  "client_id": 42,
  "id": 88,
  "input_documents": [
    {
      "id": 7
    }
  ],
  "output_documents": [
    {
      "id": 7
    }
  ],
  "resubmission_of": 788
}

Changes

No recorded changes to this operation across all 1 revision of this API.