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

Request fields

5 fields
filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

recipient_idRequiredstring (uuid)

ID of the recipient within the selected filer.

fieldOptionalstring | null

Exact APP field ID from the saved annual form contract. Minimum characters: 1. Maximum characters: 100.

form_idOptionalstring | null

Form identifier from the catalog for this tax year and schema revision. 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".

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.

Complete request schema: RecipientIssuesRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/recipients/issues' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace 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.