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
| 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 | Optional 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 |
| 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. |
| EmployeeRef | 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 | Object to identify the Business Details. |
| PayerRef | String | Your unique identifier for the payer. Can replace BusinessId in future requests. |
| BusinessId | Guid | Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. |
| IsDefaultBusiness | Boolean | When set to TRUE, this business will be set as the default across requests that do not specify a business. |
| TINDetails | Object | TIN information for the business. |
| Format | String | Specifies how the TIN is passed. |
| TINType | String | The TIN type of the business. |
| TIN | String | The TIN value, formatted according to the Format field selected. |
| IndividualNm | Object | Required when TINType is SSN. Provide individual name fields instead of BusinessNm. |
| FirstNm | String | The first name of the individual. |
| MiddleNm | String | The middle name of the individual. |
| LastNm | String | The last name of the individual. |
| Suffix | String | The suffix of the individual's name. |
| BusinessNm | String | Legal name of the business. |
| NameCtrl | String | Name control of the business as registered with the IRS. |
| DBADetails | Object | DBA (Doing Business As) information. |
| DBANm | String | Name of the DBA. |
| DBARef | String | The unique identifier for this DBA. |
| DBAId | GUID | TaxBandits-generated DBA identifier. Returned in the response. |
| Address | Object | Address information of DBA. |
| Address1 | String | Street address or PO Box. |
| Address2 | String | Suite or apartment number. |
| City | String | DBA's city. |
| ProvinceOrState | String | DBA's province or state name. |
| ZipCd | String | DBA's ZIP code. |
| Country | String | DBA's country code. |
| String | Email address of the business | |
| Address | Object | Primary address of the business. |
| Address1 | String | Street address or PO Box of the business. |
| Address2 | String | Suite or apartment number of the business. |
| City | String | City of the business. |
| ProvinceOrState | String | Province or state name of the business. |
| ZipCd | String | Zip code of business. |
| Country | String | 2-character country code of the business. |
| SigningAuthority | Object | Details of the person authorized to sign the return. Mandatory for 94x forms. |
| FirstNm | String | First name of the signatory. |
| MiddleNm | String | Middle name of the signatory. |
| LastNm | String | Last name of the signatory. |
| Suffix | String | The suffix of the signatory. |
| Phone | String | Phone number of the signatory |
| PhoneExtn | String | Phone extension number of the signatory. |
| BusinessMemberType | String | Title or role of the signatory. |
| ContactDetails | object[] | Details of the person the IRS can contact regarding the given business. |
| FirstNm | string | First name of the contact person. |
| MiddleNm | string | Middle name of the contact person. |
| LastNm | string | Last name of the contact person. |
| Suffix | string | The suffix of the contact person |
| Phone | string | Phone number of the contact person. |
| PhoneExtn | string | Phone extension number. |
| Fax | string | Fax number of the contact person. |
| ReturnData | string | Account number of the employee |
| EmployeeDetails | object[] | Data of the newhire employee |
| AccoutNumber | Boolean | Account number of the employer |
| StateEIN | string | State Employer Identification of the employer. |
| IsEmployeeRegisteredInMultipleState | object | When true, identifies that the employer is reporting as a registered multistate employer. |
| EmployeeSequenceId | 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. |
| EmployeeRef | 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 |
| Gender | string | Gender of the employee |
| Address | Object | Address information of DBA. |
| Address1 | String | Street address or PO Box. |
| Address2 | String | Suite or apartment number. |
| City | String | DBA's city. |
| ProvinceOrState | String | DBA's province or state name. |
| ZipCd | String | DBA's ZIP code. |
| Country | String | DBA's 2-character country code. |
| DOB | string | Employee's date of birth. |
| HireDate | string | Employee's hire date. |
| ReportingState | string | Reporting state. |
| IsHealthInsurance | Boolean | When true, identifies that the employee has medical insurance. |
| IsEmployeeIndependentContractor | Boolean | When true, identifies that the employee is an independent contractor. |
| EmployeeSalary | Number | Employee's salary |
| SalaryFrequency | string | Employee's Frequency |
| Errors | object[] | Shows detailed error information |
| Id | string | Returns the validation error ID |
| Name | string | Name of the validation error |
| Message | string | Description 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
}