Skip to main content
Version: 2.0

Update

Update

This endpoint modifies the details of an existing business in the TaxBandits API. Use this when a business's name, address, TIN, contact information, or any other detail needs to be corrected or changed after creation.

Identify the business using either its BusinessId or PayerRef. Multiple businesses can be updated in a single request by passing multiple Objects in the Businesses array.

Changes apply to any in-progress returns associated with the business. Updates will not impact returns that have already been transmitted.

Key Points

  • TIN Format — The TIN Format (PLAIN, ENCRYPTED, TOKEN) can be changed during an update.
  • DBA Updates — DBA details can be updated here, or separately using the UpdateDBA endpoint.
  • Identifiers Unchanged — Updating a business does not change its BusinessId or PayerRef.

For the description of ENUM values, Click Here.

PUT business/update 

Request Body

FieldTypeDescription
BusinessesObject []An array of business Objects. Pass multiple Objects to create businesses in bulk.
SequenceIdStringOptional A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.*Size Range: 50
PayerRefStringOptional Your unique identifier for the payer. Can replace BusinessId in future requests. *Size Range: 50
IsDefaultBusinessBooleanWhen set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetailsObjectTIN information for the business
FormatStringSpecifies how the TIN is passed.
Allowed values

"PLAIN_TIN" — Pass TIN directly.

TINTypeStringSpecify the TIN type of the business.
Allowed values

"EIN", "SSN", “QI-EIN”, “ITIN”, “WP-EIN”, “WT-EIN”, “NQI-EIN”, “IRSN”

TINStringThe TIN value, formatted according to the Format field selected.
IndividualNmObjectRequired when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNmStringOptional The first name of the individual. *Size Range: 20
MiddleNmStringOptional The middle name of the individual. *Size Range: 20
LastNmStringThe last name of the individual. Size Range: 20
SuffixStringOptional The suffix of the individual’s name.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

BusinessNmStringLegal name of the business. Required when TINType is EIN. Size Range: 75
NameCtrlStringName control of the business as registered with the IRS. Size Range: 3-4
DBADetailsObjectDBA (Doing Business As) information. Optional at creation — additional DBAs can be added later via AddDBA.
DBANmStringName of the DBA. Size Range: 75
DBARefStringYour unique identifier for this DBA. Size Range: 1-50
DBAIdGUIDTaxBandits-generated DBA identifier. Returned in the response.
AddressObjectAddress information of DBA
Address1StringStreet address or PO Box. Size Range: 46
Address2StringOptional Suite or apartment number. Size Range: 46
CityStringDBA’s city. Size Range: 50
ProvinceOrStateObjectDBA's province or state name.
Allowed values

When the country code is US :
"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
When the country code is CA:
“AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT”

Note: The size range is set to 50 for all countries except the United States and Canada.

ZipCdStringDBA’s ZIP code.
Size Range: 5-16
CountryStringDBA’s 2-character country code.
Allowed values

"US","AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

AddressObjectPrimary address of the business
Address1StringStreet address or PO Box of the business.
Size Range: 46
Address2StringOptional Suite or apartment number of the business.
*Size Range: 46
CityStringCity of the business.
Size Range: 50
ProvinceOrStateStringProvince or state name of the business.
Allowed values

When the country code is US :
"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
Note: The size range is set to 50 for all countries except the United States and Canada.

ZipCdStringZIP code of the business.
Size Range: 5-16
CountryString2-character country code of the business.
Allowed values

"US","AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

ContactDetailsObjectDetails of the person the IRS can contact regarding this business.
FirstNmStringFirst name of the contact person.
Size Range: 20
MiddleNmStringOptional Middle name of the contact person.
Size Range: 20
LastNmStringLast name of the contact person.

Size Range: 20
SuffixStringOptional The suffix of the contact person.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

PhoneStringOptional Phone number of the contact person
10 digits
PhoneExtnStringOptional Phone extension number.
Size Range: 5
EmailStringOptional Email address of the contact person.

Max 100 characters
FaxStringOptional Fax number of the contact person.

10 digits
W2SpecificObjectInformation specific to W-2 filings. Optional for 1099 and 94X.
KindOfEmployerStringIdentifies the kind of payer.
Allowed values

"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY", ”SLGOV”

KindOfPayerStringIdentifies the kind of employer.
Allowed values

"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1"

Form1042SSpecificObjectInformation specific to 1042-S filings
WHAgtCh3CdStringChapter 3 status code of the Withholding Agent.
Allowed values

"05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"

WHAgtCh4CdStringChapter 4 status code of the Withholding Agent.
Allowed values

"01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50"

WHAgtGIINStringOptionalWithholding agent’s Global Intermediary Identification Number (GIIN).

Size Range: 19
FTINStringOptional Foreign Tax Identification Number of the withholding agent.
CountryStringOptional Withholding agent's country code.
Allowed values

"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

ACASpecificObjectOptional Information specific to ACA filings
IsInsurerBooleanConfirms if the business is an insurer
IsGovernmentalUnitBooleanConfirms if the business is a disregarded governmental entity
Form480SpecificObjectOptional Information specific to 480 filings
TaxPayerTypeStringType of taxpayer
Allowed values

