FDX REST API

/tax-forms/{taxFormId} GET

AttributeValue
SummaryRetrieve tax form
DescriptionGet the form image or TaxDataList as json for a single tax document for the customer. Use [HTTP Accept request-header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) to specify desired content types. See ContentTypes definition for typical values
Operation IdgetTaxForm

Request Parameters

Parameter Required? Location Type Description
taxFormId required path Identifier The unique ID for this tax form
accountId optional query string Account Identifier for use in searching or authorization. Optional
offset optional query string Opaque cursor used by the provider to send the next set of records
limit optional query integer Number of elements that the consumer wishes to receive. Providers should implement reasonable default and maximum values

Response

Response Code Response Type Description
200application/pdf or
image/gif or
image/jpeg or
image/tiff or
image/png or
application/json of TaxDataList
The document image or TaxDataList as json for a single tax document for the customer. A single document can include multiple IRS tax forms and/or other reporting statements as delivered by providers
206application/json of TaxDataListPartial Content success retrieving a customer tax document, some errors are being returned
406application/json of ErrorDocument not available for 'Accept' header's content-type

Example Request

GET /fdx/v4/tax-forms/305130001 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJjbGkiOiJ0YXhjbGkiLCJ1c2VyIjoiODEyMzQ1Njc4NSIsInBhc3MiOiIzMDUxMzAwMDEiLCJpYXQiOjE2MTI5MTI4NTksImV4cCI6MTYxMjkxNjQ1OX0.yreKZ3XYK-tg0gRMlWGkMdCNr8aywp5yzDKSpxfGTMo
User-Agent: Jersey/2.29 (HttpUrlConnection 1.8.0_252)
Host: api.taxdocserver.com
Connection: keep-alive

Example Response

HTTP/1.1 200 OK
Content-Type: application/json
X-Cloud-Trace-Context: 484c9b968a4fe6f55679f9585b67e5a1;o=1
Date: Tue, 09 Feb 2021 23:21:03 GMT
Server: Google Frontend
Content-Length: 984
Connection: keep-alive

[ {
  "tax1099G" : {
    "taxYear" : 2020,
    "taxFormId" : "305130001",
    "payerNameAddress" : {
      "line1" : "12020 Sunrise Valley Dr",
      "city" : "Reston",
      "state" : "VA",
      "postalCode" : "20191",
      "name1" : "Financial Data Exchange"
    },
    "payerTin" : "12-3456789",
    "recipientTin" : "XXX-XX-1234",
    "recipientNameAddress" : {
      "line1" : "1 Main St",
      "city" : "Melrose",
      "state" : "NY",
      "postalCode" : "12121",
      "name1" : "Kris Q. Public"
    },
    "accountNumber" : "123-1234567",
    "unemploymentCompensation" : 1000.0,
    "taxRefund" : 2000.0,
    "refundYear" : 2019,
    "federalTaxWithheld" : 400.0,
    "rtaaPayments" : 500.0,
    "grants" : 600.0,
    "agriculturePayments" : 700.0,
    "businessIncome" : true,
    "marketGain" : 900.0,
    "stateTaxWithholding" : [ {
      "stateTaxWithheld" : 110.0,
      "state" : "CA",
      "stateTaxId" : "123-12345",
      "stateIncome" : 1100.0
    } ]
  }
} ]

© Copyright 2022. All Rights Reserved.