Skip to main content
Version: 2.0.0

UpdateDBA

UpdateDBA

This endpoint modifies the name or address of an existing DBA associated with a business. Identify the DBA using its DBAId or DBARef.

PUT business/updatedba 

Request Body

FieldTypeDescription
BusinessIdGuidTaxBandits-generated unique identifier of the business.
PayerRefStringYour unique identifier for the business.
DBADetailsobject[]Information about the DBA.
   DBAIdGUIDTaxBandits-generated unique identifier of the DBA.
   SequenceIdstringOptional A unique reference ID for the submission that can be used to identify a particular DBA.
Size Range: 50
   DBANmstringName of the DBA.
Size Range: 75
   DBARefstringYour unique identifier for this DBA.
Size Range: 1-50
   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
      ProvinceOrStateStringDBA'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", "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", "AO", "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"

Response Body

FieldTypeDescription
BusinessIdGUIDTaxBandits-generated unique identifier of the business.
PayerRefStringYour unique identifier for the business.
DBADetailsObject[]Details of the DBA.
   SuccessRecordsObject []DBA records that were added successfully.
      SequenceIdStringA unique reference ID for the submission that can be used to identify a particular DBA.
      DBAIdGUIDUnique identifier generated for the DBA. Store this for future DBA operations.
      DBARefStringYour unique identifier for the DBA.
      DBANmStringName of the DBA as registered.
   ErrorRecordsObject []Records that failed to process.
      SequenceIdStringA unique reference ID that can be used to identify a particular DBA.
      DBAIdGUIDTaxBandits-generated unique identifier of the DBA.
      DBARefStringYour unique identifier for the DBA.
      DBANmStringName of the DBA as registered.
ErrorsObject []Top-level request errors if the entire request cannot be processed.
   IdStringValidation error code.
   NameStringName of the validation rule that failed.
   MessageStringDescription of what went wrong
Request JSON
SampleDescriptionAction
Sample 1
Update DBA details for a business using PayerRef and DBAId.
Sample 1
{
"BusinessId": "fe6b952e-439f-4079-ac6d-92d3e799e903",
"PayerRef": "84733",
"DBADetails": [
{
"SequenceId": "01",
"DBANm": "Icecreams",
"DBAId": "7e81628b-b581-4054-b3ec-cc4400602504",
"DBARef": "DBA1002",
"Address": {
"Address1": "1600 Pennsylvania Avenue NW",
"Address2": null,
"City": "Washington",
"ProvinceOrState": "DC",
"ZipCd": "20500",
"Country": "US"
}
}
]
}
Response JSON
ResponseDescriptionAction
200
Success Response - This is a sample response for successful API requests.
207
Multi-status Response - You'll get the below response when multiple statuses are included.
400
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
400
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
Response: 200
{
"BusinessId": "fe6b952e-439f-4079-ac6d-92d3e799e903",
"PayerRef": "Pe77162",
"DBADetails": {
"SuccessRecords": [
{
"SequenceId": "01",
"DBAId": "7e81628b-b581-4054-b3ec-cc4400602504",
"DBARef": "DBA1002",
"DBANm": "Icecreams"
}
],
"ErrorRecords": null
},
"Errors": null
}