Skip to main content
Version: 1.7.3

ListDBA

GET Business/ListDBA 

Request Params

FieldTypeDescription
BusinessIdGuidUnique Identifier of the business.
PayerRefstringUnique identifier of a Payer.
TINstringGets the TIN number of the business
TINTypestringGets the TIN type of the business
PagenumberPulls the records listed in the page selected.
PageSizenumberNumber of records to be listed in each page.

Request Params

"Business/ListDBA?BusinessID=203b32af-6a5d-4faa-91f9-adad5753fa5f&PayerRef=67235223sh&TIN=567890543&TINType=EIN&Page=1&PageSize=10"

Response Body

FieldTypeDescription
StatusCodenumberReturns the status codes like 200, 300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message
BusinessIdGuidUnique Identifier of a business
DBADetailsobject[]Pulls DBA detail records with Success and Error statuses.
  DBANamestringName of the DBA.
  DBARefstringUnique identifier for each DBA. This identifier can be used in future references of the DBA in the API.
  DBAIdstringUnique Identifier for the DBA.
    IsForeignBooleanWhen true, identifies the business address with a foreign address.
    USAddressobjectif IsForeign is false, pass US address of the business
        Address1stringEmployer/Payer's US address (street address or post office box of that locality).
Size Range: ..46
        Address2stringOptional Employer/Payer's suite or apartment.
Size Range: ..46
        CitystringEmployer/Payer's city.
Size Range: ..50
        StatestringEmployer/Payer's state code. Refer Static values.
Size Range: 2
Allowed values

"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", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

        ZipCdstringEmployer/Payer's zip code.
Size Range: 5..10
    ForeignAddressobjectif IsForeign is true, pass foreign address of the business.
        Address1stringAddress of the Employer/Payer (street address or post office box of that locality)
Size Range: ..50
        Address2stringOptionalEmployer/Payer's suite or apartment.
Size Range: ..50
        CitystringEmployer/Payer's city.
Size Range: ..50
        ProvinceOrStateNmstringEmployer/Payer's province or state name.
Size Range: ..50
        CountrystringEmployer/Payer's country.
Size Range: 2
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"

        PostalCdstringEmployer/Payer's postal code.
Size Range: ..16
  TotalRecordsnumberTotal number of records.
  TotalPagesnumberTotal number of pages.
  PagenumberPulls the records listed in the page selected.
  PageSizenumberNumber of records to be listed in each page.
ErrorobjectShows detailed error information.
    NamestringName of the validation error.
    IDstringReturns the validation error ID.
    MessagestringDescription of the validation error.

Response JSON

Success Response - This is a sample response for successful API requests.

{
"StatusCode": 200,
"StatusName": "OK",
"StatusMessage": "Successful API Call",
"BusinessId": "203b32af-6a5d-4faa-91f9-adad5753fa5f",
"DBADetails": [
{
"DBAName": "Snowdaze LLC",
"DBARef": "db123",
"DBAId": "566e1623-3c07-4d15-9fcc-00cad9a3a5d5",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": null
},
{
"DBAName": "Snowdaze LLC",
"DBARef": "db123",
"DBAId": "566e1623-3c07-4d15-9fcc-00cad9a3a5d5",
"IsForeign": false,
"USAddress": {
"Address1": "1751 Kinsey Rd",
"Address2": "Main St",
"City": "Dothan",
"State": "AL",
"ZipCd": "36303"
},
"ForeignAddress": null
}
],
"TotalRecords": 2,
"TotalPages": 1,
"Page": 1,
"PageSize": 10,
"Error": null
}