E-File Magic

Filings

Read filing readiness

Read saved readiness counts and a few focused examples for a filer or account year.

POST
/api/v1/filings/readiness
Authentication
OAuth 2.0 access token
Required scopes
filers.readrecipients.readforms.read
Idempotency key
Not required
Rate-limit cost
10 units

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

Response fields

2 fields
evidenceAlways returnedobject | object

Must match exactly one of the alternatives in the OpenAPI schema.

linksAlways returnedarray<object>

Maximum items: 6.

Nested fields (2)

hrefAlways returnedstring

Type: string.

labelAlways returnedstring

Type: string.

Complete response schema: ApiFilingReadiness

Structure · HTTP 200
{
  "data": {
    "evidence": "object | object",
    "links": "array<object>"
  },
  "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.