Skip to main content
Version: 1.7.3

Get

Get

This endpoint retrieves the complete details of a specific business — including name, TIN information, address, contact details, and any form-specific fields. Use this to verify business data or retrieve details for display in your application.

Identify the business using its BusinessId, PayerRef, or TIN.

GET Business/Get 

Request Params

FieldTypeDescription
BusinessIdstringUnique Identifier of the business.
TINstringTaxpayer Identification Number of business.
PayerRefstringOptional Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.

Response Body

FieldTypeDescription
StatusCodenumberReturns the status codes like 200,300 etc.
StatusNamestringName of the status code.
StatusMessagestringDetailed status message
BusinessobjectBusiness Details
BusinessIdGuidUnique Identifier of the business.
PayerRefstringUnique identifier of the payer. Set by the client.
BusinessNmstringName of the business
FirstNmstringFirst Name of the Individual
MiddleNmstringMiddle Name of the Individual
LastNmstringLast Name of the Individual
SuffixstringSuffix of the Individual
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

TradeNmstringOptional Name under which the business operates
IsEINBooleanWhen true, identifies the business with an EIN.
EINorSSNstringWhen IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN)
IsDefaultBusinessBooleanWhen set true, this business will be set as the default business.
EmailstringOptional Email address of the Business
ContactNmstringOptional Name of the person who can be contacted by the IRS
PhonestringOptional Contact number of the business with area code
PhoneExtnstringOptional Extension number of the business phone number
FaxstringOptional Fax number of the Business
BusinessTypestringType of business. Optional for W-2/1099 and mandatory for 94X series
SigningAuthorityobjectDetails of the person who is authorized to sign the return.
NamestringOptional Name of the signing authority.
PhonestringOptional Phone number of the authorized signatory.
BusinessMemberTypestringOptional Business title of the authorized signatory.
KindOfEmployerstringIdentifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series
KindOfPayerstringIdentifies the kind of payer. Mandatory for W-2 and optional for 1099-MISC and 94X series
IsBusinessTerminatedBooleanWhen true, identifies the business as terminated.
Form1042SDetailsobjectChapter 3 and chapter 4 status code details of the busienss. Mandatory for 1042-S and optional for 1099 and 94X series
WHAgtCh3CdstringChapter 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"

WHAgtCh4CdstringChapter 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"

WHAgtGIINstringOptional Withholding agent’s Global Intermediary Identification Number (GIIN)
Size Range: ..15
FTINstringOptional FTIN of Withholding agent
CountrystringOptional 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"

IsForeignBooleanWhen true, identifies the business address with a foreign address.
USAddressobjectif IsForeign is false, pass US address of the business
Address1stringAddress of the Employer/Payer (street address or post office box of that locality)
Address2stringOptional Suite or apartment number of the Employer/Payer.
CitystringCity where the Employer/Payer is based out of
StatestringName of the state where the Employer/Payer is based out of
ZipCdstringZip Code the State where the Employer/Payer is based out of.
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)
Address2stringOptional Suite or apartment number of the Employer/Payer.
CitystringCity where the Employer/Payer is based out of
ProvinceOrStateNmstringName of the province or state where the Employer/Payer is based out of.
CountrystringCountry of the Employer/Payer.
PostalCdstringPostal Code the State where the Employer/Payer is based out of
Errorsobject[]Shows detailed error information.
IdstringReturns the validation error Id.
NamestringName of the validation error.
MessagestringDescription of the validation error.
Request Params
"Business/Get?BusinessId=519a84f4-5e56-496a-82f3-18f51fdf3d75&TIN=10-7310999&PayerRef=Snow123"
Response Json
SampleDescriptionAction
200
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Business": {
"BusinessId": "17e1efa1-37b8-4ace-89e9-877fe749b64e",
"PayerRef": "B123",
"BusinessNm": "ABC LLC",
"TradeNm": "Kodak",
"IsEIN": true,
"EINorSSN": "003313330",
"Email": "sample@bodeem.com",
"ContactNm": "John",
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "(123) 456-7890",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1234567890",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": "FEDERALGOVT",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": true,
"USAddress": {
"Address1": null,
"Address2": null,
"City": null,
"State": null,
"ZipCd": null
},
"ForeignAddress": {
"Address1": "22 St",
"Address2": "Clair Ave E",
"City": "Toronto",
"ProvinceOrStateNm": " Ontario",
"Country": "CA",
"PostalCd": "M1R 0E9"
},
"ACADetails": {
"FirstName": "Aafdir",
"MiddleName": "Walman",
"LastName": "ADMINRATOR",
"Suffix": "jr",
"Phone": "8834578906",
"IsGovernmentalUnit": true
}
},
"Errors": null
}