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
UpdateDBAendpoint. - Identifiers Unchanged — Updating a business does not change its
BusinessIdorPayerRef.
For the description of ENUM values, Click Here.
PUT business/update Request Body
| Field | Type | Description |
|---|---|---|
| Businesses | Object [] | An array of business Objects. Pass multiple Objects to create businesses in bulk. |
| SequenceId | String | Optional 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 |
| PayerRef | String | Optional Your unique identifier for the payer. Can replace BusinessId in future requests. *Size Range: 50 |
| IsDefaultBusiness | Boolean | When set to TRUE, this business will be set as the default across requests that do not specify a business. |
| TINDetails | Object | TIN information for the business |
| Format | String | Specifies how the TIN is passed. Allowed values"PLAIN_TIN" — Pass TIN directly. |
| TINType | String | Specify the TIN type of the business. Allowed values"EIN", "SSN", “QI-EIN”, “ITIN”, “WP-EIN”, “WT-EIN”, “NQI-EIN”, “IRSN” |
| TIN | String | The TIN value, formatted according to the Format field selected. |
| IndividualNm | Object | Required when TINType is SSN. Provide individual name fields instead of BusinessNm. |
| FirstNm | String | Optional The first name of the individual. *Size Range: 20 |
| MiddleNm | String | Optional The middle name of the individual. *Size Range: 20 |
| LastNm | String | The last name of the individual. Size Range: 20 |
| Suffix | String | Optional The suffix of the individual’s name. Allowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
| BusinessNm | String | Legal name of the business. Required when TINType is EIN. Size Range: 75 |
| NameCtrl | String | Name control of the business as registered with the IRS. Size Range: 3-4 |
| DBADetails | Object | DBA (Doing Business As) information. Optional at creation — additional DBAs can be added later via AddDBA. |
| DBANm | String | Name of the DBA. Size Range: 75 |
| DBARef | String | Your unique identifier for this DBA. Size Range: 1-50 |
| DBAId | GUID | TaxBandits-generated DBA identifier. Returned in the response. |
| Address | Object | Address information of DBA |
| Address1 | String | Street address or PO Box. Size Range: 46 |
| Address2 | String | Optional Suite or apartment number. Size Range: 46 |
| City | String | DBA’s city. Size Range: 50 |
| ProvinceOrState | Object | DBA's province or state name. Allowed values When the country code is US : |
| ZipCd | String | DBA’s ZIP code. Size Range: 5-16 |
| Country | String | DBA’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" |
| Address | Object | Primary address of the business |
| Address1 | String | Street address or PO Box of the business. Size Range: 46 |
| Address2 | String | Optional Suite or apartment number of the business. *Size Range: 46 |
| City | String | City of the business. Size Range: 50 |
| ProvinceOrState | String | Province or state name of the business. Allowed values When the country code is US : |
| ZipCd | String | ZIP code of the business. Size Range: 5-16 |
| Country | String | 2-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" |
| ContactDetails | Object | Details of the person the IRS can contact regarding this business. |
| FirstNm | String | First name of the contact person. Size Range: 20 |
| MiddleNm | String | Optional Middle name of the contact person. Size Range: 20 |
| LastNm | String | Last name of the contact person. Size Range: 20 |
| Suffix | String | Optional The suffix of the contact person. Allowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
| Phone | String | Optional Phone number of the contact person 10 digits |
| PhoneExtn | String | Optional Phone extension number. Size Range: 5 |
| String | Optional Email address of the contact person. Max 100 characters | |
| Fax | String | Optional Fax number of the contact person. 10 digits |
| W2Specific | Object | Information specific to W-2 filings. Optional for 1099 and 94X. |
| KindOfEmployer | String | Identifies the kind of payer. Allowed values"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY", ”SLGOV” |
| KindOfPayer | String | Identifies the kind of employer.Allowed values"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
| Form1042SSpecific | Object | Information specific to 1042-S filings |
| WHAgtCh3Cd | String | Chapter 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" |
| WHAgtCh4Cd | String | Chapter 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" |
| WHAgtGIIN | String | OptionalWithholding agent’s Global Intermediary Identification Number (GIIN). Size Range: 19 |
| FTIN | String | Optional Foreign Tax Identification Number of the withholding agent. |
| Country | String | Optional 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" |
| ACASpecific | Object | Optional Information specific to ACA filings |
| IsInsurer | Boolean | Confirms if the business is an insurer |
| IsGovernmentalUnit | Boolean | Confirms if the business is a disregarded governmental entity |
| Form480Specific | Object | Optional Information specific to 480 filings |
| TaxPayerType | String | Type of taxpayer Allowed values"PASS_THROUGH_ENTITY", "CORPORATION", "INDIVIDUAL" ,"ESTATE_OR_TRUST", "OTHERS" |
| BusinessType | String | Legal structure of the business. Mandatory for 94X, optional for W-2 and 1099. Allowed values“ESTE”, “PART”, ”CORP”, “EORG”, “SPRO” |
| SigningAuthority | Object | Details of the person authorized to sign the return. Mandatory for 94X series. |
| FirstNm | String | First name of the signatory. Size Range: 20 |
| MiddleNm | String | Optional Middle name of the signatory. Size Range: 20 |
| LastNm | String | Optional Last name of the signatory. Size Range: 20 |
| Suffix | String | Optional The suffix of the signatory. Allowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
| Phone | String | Optional Phone number of the signatory. Size Range: 10 |
| PhoneExtn | String | Optional Phone extension number of the signatory. Size Range: 5 |
| BusinessMemberType | String | Optional 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
| Field | Type | Description |
|---|---|---|
| SuccessBusinesses | Object[] | Business records that were created or updated successfully. |
| SequenceId | String | A unique reference ID for the submission that can be used to identify a particular record. |
| BusinessId | GUID | Unique identifier generated by TaxBandits. Store this for use in all subsequent requests. |
| PayerRef | String | Your unique identifier for the payer, as provided in the request. |
| Last4DigitTIN | String | Last 4 digits of the business TIN, for verification. |
| IsDefaultBusiness | Boolean | Confirms whether this business was set as the default. |
| DBADetails | Object | DBA details of the business. |
| SequenceId | String | A unique reference ID for the submission that can be used to identify a particular DBA. |
| DBAId | GUID | Unique identifier generated for the DBA. |
| DBARef | String | Your unique identifier for the DBA. |
| DBANm | String | Name of the DBA as registered. |
| ErrorBusinesses | Object[] | Records that failed, with details on why they failed. |
| SequenceId | String | A unique reference ID for the submission that can be used to identify a particular record. |
| BusinessId | GUID | Business identifier if a partial record was created. |
| PayerRef | String | Your unique identifier for the business. |
| Last4DigitTIN | String | Last 4 digits of the TIN for reference. |
| IsDefaultBusiness | Boolean | Indicates whether the business is the default business. |
| DBADetails | Object | Gets the details of the DBA of the business. |
| SequenceId | String | A unique reference ID for the submission that can be used to identify a particular DBA. |
| DBAId | GUID | Gets the unique identifier of a DBA. |
| DBARef | String | Gets the unique identifier of the DBA. This identifier can be used in future references of the DBA in the API. |
| DBANm | String | Gets the name of the DBA. |
| Errors | Object[] | Validation error details. |
| Id | String | Validation error code. |
| Name | String | Name of the validation rule that failed. |
| Message | String | Clear description of what went wrong and how to fix it. |
| Errors | Object[] | Top-level request errors if the entire request cannot be processed. |
| Id | String | Validation error code. |
| Name | String | Name of the validation rule that failed. |
| Message | String | Clear description of what went wrong and how to fix it. |
| Sample | Description | Action |
|---|---|---|
| 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"
}
}
]
}
| Sample | Description | Action |
|---|---|---|
| 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
}