Skip to main content
Version: 2.0.0

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 

Request Body

FieldTypeDescription
StatestringEmployer/Payer's state code.
BusinessIdstringUnique Identifier of the business.
EINstringEmployer Identification Number of business.
PayerRefstringOptional An unique identifier for each payer completing their information. This identifier can be used in future references to the payer in the API.
Size Range: ..50
SubmissionIdGuidMention the NewHire returns Submission ID that you want to Get the records.
RecordIdsGuid[]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.
EmployeeIdstringOptional TaxBandits generates a unique ID for each employee after the return is created and returned in the Response.
EmployeeRefstringOptional A unique identifier for each employee completing their information.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
ReturnHeaderobjectIdentifies the supporting details of New Hire Form
BusinessobjectObject to identify the Business Details.
PayerRefStringYour unique identifier for the payer. Can replace BusinessId in future requests.
BusinessIdGuidBusiness ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint.
IsDefaultBusinessBooleanWhen set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetailsObjectTIN information for the business.
FormatStringSpecifies how the TIN is passed.
TINTypeStringThe TIN type of the business.
TINStringThe TIN value, formatted according to the Format field selected.
IndividualNmObjectRequired when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNmStringThe first name of the individual.
MiddleNmStringThe middle name of the individual.
LastNmStringThe last name of the individual.
SuffixStringThe suffix of the individual's name.
BusinessNmStringLegal name of the business.
NameCtrlStringName control of the business as registered with the IRS.
DBADetailsObjectDBA (Doing Business As) information.
DBANmStringName of the DBA.
DBARefStringThe unique identifier for this DBA.
DBAIdGUIDTaxBandits-generated DBA identifier. Returned in the response.
AddressObjectAddress information of DBA.
Address1StringStreet address or PO Box.
Address2StringSuite or apartment number.
CityStringDBA's city.
ProvinceOrStateStringDBA's province or state name.
ZipCdStringDBA's ZIP code.
CountryStringDBA's country code.
EmailStringEmail address of the business
AddressObjectPrimary address of the business.
Address1StringStreet address or PO Box of the business.
Address2StringSuite or apartment number of the business.
CityStringCity of the business.
ProvinceOrStateStringProvince or state name of the business.
ZipCdStringZip code of business.
CountryString2-character country code of the business.
SigningAuthorityObjectDetails of the person authorized to sign the return. Mandatory for 94x forms.
FirstNmStringFirst name of the signatory.
MiddleNmStringMiddle name of the signatory.
LastNmStringLast name of the signatory.
SuffixStringThe suffix of the signatory.
PhoneStringPhone number of the signatory
PhoneExtnStringPhone extension number of the signatory.
BusinessMemberTypeStringTitle or role of the signatory.
ContactDetailsobject[]Details of the person the IRS can contact regarding the given business.
FirstNmstringFirst name of the contact person.
MiddleNmstringMiddle name of the contact person.
LastNmstringLast name of the contact person.
SuffixstringThe suffix of the contact person
PhonestringPhone number of the contact person.
PhoneExtnstringPhone extension number.
FaxstringFax number of the contact person.
ReturnDatastringAccount number of the employee
EmployeeDetailsobject[]Data of the newhire employee
AccoutNumberBooleanAccount number of the employer
StateEINstringState Employer Identification of the employer.
IsEmployeeRegisteredInMultipleStateobjectWhen true, identifies that the employer is reporting as a registered multistate employer.
EmployeeSequenceIdstringA unique number given by an inbound application to identify records.
EmployeeIdstringTaxBandits 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.
EmployeeRefstringA unique identifier for each employee completing their information. This identifier can be used in future references of the payee in the API.
SSNstringSocial Security Number of the employee
FirstNmstringFirst Name of the Employee
MiddleNmstringMiddle Name of the Employee
LastNmstringLast Name of the Employee
SuffixstringSuffix of the employee
GenderstringGender of the employee
AddressObjectAddress information of DBA.
Address1StringStreet address or PO Box.
Address2StringSuite or apartment number.
CityStringDBA's city.
ProvinceOrStateStringDBA's province or state name.
ZipCdStringDBA's ZIP code.
CountryStringDBA's 2-character country code.
DOBstringEmployee's date of birth.
HireDatestringEmployee's hire date.
ReportingStatestringReporting state.
IsHealthInsuranceBooleanWhen true, identifies that the employee has medical insurance.
IsEmployeeIndependentContractorBooleanWhen true, identifies that the employee is an independent contractor.
EmployeeSalaryNumberEmployee's salary
SalaryFrequencystringEmployee's Frequency
Errorsobject[]Shows detailed error information
IdstringReturns the validation error ID
NamestringName of the validation error
MessagestringDescription of the validation error

Request Params

newhire/Employee/Get?State=NJ&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

{
"StatusCode": "200",
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "01993cc2-65a7-749f-ae9f-11228a524981",
"ReturnHeader": {
"Business": {
"BusinessNm": "Snowdaze LLC",
"TradeNm": "Keystone Mfg",
"IsEIN": true,
"PayerRef": "Keystone123",
"EINorSSN": "236789128",
"Email": "info@keystonemfg.com",
"ContactNm": "Michael Turner",
"Phone": "7175554821",
"PhoneExtn": "101",
"Fax": "7175554899",
"BusinessType": "ESTE",
"SigningAuthority": {
"Name": "John",
"Phone": "1231231232",
"BusinessMemberType": "OWNER"
},
"KindOfEmployer": "NONGOVT501C",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "1500 Market Street",
"Address2": "Suite 1200",
"City": "Philadelphia",
"State": "PA",
"ZipCd": "19102"
}
}
},
"ReturnData": {
"EmployeeDetails": [
{
"RecordId": "019d6c14-a6fd-74bc-a5d1-aad311a62466",
"AccountNumber": "001775343",
"StateEIN": "4569875621",
"IsEmployerRegisteresdMultipleState": true,
"EmployerSequenceId": "1",
"EmployeeId": null,
"EmployeeRef": "2344",
"SSN": "001456924",
"FirstNm": "Henry",
"MiddleNm": null,
"LastNm": "Smith",
"Suffix": null,
"IsForeign": false,
"USAddress": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"State": "SC",
"ZipCd": "29730"
},
"ForeignAddress": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"ProvinceOrStateNm": "SC",
"Country": "CA",
"PostalCd": "29730"
},
"DOB": "10/12/1992",
"HireDate": "07/21/2025",
"ReportingState": "NJ",
"IsHealthInsurance": true,
"IsEmployeeIndependentContractor": true,
"HiredState": "AZ",
"EmployeeSalary": "8000",
"SalaryFrequency": "Monthly"
}
]
},
"Errors": null
}