API Reference

List all tax documents

This endpoint retrieves all tax documents for the account.

Parameters

No parameters.

Returns

Returns an array of Tax Document objects up to a limit dictated by @pagesize. Each entry in the array is a separate tax document. If no tax documents meet the criteria, the resulting array will be empty. This request should never return an error.

Example Request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/TaxDocuments'
  -X GET \
  -u '<AccountSid>:<AuthToken>' \
  -H 'Accept: application/json'

Example Response

{
"@page": "1",
"@numpages": "1",
"@pagesize": "100",
"@total": "3",
"@start": "0",
"@end": "6",
"@uri": "/Mediapartners/<AccountSID>/TaxDocuments.json",
"@firstpageuri": "/Mediapartners/<AccountSID>/TaxDocuments.json?PageSize=100&Page=1",
"@previouspageuri": "",
"@nextpageuri": "",
"@lastpageuri": "/Mediapartners/<AccountSID>/TaxDocuments.json?PageSize=100&Page=1",
"TaxDocuments": [

    {
      "Id": "364",
      "UserId": "12345",
      "Email": "hazelnutt@example.com",
      "Status": "INACTIVE",
      "EnvelopeId": "e1eb0732-c47d-453e-b836-b900cbaa5416",
      "Type": "W9",
      "SubmitDate": "2024-02-15T02:53:04-08:00",
      "UpdateDate": "2024-02-15T03:02:03-08:00",
      "Provider": "DOCUSIGN",
      "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/364"
    },
    {
      "Id": "365",
      "UserId": "54321",
      "Email": "",
      "Status": "NOT_VERIFIED",
      "EnvelopeId": "bcec9629-0ec4-4fe4-83b5-3639639ba19c",
      "Type": "W9",
      "SubmitDate": "2024-02-16T01:52:30-08:00",
      "UpdateDate": "2024-02-16T01:53:52-08:00",
      "Provider": "DOCUSIGN",
      "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/365"
    },
    {
      "Id": "366",
      "UserId": "12345",
      "Email": "hazelnutt@example.com",
      "Status": "NEW",
      "EnvelopeId": "47b6c24d-f313-4343-9252-7e477f8a267c",
      "Type": "W9",
      "SubmitDate": "2024-02-23T04:32:47-08:00",
      "UpdateDate": "2024-02-23T04:32:47-08:00",
      "Provider": "DOCUSIGN",
      "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/366"
    }
  ]
}

{
  "@page": "1",
  "@numpages": "1",
  "@pagesize": "100",
  "@total": "2",
  "@start": "0",
  "@end": "1",
  "@uri": "/Mediapartners/<AccountSID>/TaxDocuments",
  "@firstpageuri": "/Mediapartners/<AccountSID>/TaxDocuments?PageSize=100&Page=1",
  "@previouspageuri": "",
  "@nextpageuri": "",
  "@lastpageuri": "/Mediapartners/<AccountSID>/TaxDocuments?PageSize=100&Page=1",
  "TaxDocuments":   [
        {
      "Id": "1233",
      "UserId": "12345",
      "Email": "hazelnutt@example.com",
      "Status": "INACTIVE",
      "Type": "W8BEN",
      "SubmitDate": "2016-08-25T09:24:17-07:00",
      "UpdateDate": "2023-08-15T10:04:30-07:00",
      "Provider": "COMPLY_EXCHANGE",
      "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/3767"
    },
        {
      "Id": "1234",
      "UserId": "12345",
      "Email": "hazelnutt@example.com",
      "Status": "ACTIVE",
      "Type": "W8BEN",
      "SubmitDate": "2023-08-15T10:04:30-07:00",
      "UpdateDate": "2023-08-15T10:04:30-07:00",
      "Provider": "COMPLY_EXCHANGE",
      "Uri": "/Mediapartners/IRwQW5zmHirw10836bWvzfixqKuNiGWJd1/TaxDocuments/167317"
    }
  ]
}

Note: Refer to the API Errors page if you encounter any errors.