"PASS_THROUGH_ENTITY", "CORPORATION", "INDIVIDUAL" ,"ESTATE_OR_TRUST", "OTHERS"

BusinessTypeStringLegal structure of the business. Mandatory for 94X, optional for W-2 and 1099.

Allowed values

“ESTE”, “PART”, ”CORP”, “EORG”, “SPRO”

SigningAuthorityObjectDetails of the person authorized to sign the return. Mandatory for 94X series.
FirstNmStringFirst name of the signatory.
Size Range: 20
MiddleNmStringOptional Middle name of the signatory.
Size Range: 20
LastNmStringOptional Last name of the signatory.
Size Range: 20
SuffixStringOptional The suffix of the signatory.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

PhoneStringOptional Phone number of the signatory.
Size Range: 10
PhoneExtnStringOptional Phone extension number of the signatory.
Size Range: 5
BusinessMemberTypeStringOptional Title or role of the signatory.
Allowed values

"CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER", "REPORTINGAGENT"

Response Body

FieldTypeDescription
SuccessBusinessesObject[]Business records that were created or updated successfully.
SequenceIdStringA unique reference ID for the submission that can be used to identify a particular record.
BusinessIdGUIDUnique identifier generated by TaxBandits. Store this for use in all subsequent requests.
PayerRefStringYour unique identifier for the payer, as provided in the request.
Last4DigitTINStringLast 4 digits of the business TIN, for verification.
IsDefaultBusinessBooleanConfirms whether this business was set as the default.
DBADetailsObjectDBA details of the business.
SequenceIdStringA unique reference ID for the submission that can be used to identify a particular DBA.
DBAIdGUIDUnique identifier generated for the DBA.
DBARefStringYour unique identifier for the DBA.
DBANmStringName of the DBA as registered.
ErrorBusinessesObject[]Records that failed, with details on why they failed.
SequenceIdStringA unique reference ID for the submission that can be used to identify a particular record.
BusinessIdGUIDBusiness identifier if a partial record was created.
PayerRefStringYour unique identifier for the business.
Last4DigitTINStringLast 4 digits of the TIN for reference.
IsDefaultBusinessBooleanIndicates whether the business is the default business.
DBADetailsObjectGets the details of the DBA of the business.
SequenceIdStringA unique reference ID for the submission that can be used to identify a particular DBA.
DBAIdGUIDGets the unique identifier of a DBA.
DBARefStringGets the unique identifier of the DBA. This identifier can be used in future references of the DBA in the API.
DBANmStringGets the name of the DBA.
ErrorsObject[]Validation error details.
IdStringValidation error code.
NameStringName of the validation rule that failed.
MessageStringClear description of what went wrong and how to fix it.
ErrorsObject[]Top-level request errors if the entire request cannot be processed.
IdStringValidation error code.
NameStringName of the validation rule that failed.
MessageStringClear description of what went wrong and how to fix it.
Request Json
SampleDescriptionAction
Sample 1
Update a business with TIN, DBA, address, contact, and form-specific details.
Sample 1
{
"Businesses": [
{
"BusinessId": "519a84f4-5e56-496a-82f3-18f51fdf3d75",
"SequenceId": "01",
"PayerRef": "Pe10660",
"IsDefaultBusiness": false,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "12-0160888"
},
"IndividualNm": null,
"BusinessNm": "TY- littele",
"NameCtrl": "SNOW",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "90bed259-1189-43c3-9941-be6eb6db4117",
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "AL",
"ZipCd": "35008",
"Country": "US"
}
},
"Address": {
"Address1": "1600 Pennsylvania Avenue NW",
"Address2": null,
"City": "Washington",
"ProvinceOrState": "DC",
"ZipCd": "20500",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr",
"Phone": "8035551234",
"PhoneExtn": "101",
"Email": "james@sample.com",
"Fax": "8035555678"
},
"W2Specific": {
"KindOfEmployer": "STATEORLOCAL501C",
"KindOfPayer": "REGULAR941"
},
"Form1042SSpecific": {
"WHAgtCh3Cd": "32",
"WHAgtCh4Cd": "49",
"WHAgtGIIN": "234324.42344.LE.372",
"FTIN": "740l-73bt-hh73",
"Country": "AL"
},
"ACASpecific": {
"IsInsurer": false,
"IsGovernmentalUnit": true
},
"Form480Specific": {
"TaxPayerType": "CORPORATION"
},
"BusinessType": "ESTE",
"SigningAuthority": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr",
"Phone": "8035551234",
"PhoneExtn": "102",
"BusinessMemberType": "ADMINISTRATOR"
}
}
]
}
Response Json
SampleDescriptionAction
200
Success Response - You'll get the below response when the request is processed successfully.
400
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
300
Multi-status Response - You'll get the below response when multiple statuses are included.
401
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 200,
"SuccessBusinesses": [
{
"SequenceId": "01",
"BusinessId": "031042f7-834c-4cc2-8b8e-494f40d435db",
"PayerRef": "Pe68508",
"Last4DigitTIN": "9751",
"IsDefaultBusiness": false,
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "e3652984-313e-4728-9b19-8f8682c56e34"
}
}
],
"ErrorBusinesses": null,
"Errors": null
}