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

How to use this endpoint

Provide the recipient's filer_id and recipient_id. Full Tax ID detail requires the additional Tax ID read permission.

Request example

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/recipients/get' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{"filer_id":"11111111-1111-4111-8111-111111111111","recipient_id":"11111111-1111-4111-8111-111111111111"}'

Replace placeholders with your own values. Use the API resource origin provided for your environment.