Ctrlk
Help CenterContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tax Documents

Endpoints for creating, completing, and retrieving partner tax documents.

Retrieve the latest tax document

get

Returns the most recently saved tax document for the partner account.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Responses
200

OK

application/json
IdstringOptional

Unique identifier of the tax document.

Example: 224289
UserIdstringOptional

ID of the account user the document belongs to.

Example: 12345
EmailstringOptional

Email address of the user the document belongs to.

Example: hazelnutt@example.com
Statusstring · enumOptional

Current status of the tax document.

Example: NEWPossible values:
EnvelopeIdstringOptional

Unique identifier of the DocuSign envelope (DocuSign provider only).

Example: 47b6c24d-f313-4343-9252-7e477f8a267c
Typestring · enum · nullableOptional

The IRS tax form type. Empty until the user selects a form in the iframe.

Example: W9Possible values:
SubmitDatestring · date-timeOptional

Date and time the tax document was submitted (ISO 8601).

Example: 2024-02-23T04:32:47-08:00
UpdateDatestring · date-timeOptional

Date and time the tax document was last updated (ISO 8601).

Example: 2024-02-23T04:32:47-08:00
Providerstring · enumOptional

The provider that collected the tax document.

Example: DOCUSIGNPossible values:
UristringOptional

API resource path for this tax document.

Example: /Mediapartners/<AccountSID>/TaxDocuments/224289
get/Mediapartners/{AccountSID}/TaxDocument
curl
curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/TaxDocument' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

OK

{
  "Id": "224289",
  "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/224289"
}

Create a tax document

post

Initiates a new tax document submission. Returns an iframe URL the partner opens to fill in and sign the form. All parameters except Provider apply to DocuSign only.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Body
DocTypestring · enumOptional

The IRS tax form type to collect.

Possible values:
IdstringOptional

The ID of the account user. Defaults to the first user on the account when omitted.

ReturnUrlstringOptional

Absolute URL DocuSign uses as the callback after signing.

Providerstring · enumOptional

Required when collecting via Comply Exchange. Defaults to DOCUSIGN.

Possible values:
Responses
200

OK

application/json
StatusstringOptional

Outcome status returned by the provider.

Example: OK
UristringOptional

API resource path for this tax document.

Example: /Mediapartners/<AccountSID>/TaxDocuments/224289
EmailstringOptional

Email address of the user the document was created for.

Example: hazelnutt@example.com
IdstringOptional

Unique identifier for the newly created tax document.

Example: 224289
UserIdstringOptional

ID of the account user the document was created for.

Example: 12345
UrlstringOptional

Iframe URL the partner opens to sign the tax document.

Example: https://demo.docusign.net/Signing/StartInSession.aspx?t=example
post/Mediapartners/{AccountSID}/TaxDocument
curl
curl -L \
  --request POST \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/TaxDocument' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'
200

OK

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/224289",
  "Email": "hazelnutt@example.com",
  "Id": "224289",
  "UserId": "12345",
  "Url": "https://demo.docusign.net/Signing/StartInSession.aspx?t=example"
}

Retrieve a specific tax document

get

Returns a specific tax document by its unique Id.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

IdstringRequired

Unique identifier of the tax document.

Responses
200

OK

application/json
IdstringOptional

Unique identifier of the tax document.

Example: 224289
UserIdstringOptional

ID of the account user the document belongs to.

Example: 12345
EmailstringOptional

Email address of the user the document belongs to.

Example: hazelnutt@example.com
Statusstring · enumOptional

Current status of the tax document.

Example: NEWPossible values:
EnvelopeIdstringOptional

Unique identifier of the DocuSign envelope (DocuSign provider only).

Example: 47b6c24d-f313-4343-9252-7e477f8a267c
Typestring · enum · nullableOptional

The IRS tax form type. Empty until the user selects a form in the iframe.

Example: W9Possible values:
SubmitDatestring · date-timeOptional

Date and time the tax document was submitted (ISO 8601).

Example: 2024-02-23T04:32:47-08:00
UpdateDatestring · date-timeOptional

Date and time the tax document was last updated (ISO 8601).

Example: 2024-02-23T04:32:47-08:00
Providerstring · enumOptional

The provider that collected the tax document.

Example: DOCUSIGNPossible values:
UristringOptional

API resource path for this tax document.

Example: /Mediapartners/<AccountSID>/TaxDocuments/224289
get/Mediapartners/{AccountSID}/TaxDocument/{Id}
curl
curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/TaxDocument/{Id}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
{
  "Id": "224289",
  "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/224289"
}

List all tax documents

get

Returns every tax document submitted for the partner account.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Responses
200

OK

application/json
get/Mediapartners/{AccountSID}/TaxDocuments
curl
curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/TaxDocuments' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

OK

{
  "TaxDocuments": [
    {
      "Id": "224289",
      "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/224289"
    }
  ]
}

Complete tax document submission

post

Records the outcome of a tax document submission collected via the Comply Exchange iframe. Call this immediately after the user finalizes submission in the iframe so the document is recorded as submitted in impact.com. DocuSign signals completion via the ReturnUrl callback supplied at Create time instead.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired

Unique identifier for the partner account.

Body
idstringRequired

The Id of the tax document being submitted.

eventstring · enumRequired

The lifecycle event being signalled. Always Complete.

Possible values:
Responses
200

OK

application/json
StatusstringOptional

Outcome status of the completion call.

Example: OK
UristringOptional

API resource path for the completed tax document.

Example: /Mediapartners/<AccountSID>/TaxDocuments/224289
post/Mediapartners/{AccountSID}/TaxDocument/Complete
curl
curl -L \
  --request POST \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/TaxDocument/Complete' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'
200

OK

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/TaxDocuments/224289"
}
PreviousTax Document
NextModels

Last updated