Version: 2.0.0

Get

Retrieves the W-2G Correction return information based on the Submission ID given in the request.

GET FormW2GCorrection/get

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	An unique identifier generated by TaxBandits when a W-2G return is created. Mention the Form W-2G return's Submission ID that you want to get.
RecordId	Guid[]	An unique identifier generated by TaxBandits when a W-2G return is created. Mention the Form W-2G return's Record ID that you want to get.

Response Body

Field	Type	Description
FormW2GRecords	object[]	Contains information about Form W-2G correction returns.
SubmissionManifest	object[]	SubmissionManifest provides brief information about a particular submission as a whole.
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission.
TaxYear	string	Tax year of Form W-2G Correction filed.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Unique identifier of the business generated by TaxBandits.
PayerRef	string	Your unique identifier for the payer.
TINDetails	object	Returns the TIN information for the business
Format	string	Returns the format of the TIN passed.
TINType	string	Returns the TIN type of the business.
TIN	string	Returns the TIN value according to the Format selected.
IndividualNm	object	Returns the individual's name details when the TIN type of the business is "SSN".
FirstNm	string	The first name of the individual.
MiddleNm	string	Middle name of the individual.
LastNm	string	The last name of the individual.
Suffix	string	Suffix of the individual's name.
BusinessNm	string	Legal name of the business. Required when TINType is EIN.
NameCtrl	string	IRS name control of the business.
DBADetails	object[]	DBA (Doing Business As) information.
DBANm	string	Name of the DBA.
DBARef	string	Unique identifier for the DBA.
DBAId	GUID	Unique identifier of the DBA generated by TaxBandits.
IsDefaultDBA	Boolean	Identifies whether the DBA is designated as the default DBA.
Address	object[]	Returns address information of DBA.
Address1	string	Street address or PO Box.
Address2	string	Suite or apartment number.
City	string	DBA's city.
ProvinceOrStateNm	string	DBA's province or state name.
ZipCd	string	DBA's ZIP code.
Country	string	DBA's 2-character country code.
Email	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.
ProvinceOrStateNm	string	Province or state name of the business.
ZipCd	string	ZIP code of the business.
Country	string	2-character country code of the business.
ContactDetails	object[]	Returns details of the person the IRS can contact regarding this 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.
Email	string	Email address of the contact person.
Fax	string	Fax number of the contact person.
ReturnData	object[]	Contains information about the recipient details and Form W-2G correction details.
SequenceId	string	A unique reference ID for the submission that can be used to identify a particular record.
ReturnManifest	object[]	Returns a high-level summary of a return, including information about the postal service, federal filing, state filing, and recipient copy distribution configurations and correction details associated with the return.
IsFederal	Boolean	Identifies whether Federal filing is enabled for the return.
IsState	Boolean	Identifies whether State filing is enabled for the return.
IsDistribution	Boolean	Identifies whether Recipient distribution is enabled for the return.
DistributionDetails	object[]	Returns recipient distribution configuration details.
DistributionType	string	Recipient copy distribution type.
PostalType	string	Returns postal service type.
CorrectionDetails	Object	Returns information required to identify the correction type for the Form W-2G return.
FederalCorrectionType	String	Returns type of correction for federal filing you are filing for the recipient.
PrevReportedRecordId	Guid	Returns the previously reported Record ID filed with TaxBandits.
OriginalFilingMethod	String	Returns the filing method used to submit the Form W-2G return to the IRS.
IRISUniqueIds	Object	Gets the IRIS unique identifiers associated with the previously filed original return.
UTID	String	Returns the Unique Transmission Identifier (UTID) used to track the original return.
ReceiptId	String	Returns an identifier that confirms IRIS received the transmission.
SubmissionId	String	Returns an identifier that represents a specific submission within a transmission.
RecordId	String	Returns an identifier that represents an Individual return within a submission.
PrevReportedRecipientData	object	Returns recipient information that was submitted in the Original Form W-2G.
RecipientId	Guid	Unique identifier of the recipient generated by TaxBandits.
PayeeRef	string	Your unique identifier for the recipient.
TINDetails	object	Retruns recipient TIN information.
Format	string	Returns the format of the TIN passed.
TINType	string	Returns the TIN type of the recipient.
TIN	string	Returns the TIN value according to the Format selected.
IndividualNm	Object	Returns the individual's name details when the TIN type of the recipient is "SSN".
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 recipient business. Required when TINType is EIN.
NameCtrl	string	IRS name control of the recipient.
CorrectRecipientData	object	Returns corrected Recipient Name and TIN value.
TINDetails	object	Recipient TIN information.
Format	string	Returns the format of the TIN passed.
TINType	string	Returns the TIN type of the recipient.
TIN	string	Returns the TIN value according to the Format selected.
IndividualNm	Object	Returns the individual's name details when the TIN type of the recipient is "SSN".
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 recipient business. Required when TINType is EIN.
NameCtrl	string	IRS name control of the recipient.
Address	Object	Primary address of the recipient.
Address1	String	Street address or PO Box of the recipient.
Address2	String	Suite or apartment number of the recipient.
City	String	City of the recipient.
ProvinceOrState	String	Province or state name of the recipient.
ZipCd	String	ZIP code of the recipient.
Country	String	2-character country code of the recipient.
W2GFormData	object	Recipient's Form W-2G information.
ReportableWinnings	Number	Enter the Reportable winning amount. Size Range: 0–9999999999.99
DateWon	Number	Enter the date of the winning event in the format: MM/DD/YYYY or MM-DD-YYYY Example: 01/25/2026 or 01-25-2026.
WagerType	String	Enter the type of wager Allowed values "HORSE_RACETRACK", "DOG_RACETRACK", "JAI_ALAI", "STATE_CONDUCTED_LOTTERY","KENO", "BINGO", "SLOT_MACHINES", "POKER_WINNINGS","ANY_OTHER_TYPE_OF_GAMBLING_WINNINGS", “SPORTS_WAGERING”
FedTaxWH	Number	Enter any federal income tax withheld, whether regular gambling withholding or backup withholding. Size Range: 0–9999999999.99 Note: This value should be less than 40% of box 1.
Txn	String	Enter the ticket or card number (and color, if applicable), machine serial number, other identifying number or any other information that will help identify the winning transaction. Size Range: 15
Race	String	Enter the race (or game) relating to the winning ticket. Size Range: 5
WinningsIdWagers	Number	Enter the amount of additional winnings from identical wagers. Size Range: 0-9999999999.99
Cashier	String	Enter the initials or number of the cashier making the winning payment. Size Range: 5
Window	String	Enter the window number or location of the person paying the winning payment. Size Range: 5
FirstId	String	Enter the first identification number of the person receiving the winning payment. Size Range: 15
SecondId	String	Enter the second identification number of the person receiving the winnings. Size Range: 15
States	object[]	List of state filing details.
StateCorrectionType	String	Specify the type of state correction you are filing. Allowed values VOID - The state filing was submitted incorrectly and should not have been processed CORRECTION - Used to correct previously reported amounts or codes NEW - Used to add new state information that was not included in the original filing. Note: To update a previously filed state, you must first indicate the original state as VOID, then add the new state using the NEW correction type.
StateCd	string	2-character state code. Allowed values "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"
StateIdNum	string	Payer’s state identification number. Size Range: ..20
StateWinnings	Number	Enter the Reportable state winning amount. Size Range: 0-9999999999.99
StateWH	number	State income tax withheld. Size Range: 0-9999999999.99
LocalWinnings	Number	Enter the Reportable Local winning amount. Size Range: 0-9999999999.99
LocalWH	number	Local income tax withheld. Size Range: 0-9999999999.99
LocalityNm	number	Name of the Locality. Size Range: 0-9999999999.99

