ListDBA

GET Business/ListDBA 

Request Params

Field	Type	Description
BusinessId	Guid	Unique Identifier of the business.
PayerRef	string	Unique identifier of a Payer.
TIN	string	Gets the TIN number of the business
TINType	string	Gets the TIN type of the business
Page	number	Pulls the records listed in the page selected.
PageSize	number	Number 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

Field	Type	Description
StatusCode	number	Returns the status codes like 200, 300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message
BusinessId	Guid	Unique Identifier of a business
DBADetails	object[]	Pulls DBA detail records with Success and Error statuses.
DBAName	string	Name of the DBA.
DBARef	string	Unique identifier for each DBA. This identifier can be used in future references of the DBA in the API.
DBAId	string	Unique Identifier for the DBA.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	if IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality). Size Range: ..46
Address2	string	Optional Employer/Payer's suite or apartment. Size Range: ..46
City	string	Employer/Payer's city. Size Range: ..50
State	string	Employer/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"
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	object	if IsForeign is true, pass foreign address of the business.
Address1	string	Address of the Employer/Payer (street address or post office box of that locality) Size Range: ..50
Address2	string	OptionalEmployer/Payer's suite or apartment. Size Range: ..50
City	string	Employer/Payer's city. Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name. Size Range: ..50
Country	string	Employer/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"
PostalCd	string	Employer/Payer's postal code. Size Range: ..16
TotalRecords	number	Total number of records.
TotalPages	number	Total number of pages.
Page	number	Pulls the records listed in the page selected.
PageSize	number	Number of records to be listed in each page.
Error	object	Shows detailed error information.
Name	string	Name of the validation error.
ID	string	Returns the validation error ID.
Message	string	Description 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
}