Skip to main content
Version: 2.0.0

Status

Status

This endpoint can be used to retrieve the status of W-2 returns transmitted via the TaxBandits API. Provide the SubmissionId and RecordId, and the response will return the status of federal filing, state filing, postal mailing, and online access.

Federal Filing

  • CREATED - The form has been created but not yet transmitted.
  • TRANSMITTED - The form has been transmitted by the user.
  • SENT_TO_AGENCY - The form has been sent to the SSA, and a result is pending.
  • ACCEPTED - The form has been accepted by the SSA.
  • REJECTED - The form has been rejected by the SSA due to errors. The user must correct the errors and retransmit.
  • YET_TO_RETRANSMIT - The rejected form has been updated and is pending retransmission to the SSA.

State Filing

  • CREATED - The form has been created but not yet transmitted.
  • NOT_CREATED - The form hasn't been created because state filing wasn't opted for.
  • TRANSMITTED - The form has been transmitted by the user.
  • SENT_TO_AGENCY - The form has been sent to the state DOR, and a result is pending.
  • ACCEPTED - The form has been accepted by the state DOR.
  • REJECTED - The form has been rejected by the state DOR.

Postal Mailing

  • CREATED - Postal mailing has been opted for.
  • SENT - Form copies have been mailed to the employee.
  • RECEIVED - Form copies have been received by the employee.
  • NOT_CREATED - Postal mailing wasn't opted for. To enable it, set IsPostalMailing to TRUE in the submission manifest of the Create request.

Online Access

  • CREATED - Online Access has been opted for; a secure download link will be emailed to the employee once the form is transmitted.
  • ORDER_CREATED - Online Access has been opted for; a secure download link will be emailed to the employee once the form is transmitted.Be sent shortly.
  • EMAIL_SENT - A secure link to download the form has been emailed to the employee.
  • VIEWED_FORM - The employee has viewed the form.
  • DOWNLOADED_FORM - The employee has viewed and downloaded the form.
GET FormW2/Status 

Request Body

FieldTypeDescription
SubmissionIdGuidA unique identifier of a submission.
RecordIdsGuidA unique identifier generated by TaxBandits when a return's is created. Mention the return RecordId for which you want to get the status.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier generated for the submission.
FormTypestringDenotes the type of the form.
FormW2Recordsobject[]Returns the status of processed records along with their federal, state, and distribution statuses.
RecordIdGuidUnique identifier generated for the submitted tax form record.
FederalStatusobjectReturns the federal filing status details for the record.
CodestringStatus code representing the federal filing result.
StatusstringCurrent status of the federal filing (for example, ACCEPTED, REJECTED).
MessagestringDetailed description of the federal filing status.
StatusTsstringDate and time when the federal filing status was last updated.
StateStatusobjectReturns the filing status details for each state where the return was filed.
StateCdstringTwo-letter state code for the filing jurisdiction.
CodestringStatus code representing the state filing result.
StatusstringCurrent filing status for the specified state.
MessagestringDetailed description of the state filing status.
StatusTsstringDate and time when the state filing status was last updated.
DistributionobjectReturns the distribution details for the employee copy of the form.
DistributionTypestringSpecifies the distribution method used to deliver the employee copy (for example, POSTAL_AND_ONLINE).
PostalStatusobjectReturns the postal delivery status information.
PostalTypestringSpecifies the postal delivery service used (for example, USPS_FIRST_CLASS).
CodestringStatus code representing the postal delivery status.
StatusstringCurrent postal delivery status (for example, ASSUMED_DELIVERED, IN_TRANSIT).
MessagestringDetailed description of the postal delivery status.
StatusTsstringDate and time when the postal delivery status was last updated.
OnlineAccessStatusobjectReturns the online access status information for the employee.
EmailstringEmail address provided for employee online access.
CodestringStatus code representing the online access status.
StatusstringCurrent status of online access (for example, VIEWED_FORM, EMAIL_SENT).
MessagestringDetailed description of the online access status.
StatusTsstringDate and time when the online access status was last updated.
Errorsobject[]Returns top-level validation or processing errors. Returns null when the request is processed successfully.
IdstringValidation or processing error code.
NamestringName of the field or validation rule that caused the error.
MessagestringDetailed description of the error and guidance for resolving it.
ErrorRecordsobject[]It will show the detailed information about the error status of the Form 1099-NEC Records.
SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. The SequenceId will be returned in the response for your reference.
RecordIdGuidA unique identifier of a record.
Errorsobject[]Shows detailed error information.
IdstringReturns the validation error ID.
NamestringName of the validation error.
MessagestringDescription of the validation error.
Errorsobject[]Shows detailed error information.
IdstringReturns the validation error ID.
NamestringName of the validation error.
MessagestringDescription of the validation error.
Request Params
SampleDescriptionAction
Sample 1
Query Params - Get status using SubmissionId and RecordIds.
Sample 1
formw2/status?submissionId=f47ac10b-58cc-4372-a567-0e02b2c3d479&recordIds=cfd6fe66-ac9f-49f7-b8a3-2d064abeeb9b
Response JSON
ResponseDescriptionAction
200
Success Response - This is a sample response for successful API requests.
Response: 200
{
"SubmissionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"FormType": "FormW2",
"FormW2Records": [
{
"RecordId": "cfd6fe66-ac9f-49f7-b8a3-2d064abeeb9b",
"FederalStatus": {
"Code": "FED-002",
"Status": "ACCEPTED",
"Message": "Accepted by IRS",
"StatusTs": "2026-01-25T11:42:00-05:00"
},
"StateStatus": [
{
"StateCd": "AZ",
"Code": "ST-001",
"Status": "ACCEPTED",
"Message": "Accepted by AZ",
"StatusTs": "2026-01-25T11:43:00-05:00"
}
],
"Distribution": {
"DistributionType": "POSTAL_AND_ONLINE",
"PostalStatus": {
"PostalType": "USPS_FIRST_CLASS",
"Code": "POS-006",
"Status": "DELIVERED",
"Message": "Stamped delivered by USPS",
"StatusTs": "2026-01-30T16:00:00-05:00"
},
"OnlineAccessStatus": {
"Email": "shawn@sample.com",
"Code": "OA-004",
"Status": "VIEWED_FORM",
"Message": "Recipient viewed the form",
"StatusTs": "2026-01-25T15:00:00-05:00"
}
}
}
],
"Errors": null
}