Tax Transcript GET by ID

This api gives tax transcript response by request id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This API will be responsible for providing the result for a given request on successful completion of request processing. The possible status is Pending, Processing, Consent Collected, Consent Accepted By IRS, Consent Rejected By IRS, Consent Rejected, Consent Processing, Completed

{
  "success_message": "Retrieved data successfully",
  "data": {
    "id": 1,
    "created_by": "compliancely",
    "status": "Consent Collected",
    "reason": "",
    "created_at": "2023-10-20T06:49:56.271107Z",
    "updated_at": "2023-10-20T06:50:04.301085Z",
    "consent": {
      "request_data": {
        "tax_information": {
          "authorize_irs_record_access_via_provider": true
        },
        "taxpayer_information": {
          "tin": "xxxxxxxxx",
          "email": "",
          "title": "",
          "address": {
            "city": "",
            "state": "",
            "zip_code": "",
            "address_line_1": "",
            "address_line_2": ""
          },
          "last_name": "",
          "first_name": "",
          "payer_type": "",
          "business_name": "",
          "business_type": "",
          "mobile_number": ""
        }
      },
      "consent_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJIUzXXXXXVCJ9.eyJlbnRpdHlfbnVtYmVyIjoiNzXXXXXXXXXXXXXXXXXXXXXXXXvZGUiOiJzMyJ9.8bxMPJvuazT7ikkVmfakTWRjUaN-iFBhiwWtg3RKOoU"
    },
    "transcript": [
      {
        "output_details": [
          {
            "id": 7,
            "form_type": "Tax Return Transcript",
            "form_number": "1120S",
            "tax_period": "202012",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXxxIjoidGF4X3RyYW5zY3JpcHRfcmVwb3J0IiwiZmlsZV9tb2RlIjoiczMifQ.LRQJIynM9mgQnW99UIzgHvceKlVYX-3LOKSaqw_ruXo",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/7/json/"
          },
          {
            "id": 6,
            "form_type": "Account Transcript",
            "form_number": "941",
            "tax_period": "202112",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXGF4X3RyYW5zY3JpcHRfcmVwb3J0IiwiZmlsZV9tb2RlIjoiczMifQ.jiFGlc_qqXIeMhURHhXU6ieWsg7pTNP380ahn3UOtxU",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/6/json/"
          },
          {
            "id": 5,
            "form_type": "Account Transcript",
            "form_number": "941",
            "tax_period": "201912",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXdGF4X3RyYW5zY3JXXXXlsZV9tb2RlIjoiczMifQ.TCZY3jXMBhPWasGY3EEi0oacPywv-fSRXbxoXpdY0Bw",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/5/json/"
          },
          {
            "id": 4,
            "form_type": "Tax Return Transcript",
            "form_number": "1120S",
            "tax_period": "201912",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJIUzIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx3RyYW5zY3JpcHRfcmVwb3J0IiwiZmlsZV9tb2RlIjXXXXXX7PLwd9McEdwSRLSx2Mhjzvfsokr1q96CKKm0",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/4/json/"
          },
          {
            "id": 3,
            "form_type": "Account Transcript",
            "form_number": "CIVIL PENALTY",
            "tax_period": "201912",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJIXXXXXXXXXXXXXXXXXXXXXXXXXXXXXoidGF4X3RyYW5zY3JpcHRfcmVwb3J0IiwiXXXXczMifQ.BR1ZSBrhmuh-GYZvP0hQyrNuvQ2Xif6e11X5v9J8GwE",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/3/json/"
          },
          {
            "id": 2,
            "form_type": "Account Transcript",
            "form_number": "944",
            "tax_period": "201912",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbXXXXXXXXXXXXXXXXXXXXXXXXXXXXbnNjcmlwdF9yZXBXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXOpr1Jo",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/2/json/"
          },
          {
            "id": 1,
            "form_type": "Tax Return Transcript",
            "form_number": "1120S",
            "tax_period": "202112",
            "pdf_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciOiJXXXXXXXI6IkpXVCJ9.eyJlbnRpdHlfbnVtYmVyIjoiMzVfdHJhXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXnL-gf1fS6A3qQt8",
            "json_link": "https://app1.compliancely.com/api/v1/transcript/1/record/1/json/"
          }
        ],
        "output_link": "https://app1.compliancely.com/app/file/download/secure/eyJhbGciXXXXXXX5cCI6IkpXVCJ9.eyJlbnRpdHlfbnVtYmVyIjoiNzJfdHJhbnNjcmlwdF9yZXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXBrlp6cgG4PKYUE9m3XWa352Vs30q26_bqbj2NMWnpZs",
        "status": "Consent Collected",
        "created_at": "2023-10-20T06:49:56.272778Z",
        "updated_at": "2023-10-20T06:49:56.272787Z"
      }
    ]
  },
  "success": true
}
{
    "errors": [
        {
            "error_message": "No details exists with this id"
        }
    ],
    "data": null,
    "success": false
}
{
    "detail": "Invalid token header. No credentials provided."
}
{
    "detail": "Invalid token."
}
{
    "detail": "Authentication credentials were not provided."
}

The response contains two main components: the consent key, which holds consent details, and the transcript key, which contains the transcript information. The transcript includes an output_link pointing to a zip file containing one or more requested transcript PDFs, and the output_details may provide specifics about each transcript type and the corresponding individual PDF links.

It's important to note that any links, whether they are labeled as output_link, consent_link, pdf_link or json_link within the response, are not public and have a Response Content-Type of application/octet-stream for output_link, consent_link, pdf_link and application/json for json_link. As a result, these links should be treated as additional API endpoints, and they require an access_token to access. Users who wish to open these links in a web browser while logged into the Compliancely portal can download the files directly except json_link. One can find the same details and link in the Compliancely portal.

Query Params
number
required

Enter ID

uuid

Enter client account UUID to filter submissions by client account

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json