To request API access, go to /apps/sdkapp/

Additional documentation in the form of Swagger UI is available. Contact us at support@taxdochub.com for details.

---

POST tax document data. Receive an Intelligent Tax Document™ (PDF).

HTTP Request

Method

POST

URL, Endpoint

https://<DOMAIN-AVAILABLE-UPON-API-ACCESS-GRANT>/fdx/v5/tax-forms

Our server implements the Financial Data Exchange (FDX) API standard, version 5.0.

Request headers

Accept: application/pdf
x-apikey: {your-api-key}

Query Parameters

?maskTin=true
&withFire=true
&withCoverSheet=true
&withAddresses=true
&triFold=true&withQr=true
&itdType=logo
&withInstructions=true
&withCoordinates=true

maskTin=true (default value: true)

Show taxpayer ID as xxx-xx-6789 instead of 123-45-6789, if true.

withFire=true (default value: true)

Forward copy of data to IRS, if true.

withCoverSheet=true (default value: false)

Add a cover sheet to the tax document, if true.

withAddresses=true (default value: false)

For window envelope purposes, include issuer and recipient addresses in the lower portion of the form (or cover sheet), if true.

triFold=true (default value: false)

Position the addresses for folding the form in thirds, if true. Bi-fold positioning applies, if false.

withQr=true (default value: false)

Add QR code in the lower right portion of the tax document, if true.

itdType=logo (default value: logo)

Type of Intelligent Tax Document stamp to show in lower right corner of the tax document. Valid options are 'logo' or 'text'.

withInstructions=true (default value: true)

Attach recipient instructions to the tax document, if true.

withCoordinates=true (default value: false)

Make tax document data importable into tax software, if true. Show import codes, also known as coordinates, in upper left corner of document.

POST body

POST TaxDataList object with 1 tax document.

Example

{
  "forms" : [ {
    "tax1098" : {
      "taxYear" : 2022,
      "corrected" : true,
      "accountId" : "865-278-929",
      "taxFormDate" : "2022-08-31",
      "description" : "description",
      "lenderNameAddress" : {
        "line1" : "5766 Hill Walks",
        "city" : "Lake Teodorachester",
        "state" : "NV",
        "postalCode" : "19225",
        "name1" : "Rachele Anderson",
        "phone" : {
          "number" : "145-867-5309",
          "extension" : "8372"
        }
      },
      "lenderTin" : "13-0228361",
      "borrowerTin" : "539-32-0000",
      "borrowerNameAddress" : {
        "line1" : "2658 Little Keys",
        "city" : "East Chadburgh",
        "state" : "GA",
        "postalCode" : "72284",
        "name1" : "Reiko Hamill"
      },
      "mortgagedProperties" : 2,
      "otherInformation" : "otherInformation",
      "accountNumber" : "240-275-434",
      "mortgageInterest" : 688696.65,
      "outstandingPrincipal" : 79956.39,
      "originationDate" : "2022-08-31",
      "overpaidRefund" : 32301.51,
      "mortgageInsurance" : 56.99,
      "pointsPaid" : 30.52,
      "isPropertyAddressSameAsBorrowerAddress" : true,
      "acquisitionDate" : "2022-08-31",
      "propertyAddress" : {
        "line1" : "597 Pollich Spur",
        "city" : "Sammymouth",
        "state" : "VA",
        "postalCode" : "41326"
      },
      "propertyTax" : 90.3,
      "propertyDescription" : "propertyDescription"
    }
  } ]
}

HTTP Response

Binary PDF content