Payload

Request Params

Sample	Description	Action
Sample 1	Use the SubmissionId alone to get the full submission, or include RecordId to get a specific record.

Sample 1

FormW2GCorrection/get?SubmissionId=f561a414-c92f-4026-9c29-71cd1979bf72&RecordIds=71cd1979bf72-f561a414-c92f-4026-9c29

Response JSON

Response	Description	Action
200	Success Response - This is a sample response for successful API requests.
401	Unauthorized Response - This is a sample response when the access token is missing, expired, or invalid.

Response: 200

{
  "FormW2GRecords": {
    "SubmissionManifest": {
      "SubmissionId": "c672df52-6d1e-45ba-8631-aff8339d7fa3",
      "TaxYear": "2026"
    },
    "ReturnHeader": {
      "Business": {
        "BusinessId": null,
        "PayerRef": "Snow123",
        "TINDetails": {
          "Format": "PLAIN_TIN",
          "TINType": "EIN",
          "TIN": "12-0239751"
        },
        "IndividualNm": null,
        "BusinessNm": "Horizon LLC",
        "NameCtrl": "HORI",
        "DBADetails": null,
        "Email": "horizonllc@sample.com",
        "Address": {
          "Address1": "2500 Horizon Parkway",
          "Address2": "Suite 200",
          "City": "Plano",
          "ProvinceOrState": "TX",
          "ZipCd": "75024",
          "Country": "US"
        },
        "ContactDetails": {
          "FirstNm": "Michael",
          "MiddleNm": "A",
          "LastNm": "Carter",
          "Suffix": "Jr",
          "Phone": "9725550100",
          "PhoneExtn": "205",
          "Email": "michael.carter@sample.com",
          "Fax": "9725550199"
        }
      }
    },
    "ReturnData": [
      {
        "SequenceId": "1",
        "ReturnManifest": {
          "IsFederal": true,
          "IsState": true,
          "IsDistribution": true,
          "DistributionDetails": {
            "DistributionType": "POSTAL_ONLY",
            "PostalType": "USPS_FIRST_CLASS"
          },
          "CorrectionDetails": {
            "FederalCorrectionType": "RECIPIENT",
            "PrevReportedRecordId": null,
            "OriginalFilingMethod": "IRIS",
            "IRISUniqueIds": {
              "UTID": "37f44812-b4ed-4255-aba2-afc13a56493a:IRIS:DB7RM::A",
              "ReceiptId": "2024-65384464963-c12b927aa",
              "SubmissionId": "66522383",
              "RecordId": "98517992"
            }
          }
        },
        "PrevReportedRecipientData": {
          "RecipientId": null,
          "PayeeRef": "DAI001",
          "TINDetails": {
            "Format": "PLAIN_TIN",
            "TINType": "EIN",
            "TIN": "45-9875461"
          },
          "NameCtrl": null,
          "BusinessNm": "Dairy Delights LLC",
          "IndividualNm": {
            "FirstNm": "David",
            "MiddleNm": "R",
            "LastNm": "Thompson",
            "Suffix": "Jr"
          }
        },
        "CorrectRecipientData": {
          "TINDetails": {
            "Format": "PLAIN_TIN",
            "TINType": "SSN",
            "TIN": "597-85-6598"
          },
          "IndividualNm": {
            "FirstNm": "Davidson",
            "MiddleNm": "R",
            "LastNm": "Thompson",
            "Suffix": "Jr"
          },
          "BusinessNm": null,
          "NameCtrl": null,
          "DBADetails": null,
          "Address": {
            "Address1": "1450 Oak Lawn Avenue",
            "Address2": "Apt 310",
            "City": "Dallas",
            "ProvinceOrState": "TX",
            "ZipCd": "75207",
            "Country": "US"
          },
          "Email": "david.thompson@example.com",
          "Fax": "9725550199",
          "Phone": "9725550100"
        },
        "W2GFormData": {
          "ReportableWinnings": 50000.65,
          "DateWon": "02/15/2026",
          "WagerType": "DOG_RACETRACK",
          "FedTaxWH": 500.82,
          "Txn": null,
          "Race": "Horse",
          "WinningsIdWagers": 700.89,
          "Cashier": null,
          "Window": 12345,
          "FirstId": "DL123456789",
          "SecondId": "PP987654321",
          "States": [
            {
              "StateCorrectionType": "NEW",
              "StateCd": "CA",
              "StateIdNum": "123456789",
              "StateWinnings": 1000.56,
              "StateWH": 100.28,
              "LocalWinnings": 300.23,
              "LocalWH": 100.45,
              "LocalityNm": "Los Angeles"
            }
          ]
        },
        "Errors": null
      }
    ]
  }
}

W-9/W-8 Automation

1099 Automation

TIN Matching

W-2 Automation

941/940 Automation

1098-T Automation

ACA Automation

Extension Automation

1042-S Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Healthcare Market Research Platforms

Get

Get

Request Params

Response Body

Sample 1

Response: 200