ListDBA

ListDBA

This endpoint retrieves all DBA names associated with a specific recipient. Results are paginated. Use the Page and PageSize parameters to control how many records are returned per request.

GET recipient/listdba

Run in Postman

Request Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
TIN	String	TIN number of the recipient.
TINType	String	TIN type of the recipient.
DBAId	GUID	Optional Filter by a specific DBA identifier.
DBARef	String	Optional Filter by your DBA reference.
Page	number	Page number to retrieve. Starts at 1.
PageSize	number	Number of DBA records per page. Maximum: 100

Response Body

Field	Type	Description
RecipientId	GUID	TaxBandits-generated unique identifier for the recipient.
PayeeRef	String	Your unique identifier for the recipient.
DBADetails	Object []	DBA details of the recipient.
DBANm	String	Name of the DBA.
DBARef	String	Your unique identifier for the DBA.
DBAId	GUID	TaxBandits-generated unique identifier for the DBA.
Address	Object	The address details of the DBA.
Address1	String	Street address or post office box of the DBA.
Address2	String	DBA's suite or apartment.
City	String	DBA's city.
ProvinceOrState	String	DBA's province or state name.
ZipCd	String	DBA's zip code.
Country	String	DBA's country.
CreatedTs	String	Date and time the DBA was created.
LastUpdatedTime	String	Date and time the DBA was last updated.
Page	number	Requested page number.
PageSize	number	Requested page size.
TotalRecords	number	Total number of DBA records for this recipient.
TotalPages	number	Total number of pages available.
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

Request Params

Sample	Description	Action
Sample 1	List DBA records for a recipient using RecipientId, PayeeRef, and pagination.

Sample 1

recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001

Response JSON

Response	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.
401	Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

Response: 200

{
  "RecipientId": "d67539c3-0603-4fb7-9a29-3ae15339269a",
  "PayeeRef": "PAYEE001",
  "DBADetails": [
    {
      "DBANm": "Sunrise Tech Solutions Inc.",
      "DBARef": "STS001",
      "DBAId": "9425a051-a2b9-4cf9-b853-e56246464b3f",
      "Address": {
        "Address1": "123 Biscayne Blvd",
        "Address2": "Suite 120",
        "City": "Miami",
        "ProvinceOrState": "FL",
        "ZipCd": "33132",
        "Country": "US"
      },
      "CreatedTime": "2026-07-09 06:46:40 -04:00",
      "LastUpdatedTime": "2026-07-09 06:46:40 -04:00"
    },
    {
      "DBANm": "Smith Consulting",
      "DBARef": "SC001",
      "DBAId": "a32b351f-00b6-4639-a1ec-835b10ee8dae",
      "Address": {
        "Address1": "4500 N Lamar Blvd",
        "Address2": "Suite 210",
        "City": "Austin",
        "ProvinceOrState": "TX",
        "ZipCd": "78756",
        "Country": "US"
      },
      "CreatedTime": "2026-07-08 07:36:04 -04:00",
      "LastUpdatedTime": "2026-07-08 07:36:04 -04:00"
    }
  ],
  "Page": 1,
  "PageSize": 100,
  "TotalRecords": 2,
  "TotalPages": 1,
  "Errors": null
}

Go Lang

package main

import (
    "fmt"
    "io"
    "net/http"
    "strings"
)

func main() {
    url := "<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001"
    method := "GET"

    payload := strings.NewReader(``)

    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))
}

Node.js

const axios = require('axios');
let data = '';

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: '<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001',
  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);
});

Python

import http.client
import json

conn = http.client.HTTPSConnection("<APIURL>")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Authorization': '<ACCESS_TOKEN>'
}
conn.request("GET", "/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

.NET C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001");
request.Headers.Add("Authorization", "<ACCESS_TOKEN>");
var content = new StringContent("", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Ruby

require "uri"
require "json"
require "net/http"

url = URI("<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "<ACCESS_TOKEN>"

response = http.request(request)
puts response.read_body

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001")
  .method("GET", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "<ACCESS_TOKEN>")
  .build();
Response response = client.newCall(request).execute();

cURL

curl --location '<APIURL>/v2.0.0/recipient/listdba?recipientId=d67539c3-0603-4fb7-9a29-3ae15339269a&payeeref=PAYEE001' --header 'Content-Type: application/json' --header 'Authorization: <ACCESS_TOKEN>' --data ''