Guides

SDK Migration Guide

Suggest Edits

🚧

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.

SDK v1 → v2 Migration Guide

SDK Changes

The following changes have been made to the SDK API

Collection

The API to collect tax documentation data has changed.

From taxBit.ui.taxDocumentation.loadCreateForm to taxBit.ui.taxDocumentation.collect.

The data provided to the function has also changed somewhat. No longer is “documentType” submitted at the top level. Instead, “documentType” is now an attribute in the data object. See the “Data Format Changes” below.

taxBit.ui.taxDocumentation.collect({ data: {}, hostElement })

Certification

The API to certify tax documentation data has changed.

From taxBit.ui.taxDocumentation.loadCertifyForm to taxBit.ui.taxDocumentation.certify.

Data Format

Changes to Payload

The following changes have been made to the payload for SDK

PropertyAction
nameLine2Renamed to dbaName
Field renamed to better refer to "doing business as" instead of the second line of a user's legal name.
llcTaxClassificationRemoved
taxClassificationAdded LLC_C, LLC_S, and LLC_P
LLC_S denotes "Limited Liability Company - S Corporation"
LLC_C denotes "Limited Liability Company - C Corporation"
LLC_P denotes "Limited Liability Company - Partnership"
taxIdRenamed to tin
Field renamed to better describe user's tax identifiers. It is short for "tax identification number".
taxIdTypeRenamed to tinType
Field renamed to better describe user's tax identifiers. It is short for "tax identification number".
isCertifiedByClientRenamed to hasCertified
Field renamed to provide simpler and more straightforward language to describe that users have certified that the provide information is accurate.
signatureDateRenamed to signatureTimestamp
Field renamed to better indicate the date and time that a signature was obtained, rather than just the date. The format needs to be in the correct ISO format.
isNotSubjectBackupWithholdingAdded
Field added to denote if users are subject to backup withholding.

Tax Classification Acceptable Values

taxClassification will accept the following values for payload into our SDK.

LLC_C
LLC_S
LLC_P
INDIVIDUAL
C_CORPORATION
S_CORPORATION
PARTNERSHIP
TRUST_ESTATE
SMLLC
DRE
SOLE_PROPRIETOR
OTHER

Version 2 Example

const payload = {
  name: 'User Name',
  dbaName: 'DBA Name',
  taxClassification: 'INDIVIDUAL',
  address: {
    firstLine: '123 Main St',
    secondLine: 'APT 504',
    city: 'Seattle',
    stateOrProvince: 'WA',
    postalCode: '98000',
    country: 'US',
  },
  tin: '123123123',
  // tin_type must be SSN, EIN, ITIN, or ATIN
  tinType: 'SSN',
  documentType: 'W-9',
  // Must be true to pass validation
  hasCertified: true,
  // Can be true or false
  isNotSubjectBackupWithholding: false,
  // Must be the same as name field
  signature: 'User Name',
  signatureTimestamp: new Date().toISOString(),
};

New Features

Canada Address

Canadian Address are now supported.

Provinces: all provinces of Canada are supported.

Postal Code: users can send the 3 acceptable format of CA postal code (A stands for Alphabet and N stands for Numeric)

ANA NAN
ANA-NAN
ANANAN

Updated 5 days ago