E-File Magic

Recipients

Read saved validation issues

Identify fields with saved validation issues for one authorized recipient.

POST
/api/v1/recipients/issues
Authentication
OAuth 2.0 access token
Required scopes
recipients.readforms.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

2 fields
evidenceAlways returnedobject

Unknown fields are rejected.

Nested fields (17)

archivedAlways returnedboolean

Type: boolean.

details_truncatedAlways returnedboolean

Type: boolean.

examples_exhaustiveAlways returnedfalse

Value: false.

field_filterAlways returnedstring | null

Type: string | null.

field_limitAlways returnedinteger

Minimum: 0.

fieldsAlways returnedarray<object>

Maximum items: 8.

Nested fields (3)

fieldAlways returnedstring | null

Type: string | null.

labelAlways returnedstring

Type: string.

sampled_issue_countAlways returnedinteger

Minimum: 0.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

formsAlways returnedarray<object>

Maximum items: 5.

Nested fields (4)

error_countAlways returnedinteger

Minimum: 0.

form_idAlways returnedstring

Allowed values: "1042_s", "1097_btc", "1098", "1098_c", "1098_e", "1098_f", "1098_q", "1098_t", "1098_vli", "1099_a", "1099_b", "1099_c", "1099_cap", "1099_da", "1099_div", "1099_g", "1099_h", "1099_int", "1099_k", "1099_lps", "1099_ls", "1099_ltc", "1099_misc", "1099_nec", "1099_oid", "1099_patr", "1099_q", "1099_qa", "1099_r", "1099_s", "1099_sa", "1099_sb", "3921", "3922", "5498", "5498_esa", "5498_qa", "5498_sa", "5498_ta", "15397", "8027", "8596", "8809", "8955_ssa", "w_2g".

has_errorsAlways returnedboolean

Type: boolean.

tax_yearAlways returnedinteger

Allowed values: 2022, 2023, 2024, 2025, 2026.

inspected_issue_entriesAlways returnedinteger

Minimum: 0.

inspection_limitAlways returnedinteger

Minimum: 0.

is_validatedAlways returnedboolean

Type: boolean.

nameAlways returnedstring

Type: string.

notesAlways returnedstring

Type: string.

recipient_idAlways returnedstring (uuid)

Type: string (uuid).

recipient_validation_issue_countAlways returnedinteger

Minimum: 0.

releasedAlways returnedboolean

Type: boolean.

statusAlways returnedstring

Allowed values: "active", "disabled", "archived".

linksAlways returnedarray<object>

Maximum items: 1.

Nested fields (2)

hrefAlways returnedstring

Type: string.

labelAlways returnedstring

Type: string.

Complete response schema: ApiRecipientIssues

Structure · HTTP 200
{
  "data": {
    "evidence": "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.