E-File Magic

Recipients

Get a recipient

Read one recipient and its form information. When present, filing_outcome describes the latest projected IRS acceptance and required review. Missing outcome data does not mean accepted. When iris_repair_submission is present, the current recipient is locked pending the authorized repair result; this does not change the historical IRS acceptance in filing_outcome. Accepted corrections and explicit repair of rejected filings use the recipient workflow in the authenticated application; ordinary upsert does not submit an IRS correction or retry.

POST
/api/v1/recipients/get
Authentication
OAuth 2.0 access token
Required scopes
recipients.read
Idempotency key
Not required
Rate-limit cost
1 unit

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.

400invalid_request
Check required fields, selectors and supported values.
401invalid_token
Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
403insufficient_scope
Request the listed scopes through the application's authorization flow.
403forbidden
Check the connection's permissions and allowed filers. More scopes alone may not grant access.
404not_found
Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
422validation_failed
Correct the reported validation issues before retrying.
429rate_limited
Wait for Retry-After before retrying. Avoid concurrent retries.
500internal_error
Retain request_id; retry with bounded backoff.
503service_unavailable
Retry with bounded backoff.