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 IndividualAllowed 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. |
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. |
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
- Sample Requests
Business/Get?BusinessId=519a84f4-5e56-496a-82f3-18f51fdf3d75&TIN=10-7310999&PayerRef=Snow123
Response JSON
{
"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,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
},
"ACADetails": null,
"Errors": null
}
Sample Codes
![Node.js logo](/assets/images/NodeJs_Logo-d7be5ca971768c79cbefb0a0484b7ad9.png)
Node.js
![Python logo](/assets/images/Python_Logo-bdc7e23ce0582de93a1372d7337078ae.png)
Python
![Java logo](/assets/images/Java_Logo-5b127694b5c2cf78dfc5ee999c0977ea.png)
Java
![.NET C# logo](/assets/images/Dotnet_Logo-83ae0f1f2b82df8aa3af2e3c3602bbee.png)
.NET C#