Filings
Read filing readiness
Read saved readiness counts and a few focused examples for a filer or account year.
/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
How to use this endpoint
Requires filers.read, recipients.read and forms.read. Provide filer_id, or tax_year for an account overview. Account overview additionally requires orders.read and access to all filers.
Reuses the built-in assistant readiness service. Counts describe recipients, not error totals; updating or unavailable counts are unknown. At most five examples are returned. The agent does not run validation or certify filing eligibility.
Per-filer tin_matching observations distinguish unchecked, already matched, pending and adverse results for filing-ready unreleased recipients. Only offer_matching recommends an optional separate purchase. Up to two sparse-index pages and 100 strong metadata rereads keep the operation bounded; partial/unknown coverage never means all matched. Existing indexes and lifecycle flags are reused without a projection backfill.
curl --request POST 'https://api.efilemagic.com/api/v1/filings/readiness' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace 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.
Request fields
2 fieldsfiler_idOptionalstring (uuid) | null
ID of the filer that owns this operation's records.
tax_yearOptionalinteger | null
Tax year of the filer and forms being processed. Allowed values: 2022, 2023, 2024, 2025, 2026.
Headers (1)
AuthorizationRequired- OAuth Bearer token with current resource authorization and the required scopes.
curl --request POST 'https://api.efilemagic.com/api/v1/filings/readiness' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-binary @request.jsonReplace 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.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
2 fieldsevidenceAlways 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.
{
"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.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.