Skip to main content
Version: 2.0

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

Request Body

FieldTypeDescription
RecipientIdGUIDTaxBandits-generated unique identifier for the recipient.
PayeeRefStringYour unique identifier for the recipient.
TINStringTIN number of the recipient.
TINTypeStringTIN type of the recipient.
DBAIdGUIDOptional Filter by a specific DBA identifier.
DBARefStringOptional Filter by your DBA reference.
PagenumberPage number to retrieve. Starts at 1.
PageSizenumberNumber of DBA records per page. Maximum: 100

Response Body

FieldTypeDescription
RecipientIdGUIDTaxBandits-generated unique identifier for the recipient.
PayeeRefStringYour unique identifier for the recipient.
DBADetailsObject []DBA details of the recipient.
DBANmStringName of the DBA.
DBARefStringYour unique identifier for the DBA.
DBAIdGUIDTaxBandits-generated unique identifier for the DBA.
AddressObjectThe address details of the DBA.
Address1StringStreet address or post office box of the DBA.
Address2StringDBA's suite or apartment.
CityStringDBA's city.
ProvinceOrStateStringDBA's province or state name.
ZipCdStringDBA's zip code.
CountryStringDBA's country.
CreatedTsStringDate and time the DBA was created.
LastUpdatedTimeStringDate and time the DBA was last updated.
PagenumberRequested page number.
PageSizenumberRequested page size.
TotalRecordsnumberTotal number of DBA records for this recipient.
TotalPagesnumberTotal number of pages available.
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

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

Response JSON

{
"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
}