Status

Status

Use this endpoint to retrieve the status of your new hire reports that are submitted to the states. Your request JSON must include the submissionId and the RecordIds of the reports you want to retrieve the status for.

GET NewHire/Employee/Status 

Run in Postman

Request Params

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
BusinessId	Guid	Unique Identifier of the business
PayerRef	string	Unique identifier of the payer.
SuccessRecords	object[]	It will show the detailed information about the success status of NewHire Form Records.
SequenceId	string	A unique number given by an inbound application to identify failed records.
RecordId	Guid	Unique identifier of a record.
EmployeeId	Guid	Unique Identifier of the business
EmpRef	string	Unique identifier of the payer.
ReportingState	string	Reporting state. Refer Static values.
Status	string	Returns the status of the records.
StatusTs	string	Returns date and time of return created.
Info	string	Returns information about the Federal Filing service.
Errors	object[]	Shows error information of state returns of New Hire form
Id	string	Returns the validation error Id.
Name	string	Name of the validation error.
Message	string	Description of the validation error.
ErrorRecords	object[]	It will show the detailed information about the error status of NewHire Form Records.
SequenceId	string	An unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference.
RecordId	Guid	Unique identifier of a record
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
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/Status?State=SC&BusinessId=08631c17-564c-433d-a3ea-ff7f6f3ff1e6&EIN=123456789&PayerRef=Payer123&SubmissionId=01993c59-8621-77cb-8e74-f044c5d6ed70&EmployeeId=f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e&EmpRef=Emp001&RecordIds=f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e"

Response JSON

200

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

{
  "StatusCode": "200",
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SuccessRecords": [
      {
          "SequenceId": "1",
          "BusinessId": "07e6d7d9-5463-43d2-a272-14dc563cb5e0",
          "PayerRef": null,
          "EmployeeId": "b3a91620-d26c-421e-95c6-1176522f105a",
          "EmpRef": "2344",
          "RecordId": "01993cc2-67a6-72ba-91d7-3e21e6ed3310",
          "ReportingState": "SC",
          "Status": "TRANSMITTED",
          "StatusTs": "2025-09-12 03:14:03 -04:00",
          "Info": null,
          "Errors": null
      }
  ],
  "ErrorRecords": null,
  "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",
  "SuccessRecords": null,
  "ErrorRecords": null,
  "Errors": [
      {
          "Id": "S00-000097",
          "Name": "SubmissionId",
          "Message": "SubmissionId is required."
      }
  ]
}

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"
      }
  ]
}