Get

Use this endpoint to obtain the details of a created business, such as the name, address, and contact details. In the request JSON, you must provide either the BusinessId or PayerRef.

GET Business/Get 

Request Params

Field	Type	Description
BusinessId	string	Unique Identifier of the business.
TIN	string	Taxpayer Identification Number of business.
PayerRef	string	Optional Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.

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
Business	object	Business Details
BusinessId	Guid	Unique Identifier of the business.
PayerRef	string	Unique identifier of the payer. Set by the client.
BusinessNm	string	Name of the business
FirstNm	string	First Name of the Individual
MiddleNm	string	Middle Name of the Individual
LastNm	string	Last Name of the Individual
Suffix	string	Suffix of the Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
TradeNm	string	Optional Name under which the business operates
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
IsDefaultBusiness	Boolean	When set true, this business will be set as the default business.
Email	string	Optional Email address of the Business
ContactNm	string	Optional Name of the person who can be contacted by the IRS
Phone	string	Optional Contact number of the business with area code
PhoneExtn	string	Optional Extension number of the business phone number
Fax	string	Optional Fax number of the Business
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series
SigningAuthority	object	Details of the person who is authorized to sign the return.
Name	string	Optional Name of the signing authority.
Phone	string	Optional Phone number of the authorized signatory.
BusinessMemberType	string	Optional Business title of the authorized signatory.
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series
KindOfPayer	string	Identifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X series
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
Form1042SDetails	object	Chapter 3 and chapter 4 status code details of the busienss. Mandatory for 1042-S and optional for 1099 and 94X series
WHAgtCh3Cd	string	Chapter 3 status code of Withholding agent Size Range: 2 Allowed values "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "35", "36", "37", "38", "39"
WHAgtCh4Cd	string	Chapter 4 status code of Withholding agent Size Range: 2 Allowed values "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50"
WHAgtGIIN	string	Optional Withholding agent’s Global Intermediary Identification Number (GIIN) Size Range: ..15
FTIN	string	Optional FTIN of Withholding agent
Country	string	Optional Withholding agent'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"
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	Address of the Employer/Payer (street address or post office box of that locality)
Address2	string	Optional Suite or apartment number of the Employer/Payer.
City	string	City where the Employer/Payer is based out of
State	string	Name of the state where the Employer/Payer is based out of
ZipCd	string	Zip Code the State where the Employer/Payer is based out of. 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)
Address2	string	Optional Suite or apartment number of the Employer/Payer.
City	string	City where the Employer/Payer is based out of
ProvinceOrStateNm	string	Name of the province or state where the Employer/Payer is based out of.
Country	string	Country of the Employer/Payer.
PostalCd	string	Postal Code the State where the Employer/Payer is based out of
Errors	object[]	Shows detailed error information.
Code	string	Returns the validation error code.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
Type	string	Type of validation error.

Request Params

"Business/Get?BusinessId=519a84f4-5e56-496a-82f3-18f51fdf3d75&TIN=10-7310999&PayerRef=Snow123"

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "Business": {
    "BusinessNm": "Snowdaze LLC",
    "FirstNm": null,
    "MiddleNm": null,
    "LastNm": null,
    "Suffix": null,
    "PayerRef": "Snow123",
    "TradeNm": "Iceberg Icecreams",
    "IsDefaultBusiness": true,
    "IsEIN": true,
    "EINorSSN": "23-3456789",
    "Email": "james@sample.com",
    "ContactNm": "James Smith",
    "Phone": "6534567890",
    "PhoneExtn": "123",
    "Fax": "9834567890",
    "BusinessType": "ESTE",
    "SigningAuthority": {
      "Name": "James Smith",
      "Phone": "9934567890",
      "BusinessMemberType": "ADMINISTRATOR"
    },
    "KindOfEmployer": "FEDERALGOVT",
    "KindOfPayer": "REGULAR941",
    "IsBusinessTerminated": false,
    "Form1042SDetails": {
      "WHAgtCh3Cd": "11",
      "WHAgtCh4Cd": "16",
      "WHAgtGIIN": null,
      "FTIN": "12345",
      "Country": "AL"
    },
    "IsForeign": false,
    "USAddress": {
      "Address1": "3576 AIRPORT WAY",
      "Address2": "UNIT 9",
      "City": "FAIRBANKS",
      "State": "AK",
      "ZipCd": "99709"
    },
    "ForeignAddress": null
  },
  "ACADetails": null,
  "Errors": null
}

Node.js

Python

Java

.NET C#