Get Summary for Tax Documentation

🚧

This page is marked as deprecated, but Taxbit will continue supporting customers currently using these solutions. If you’d like to learn more about upgrading to our new React SDK with enhanced Digital W8/W9 support, reach out to our team today.

To retrieve the tax documentation status for an existing customer, you can call getSummary() as shown in the example below.

Get Tax Documentation Summary information for an account

const summary = await taxBit.taxDocumentation.getSummary();

If no summary exists for the account owner, an object with a status of UNDOCUMENTED will be returned.

{ 
  status: 'UNDOCUMENTED', 
}

If a summary does exist, the response from the promise will be in one of two formats. For the W-9 documentType, the format will look similar to the following.

{ 
  id: 'uuid', // the TaxBit internal id
  documentType: 'W-9',
  status: 'VALID', 
  tinVerificationStatus: 'VALID',
  tinVerificationDate: '2023-06-13T21:49:45.235Z' // in ISO format
}

The status can be one of the following values

// VALID INVALID UNDOCUMENTED

// VALID INVALID UNDOCUMENTED

The tinVerificationStatus can be:

// UNPROCESSED PENDING INVALID MISMATCH NOT_ISSUED VALID_TIN_TYPE_MISMATCH VALID

For the W-8BEN or W-8BEN-E, the format will look like the following.

{ 
  id: 'uuid', // the TaxBit internal id
  documentType: 'W-8BEN', // or 'W-8BEN-E'
  status: 'VALID', 
  issues: [],
  expirationDate: '2026-12-31T00:00:00.000Z' // in ISO format
}

The status can be one of the following values

// VALID INVALID UNDOCUMENTED

The issues array may include issues with the following structure.

{ 
  issueType: 'ISSUE TYPE',
  issueStatus: 'RESOLVED',
  curingStatus: 'RESOLVED'
  resubmissionStatus: 'RESOLVED'
}

Potential values for issueType: PO_BOX_PERMANENT_ADDRESS, US_PERMANENT_ADDRESS, US_MAILING_ADDRESS, EXPIRED_FORM, CARE_OF_PERMANENT_ADDRESS

Potential values for issueStatus: OPEN, RESOLVED

Potential values for curingStatus: NOT_APPLICABLE, OPEN, RESOLVED

Potential values for resubmissionStatus: NOT_APPLICABLE, OPEN, RESOLVED

The W-8BEN and W-8BEN-E normally expire after 3 years.

Please refer to the API documentation referring to the summary endpoint for more information.