| Parameter |
Required? |
Location |
Type |
Description |
| Authorization |
required |
header |
string |
The [Authorization HTTP request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization) provides credentials to allow access to a protected resources |
| x-fapi-interaction-id |
required |
header |
FapiInteractionId |
Unique identifier for this interaction |
| FDX-API-Actor-Type |
optional |
header |
ActorType |
Identifies whether the customer is present (USER) or it is a BATCH operation |
| FDX-API-Data-Provider-Id |
optional |
header |
Identifier |
ID for the financial institution responding to the request |
| accountId |
optional |
query |
string |
Account Identifier for use in searching or authorization. Optional |
| taxYear |
optional |
query |
TaxYear |
Tax year in which to search for tax forms. Optional |
| taxForms |
optional |
query |
Array of TaxFormType |
One or more tax form type enums for the specific documents being requested. Comma separated |
| Accept |
required |
header |
string |
Use the [Accept HTTP request header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept) to indicate one or more content types to request for the search result response. Use `application/json` to request data, `application/pdf`, `application/zip` or `image/*` MIME-types to request images. In comma-separated array format using values typically from './fdxapi.components.yaml#/components/schemas/ContentTypes' enumeration. Use in combination with TaxDataTypeQuery parameter to request `application/json` responses in 'JSON' or 'BASE64_PDF' format for tax form data |
| taxDataType |
optional |
query |
TaxDataType |
Use taxDataType to request `application/json` tax form data response in 'JSON' or 'BASE64_PDF' format. Omit if either format is acceptable. Used in combination with AcceptHeader requesting `application/json` response |
| resultType |
optional |
query |
ResultType |
Flag to indicate if you want a lightweight array of metadata (AccountDescriptor or Tax or Operations) or full item details (Account or a Tax subclass or Availability details). If set to 'lightweight', should only return the fields associated with the metadata entity. This field is not required, defaults to lightweight |
| Response Code |
Response Type |
Description |
|---|
| 200 | application/zip or
application/json of TaxStatementList | Array of all the tax document data and tax form images available for the customer matching search criteria |
| 206 | application/json of TaxStatementList | Partial Content success searching for customer Tax Data forms, some errors are being returned |
| 400 | application/json of Error | Request is invalid or parameter values are not supported |
| 404 | application/json of Error | Tax Form not Found |
| 406 | application/json of Error | Content Type not Supported |
| 409 | application/json of Error | Tax forms are not currently available for this account or this year |
| 500 | application/json of Error | Catch-all exception where request was not processed due to an internal outage/issue. Consider other more specific errors before using this error |
| 501 | application/json of Error | Error when FdxVersion in Header is not one of those implemented at backend |
| 503 | application/json of Error | System is down for maintenance |