Request Path

Submit all transcript requests to the following path.

You will obtain the API endpoint after you register on your account page.

Headers

Query String Parameters

Query string parameters are not supported on this method.

/Transcript Request application/json

Request the transcript(s) needed by the organization.

Request Body

Below are the attributes for the Transcript method.

Attributes

• companyId* The company Id of the company this call is on behalf of. If the call is not on behalf of another company, then the registered company Id TaxStatus assigned during the registration process (used in the euid field in the header.
• tin* 9-digit tax id (no spaces or hypens) of the individual or company
• needPDF If provided, a boolean as to whether the transcripts needs to be PDF instead of the standard HTML. We recommend HTMl if you don't absolutely need PDF as this will make the response payload much larger.
• transcripts An array indicationg which transcripts need to be ordered. Note: We recommend 3 or less transcripts per call to manage size of payload and speed of call.
  • transciptType* One of the transcript types: ACTR (Account Transcript), WAID (Income), RECA (Record of Account), RETR (Tax Return Transcript)
  • transcriptForm* The form type to be ordered (1040, 940, 941, 1120, 1065, INCOME, etc.)
  • transcriptPeriod* The tax year and month concatinated together i.e. - 201812

Example: Transcript calls

Sample business call

Response Body application/json

The following is a list of all possible fields. NULL fields are not returned.

Attributes

• Data An array of objects containing transcript data
  • Period The period from the request
  • Form The form from the request
  • FormType The form type from the request
  • TIN The SSN or EIN from request, which ever is appropriate
  • LastOrBusiness The last name of individual or business name from the request
  • TranscriptDate The IRS system date of the transcript
  • EmptyMessage If populated, will be a message from the IRS system such as 'Transcipt Not Available'. Many times you may see 'Requested data not found' Or 'No record of return filed'. The former ususally means that type of return wasn't filed, and the IRS IS NOT expecting that type of return. The latter means the IRS IS expecting that type of return, but one hasn't been filed.
  • Transcript If available, the base-64 string of the transcript file. To be converted back into the original file

Example response body for the Transcript method. Actual base-64 string not shown for brevity.

For our test environment, here are the trancript examples we have:
Taxpayer ID: 222222222
html format -
TranscriptPeriod: 201612, TranscriptForm: 1040, TranscriptType: ACTR
TranscriptPeriod: 201812, TranscriptForm: 1040, TranscriptType: RECA
TranscriptPeriod: 202012, TranscriptForm: 1040, TranscriptType: RETR
TranscriptPeriod: 201912, TranscriptForm: 1040, TranscriptType: RETR
TranscriptPeriod: 201712, TranscriptForm: INCOME, TranscriptType: WAID
pdf format -
TranscriptPeriod: 201612, TranscriptForm: 1040, TranscriptType: ACTR
TranscriptPeriod: 201812, TranscriptForm: 1040, TranscriptType: RECA
TranscriptPeriod: 201712, TranscriptForm: INCOME, TranscriptType: WAID

Taxpayer ID: 333333333
html format -
TranscriptPeriod: 201912, TranscriptForm: 1040, TranscriptType: ACTR
TranscriptPeriod: 201912, TranscriptForm: 1040, TranscriptType: RECA
TranscriptPeriod: 201912, TranscriptForm: INCOME, TranscriptType: WAID

Taxpayer ID: 555555555
html format -
TranscriptPeriod: 201812, TranscriptForm: 940, TranscriptType: ACTR
TranscriptPeriod: 202112, TranscriptForm: 1120, TranscriptType: ACTR
TranscriptPeriod: 202112, TranscriptForm: 940, TranscriptType: ACTR
TranscriptPeriod: 202109, TranscriptForm: 941, TranscriptType: ACTR
TranscriptPeriod: 202106, TranscriptForm: 941, TranscriptType: ACTR
TranscriptPeriod: 201712, TranscriptForm: 1120, TranscriptType: RETR
pdf format -
TranscriptPeriod: 201812, TranscriptForm: 940, TranscriptType: ACTR
TranscriptPeriod: 201812, TranscriptForm: 1120, TranscriptType: RECA

The possible reponse codes are below.

Response Codes