Skip to main content
Version: 1.7.3

Status

Status

This endpoint can be used to retrieve the filing and distribution status of transmitted W2C correction forms.

Webhooks Configuration

As an alternative to this method, you can configure webhooks for the following event types to receive automated notifications.

  • E-file Status Change (Federal) – Triggered when the IRS accepts or rejects your W2C Correction. Learn More
  • E-file Status Change (State) – Triggered when the state agency accepts or rejects your W2C Correction. Learn More
  • Postal Mailing Sent – Triggered when the recipient copy of the W2C correction form has been mailed. Learn More
  • Online Access Status Change - Triggered when the recipient copy of the W2C correction form is shared online, when the recipient provides consent, or when they access the form. Learn More

Statuses available​

The following are the different types of status codes available for the filing and distribution of W2C correction forms.

Federal filing​

  • CREATED - W2C correction has been created and has not yet been transmitted.
  • TRANSMITTED - W2C correction has been transmitted by the user.
  • SENT TO AGENCY - W2C correction has been sent to the IRS, and we are waiting for the result from the IRS.
  • ACCEPTED - W2C correction has been accepted by the IRS.
  • REJECTED - W2C correction has been rejected by the IRS due to some errors. You must correct the errors and retransmit the forms.

Postal Mailing​

  • CREATED - Postal mailing enabled for the corrected forms.
  • SENT - Corrected form copies are mailed to the recipients.
  • RECEIVED - Corrected form copies are received by the recipients.
  • NOTCREATED - Postal mailing wasn't opted. To opt for postal mailing, the 'IsPostalMailing' in the submission manifest of the ‘Create’ request must be set to TRUE.

Online Access​

  • CREATED - Online Access opted for the corrected forms, and the secure link to download form copies will be emailed to the recipients as soon as the form is transmitted.
  • ORDER_CREATED - An order for online access has been received, and the email will be sent to the recipient soon.
  • EMAIL_SENT - A secure link to download form copies has been emailed to the recipients.
  • DOWNLOADED_FORM - The recipient successfully viewed and downloaded the form.
  • VIEWED_FORM - The recipient has successfully viewed the form.
GET FormW2C/Status
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]Number of record Ids to get status.

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
FormW2CRecordsobjectPulls the Form W-2C records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2C Records
        SequenceIdstringAn 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a W2C return is created.
        EmployeeIdGuidAn unique identifier generated by TaxBandits for a employee when a W2C return is created. You can use this id for your future reference to Update.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
        StateReturnsobject[]Returns collection of state returns information
            StateCdstringReturns the state code of the state for which the return is filed.
            StatusstringReturns the record status of the state return.
            StatusTsstringDate and time of the return created.
            InfostringReturns the information about the state for which we are not supporting state filing.
            Errorsobject[]Shows error information of state returns of Form W2C
                IdstringReturns the validation error Id.
                NamestringName of the validation error.
                MessagestringDescription of the validation error.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W2C.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns the Status of the Online Access.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2C Records.
        SequenceIdstringAn 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.
        RecordIdGuidUnique 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​

Get status with only the SubmissionID

"FormW2C/Status?SubmissionId=02c563d8-7bad-489c-8914-03ee1275516f"

Response JSON​

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

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "02c563d8-7bad-489c-8914-03ee1275516f",
  "BusinessId": "3e24271f-824e-4776-bbf4-82c15a513c28",
  "FormW2cRecords": {
      "SuccessRecords": [
          {
              "SequenceId": "20",
              "PrevReportedRecordId": null,
              "RecordId": "218713ae-0d3f-4391-9d79-7f48665ec005",
              "EmployeeId": "e6bcd2b2-241a-43e6-be52-935afaa38e2b",
              "PayeeRef": “1234,
              "FederalReturn": {
                  "Status": "CREATED",
                  "StatusTs": "2025-07-07 07:47:26 -04:00",
                  "Info": null,
                  "Errors": null
              },
              "StateReturns": [
                  {
                      "StateCd": "IL",
                      "Status": "Created",
                      "StatusTs": "2025-07-04 04:21:06 -04:00",
                      "Info": null,
                      "Errors": null
                  },
                  {
                      "StateCd": "GA",
                      "Status": "Created",
                      "StatusTs": "2025-07-07 07:18:23 -04:00",
                      "Info": null,
                      "Errors": null
                  }
              ],
              "Postal": {
                  "Status": "CREATED",
                  "StatusTs": "2025-07-07 07:47:26 -04:00",
                  "Info": null
              },
              "OnlineAccess": {
                  "Status": "NOT_CREATED",
                  "Email": null,
                  "Info": null
              }
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}