Skip to main content
Version: 1.7.0

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 
Run in Postman

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.

Request Params

Get the Business data of an Employer/Payer using BusinessID along with TIN and PayerRef.

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

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
Size Range: ..20
    MiddleNmstringMiddle Name of the Individual
Size Range: ..20
    LastNmstringLast Name of the Individual
Size Range: ..20
    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)
    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.
    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.
    CodestringReturns the validation error code.
    NamestringName of the validation error.
    MessagestringDescription of the validation error.
    TypestringType of validation error.

Response JSON

The response will have the completed Business information for the given PayerRef corresponding to the BusinessId and TIN.

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Business": {
"BusinessId": "69b9461c-c107-41d4-9582-1ef544a4a961",
"PayerRef": "Snow123",
"BusinessNm": null,
"FirstNm": "James",
"MiddleNm": null,
"LastNm": "Smith",
"Suffix": null,
"TradeNm": "Iceberg Icecreams",
"IsEIN": false,
"EINorSSN": "XXX-XX-0999",
"Email": "james@sample.com",
"ContactNm": "James Smith",
"Phone": "8708620033",
"PhoneExtn": "91",
"Fax": "(345) 455-3465",
"BusinessType": "PART",
"SigningAuthority": {
"Name": "James Smith",
"Phone": "(986) 532-1550",
"BusinessMemberType": "MANAGINGMEMBER"
},
"KindOfEmployer": "NONGOVT501C",
"KindOfPayer": "RAILROADFORMCT1",
"IsBusinessTerminated": false,
"Form1042SDetails": {
"WHAgtCh3Cd": null,
"WHAgtCh4Cd": null,
"WHAgtGIIN": null,
"FTIN": null,
"Country": "US"
},
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": {
"Address1": null,
"Address2": null,
"City": null,
"ProvinceOrStateNm": null,
"Country": null,
"PostalCd": null
},
"ACADetails": null
},
"Errors": null
}