Get

Get

Use this endpoint to retrieve the information of a previously created new hire reports for the corresponding business. Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms. If you need to retrieve the report of a specific employee, you can provide the EmployeeId or EmpRef.

GET NewHire/Employee/Get 

Run in Postman

Request Body

Field	Type	Description
State	string	Employer/Payer's state code.
BusinessId	string	Unique Identifier of the business.
EIN	string	Employer Identification Number of business.
PayerRef	string	Unique identifier of the payer. Set by the client in the endpoint Business/RequestByUrl.
SubmissionId	Guid	Mention the NewHire returns Submission ID that you want to Get the records.
RecordIds	Guid[]	Mention the NewHire returns Record ID that you want to Get the records. Multiple RecordIds under the same Submission can be received by sending the RecordIds comma separated.
EmployeeId	string	Optional TaxBandits generates a unique ID for each employee after the return is created and returned in the Response.
EmpRef	string	Optional A unique identifier for each employee completing their information.

Response Body

Field	Type	Description
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
ReturnHeader	object	Identifies the supporting details of New Hire Form
Business	object	Business Details
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits), you received in the response of the Business CREATE Endpoint. If you have do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
BusinessNm	string	Name of the business
PayerRef	string	An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API.
TradeNm	string	Name under which the business operates
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	When IsEIN is true, Employer Identification Number (EIN). When IsEIN is false, Social Security Number (SSN)
Email	string	Email address of the Business
ContactNm	string	Name of the person who can be contacted by the IRS
Phone	string	Contact number of the business with area code
PhoneExtn	string	Extension of the business phone number
Fax	string	Fax number of the Business
BusinessType	string	Type of business.
KindOfEmployer	string	Identifies the kind of employer.
KindOfPayer	string	Identifies the kind of payer.
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	Employer/Payer's US address (street or post office box of that locality)
Address2	string	Employer/Payer's suite or apartment
City	string	Employer/Payer's city
State	string	Employer/Payer's state code.
ZipCd	string	Employer/Payer's zip code
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality)
Address2	string	Employer/Payer's suite or apartment
City	string	Employer/Payer's city
ProvinceOrStateNm	string	Employer/Payer's province or state name
Country	string	Employer/Payer's country
PostalCd	string	Employer/Payer's postal code
SequenceId	string	A unique number given by an inbound application to identify records.
EmployeeId	string	TaxBandits generates a unique ID for each employee after the return is created and returned in the Response. You can use this id for your future reference to update.
EmpRef	string	A unique identifier for each employee completing their information. This identifier can be used in future references of the payee in the API.
SSN	string	Social Security Number of the employee
FirstNm	string	First Name of the Employee
MiddleNm	string	Middle Name of the Employee
LastNm	string	Last Name of the Employee
Suffix	string	Suffix of the employee
IsForeign	Boolean	When true, identify the employee address with a foreign address.
USAddress	object	If IsForeign is false, pass the US address of the employee
Address1	string	Employee's US address (street address or post office box of that locality)
Address2	string	Employee's suite or apartment
City	string	Employee's city
State	string	Employee's state code. Refer Static values.
ZipCd	string	Employee's zip code
ForeignAddress	object	If IsForeign is true, pass the foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality)
Address2	string	Employee's suite or apartment
City	string	Employee's city.
ProvinceOrStateNm	string	Employee's Province or State Name.
Country	string	Employee's country code. Refer Static values.
PostalCd	string	Employee's Postal Code.
DOB	string	Employee's date of birth
HireDate	string	Employee's hire date
ReportingState	string	Reporting state.

Request Params

"newhire/Employee/Get?State=SC&BusinessId=07e6d7d9-5463-43d2-a272-14dc563cb5e0&EIN=001687743&PayerRef=Payer123&SubmissionId=01993cc2-65a7-749f-ae9f-11228a524981&EmployeeId=0362eb49-3e28-481b-a411-5065da25b49e&EmpRef=2344&RecordId=019933de-47c4-755a-86a2-360622d62634"

Response Json

200

Success Response - This is a sample response for successful API requests.

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "01993cc2-65a7-749f-ae9f-11228a524981",
  "ReturnHeader": {
      "Business": {
          "BusinessId": "07e6d7d9-5463-43d2-a272-14dc563cb5e0",
          "BusinessNm": "SnowDaze Tech LLC",
          "PayerRef": null,
          "FirstNm": null,
          "MiddleNm": null,
          "LastNm": null,
          "Suffix": null,
          "TradeNm": null,
          "IsEIN": true,
          "EINorSSN": "00-1687743",
          "Email": "john@sample.com",
          "ContactNm": "John",
          "Phone": "(789) 456-1231",
          "PhoneExtn": "12345",
          "Fax": "(712) 354-7895",
          "BusinessType": null,
          "SigningAuthority": null,
          "KindOfEmployer": null,
          "KindOfPayer": null,
          "IsBusinessTerminated": false,
          "IsForeign": false,
          "USAddress": {
              "Address1": "12 Main st",
              "Address2": "CC avenue",
              "City": "Rock Hill",
              "State": "SC",
              "ZipCd": "29730"
          },
          "ForeignAddress": null,
          "ACADetails": null
      }
  },
  "ReturnData": {
      "EmployeeDetails": [
          {
              "SequenceId": "1",
              "RecordId": "01993cc2-67a6-72ba-91d7-3e21e6ed3310",
              "EmployeeId": "b3a91620-d26c-421e-95c6-1176522f105a",
              "EmpRef": "2344",
              "SSN": "001-45-6924",
              "FirstNm": "John",
              "MiddleNm": "L",
              "LastNm": "Smith",
              "Suffix": "II",
              "IsForeign": false,
              "USAddress": {
                  "Address1": "12 Main st",
                  "Address2": "CC avenue",
                  "City": "Rock Hill",
                  "ZipCd": "29730",
                  "State": "SC",
                  "Country": "US"
              },
              "ForeignAddress": null,
              "DOB": "11/11/2002",
              "HireDate": "07/21/2025",
              "ReportingState": "SC"
          }
      ]
  },
  "Errors": null
}

400

Bad Request Response - You'll get the below response when your API requests contain any validation errors.

{
  "StatusCode": "400",
  "StatusName": "BadRequest",
  "StatusMessage": "Validation error has occurred",
  "SubmissionId": null,
  "ReturnHeader": null,
  "ReturnData": null,
  "Errors": [
      {
          "Id": "S00-000301",
          "Name": "BusinessId",
          "Message": "Invalid BusinessId"
      }
  ]
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
  "StatusCode": 401,
  "StatusName": "Unauthorized",
  "StatusMessage": "Invalid authorization credentials",
  "Errors": [
      {
          "Id": "AUTH-100018",
          "Name": "Authorization",
          "Message": "JWT EXPIRED"
      }
  ]
}