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
| Field | Type | Description |
|---|---|---|
| BusinessId | Guid | TaxBandits-generated unique identifier of the business. |
| PayerRef | String | Your unique identifier for the business. |
| DBADetails | object[] | Information about the DBA. |
| DBAId | GUID | TaxBandits-generated unique identifier of the DBA. |
| SequenceId | string | Optional A unique reference ID for the submission that can be used to identify a particular DBA. Size Range: 50 |
| DBANm | string | Name of the DBA. Size Range: 75 |
| DBARef | string | Your unique identifier for this DBA. Size Range: 1-50 |
| 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 | String | DBA's province or state name.Allowed valuesWhen 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", "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
| Field | Type | Description |
|---|---|---|
| BusinessId | GUID | TaxBandits-generated unique identifier of the business. |
| PayerRef | String | Your unique identifier for the business. |
| DBADetails | Object[] | Details of the DBA. |
| SuccessRecords | Object [] | DBA records that were added successfully. |
| 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. Store this for future DBA operations. |
| DBARef | String | Your unique identifier for the DBA. |
| DBANm | String | Name of the DBA as registered. |
| ErrorRecords | Object [] | Records that failed to process. |
| SequenceId | String | A unique reference ID that can be used to identify a particular DBA. |
| DBAId | GUID | TaxBandits-generated unique identifier of the DBA. |
| DBARef | String | Your unique identifier for the DBA. |
| DBANm | String | Name of the DBA as registered. |
| 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 | Description of what went wrong |
Payload

Go Lang
Node.js
Python
.NET C#

Ruby
Java

cURL
| Sample | Description | Action |
|---|---|---|
| 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 | Description | Action |
|---|---|---|
| 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
}
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "<APIURL>/v2.0.0/business/updatedba"
method := "PUT"
payload := strings.NewReader(`{
"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"
}
}
]
}`)
client := &http.Client{}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "<ACCESS_TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
const axios = require('axios');
let data = JSON.stringify({
"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"
}
}
]
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: '<APIURL>/v2.0.0/business/updatedba',
headers: {
'Content-Type': 'application/json',
'Authorization': '<ACCESS_TOKEN>'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
import http.client
import json
conn = http.client.HTTPSConnection("<APIURL>")
payload = json.dumps({
"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": None,
"City": "Washington",
"ProvinceOrState": "DC",
"ZipCd": "20500",
"Country": "US"
}
}
]
})
headers = {
'Content-Type': 'application/json',
'Authorization': '<ACCESS_TOKEN>'
}
conn.request("PUT", "/v2.0.0/business/updatedba", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "<APIURL>/v2.0.0/business/updatedba");
request.Headers.Add("Authorization", "<ACCESS_TOKEN>");
var content = new StringContent("{
"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"
}
}
]
}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
require "uri"
require "json"
require "net/http"
url = URI("<APIURL>/v2.0.0/business/updatedba")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "<ACCESS_TOKEN>"
request.body = JSON.dump({
"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": nil,
"City": "Washington",
"ProvinceOrState": "DC",
"ZipCd": "20500",
"Country": "US"
}
}
]
})
response = http.request(request)
puts response.read_body
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{
"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"
}
}
]
}");
Request request = new Request.Builder()
.url("<APIURL>/v2.0.0/business/updatedba")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "<ACCESS_TOKEN>")
.build();
Response response = client.newCall(request).execute();
curl --location --request PUT '<APIURL>/v2.0.0/business/updatedba' --header 'Content-Type: application/json' --header 'Authorization: <ACCESS_TOKEN>' --data '{
"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"
}
}
]
}'