Skip to main content
Version: 1.7.3

Status

Status

This endpoint can be used to retrieve the filing and distribution status of transmitted Form W2G 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 Form W2G. Learn More
  • E-file Status Change (State) – Triggered when the state agency accepts or rejects your Form W2G. Learn More
  • Postal Mailing Sent – Triggered when the recipient copy of the Form W2G form has been mailed. Learn More
  • Online Access Status Change - Triggered when the recipient copy of the Form W2G 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 Form W2G forms.

Federal filing​

  • CREATED - Form W2G has been created and has not yet been transmitted.
  • TRANSMITTED - Form W2G has been transmitted by the user.
  • SENT TO AGENCY - Form W2G has been sent to the IRS, and we are waiting for the result from the IRS.
  • ACCEPTED - Form W2G has been accepted by the IRS.
  • REJECTED - Form W2G has been rejected by the IRS due to some errors. You must correct the errors and retransmit the forms.
  • ACCEPTEDWITHERRORS - The IRS has accepted the return with some validation errors, and a correction must be filed as soon as possible with the correct information.
  • YET_TO_RETRANSMIT – Updates have been made to the rejected form, and it is pending retransmission to the IRS.

State filing​

  • CREATED - Form W2G (State) has been created and has not yet been transmitted
  • NOTCREATED - Form W2G (State) has not been created since state filing hasn’t been opted.
  • TRANSMITTED - Form W2G (State) has been transmitted by the user.
  • SentToAgency - Form W2G (State) has been sent to the state DOR, and awaiting result.
  • ACCEPTED - Form W2G is accepted by the state DOR.
  • REJECTED - Form W2G is rejected by the state DOR.
  • YET_TO_RETRANSMIT – Updates have been made to the rejected form, and it is pending retransmission to the IRS.

Postal mailing​

  • CREATED - Postal mailing enabled for Form W2G forms.
  • SENT - Form W2G form copies are mailed to the recipients.
  • RECEIVED - Form W2G 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 Form W2G 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 FormW2G/Status
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]List of record Ids to get the status of Form W2-G.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
Form1099TypestringDenotes the type of 1099 form.
Form1099RecordsobjectPulls Form W-2G records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W-2G 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 W-2G return is created.
        RecipientIdGuidAn unique identifier generated by TaxBandits for a Recipient when a W-2G return is created. You can use this id for your future reference to Update.
        PayeeRefstringA unique identifier for each payee completing their information.
        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.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form W-2G.
            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 status of online access for Form W-2G return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W-2G 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

"Formw2G/Status?SubmissionId=1abc3bc8-a3dc-499e-9e28-f25c0c458f32"

Response JSON​

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

{
  "StatusCode": 200,
  "StatusName": "Ok",
  "StatusMessage": "Successful API call",
  "SubmissionId": "0562f158-def1-45cb-973e-c3109605375f",
  "BusinessId": "64f0b21e-c062-4721-ade2-f9194ed3a862",
  "PayerRef": "Pe1234",
  "Form1099Type": "W2G",
  "Form1099Records": {
      "SuccessRecords": [
          {
              "SequenceId": "1",
              "RecordId": "8da3046e-3270-491e-ae2d-674ad277fec4",
              "RecipientId": "30f876b8-80d8-4db3-9330-8e1c0109f127",
              "PayeeRef": null,
              "FederalReturn": {
                  "Status": "CREATED",
                  "StatusTs": "2025-10-23 08:39:03 -04:00",
                  "Info": null,
                  "Errors": null
              },
              "StateReturns": {
                  "StateCd": "CA",
                  "Status": "CREATED",
                  "StatusTs": "2025-10-23 08:39:03 -04:00",
                  "Info": null,
                  "Errors": null
              },
              "Postal": {
                  "Status": "CREATED",
                  "StatusTs": "2025-10-23 08:39:03 -04:00",
                  "Info": null
              },
              "OnlineAccess": {
                  "Status": "CREATED",
                  "Email": "mark+32@sample.com",
                  "Info": null
              },
              "ScheduleFiling": null
          }
      ],
      "ErrorRecords": null
  },
  "Errors": null
}