Get
Get
Retrieves the W-2C return information based on the Submission ID given in the request.
GET formw2c/get Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | An unique identifier generated by TaxBandits when a W-2C return is created. Mention the Form W-2 return's Submission ID that you want to get. |
| RecordId | Guid[] | An unique identifier generated by TaxBandits when a W-2C return is created. Mention the Form W-2C return's Record ID that you want to get. |
Response Body
| Field | Type | Description |
|---|---|---|
| FormW2CRecords | object[] | Contains information about Form W-2C 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-2C 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[] | Optional DBA (Doing Business As) information. |
| DBANm | string | Name of the DBA. |
| DBARef | string | Unique identifier for the DBA. |
| DBAId | Guid | TaxBandits-generated DBA identifier. |
| Address | object[] | Address information of the DBA. |
| Address1 | string | Street address or PO Box. |
| Address2 | string | Suite or apartment number. |
| City | string | DBA’s city. |
| ProvinceOrState | string | DBA's province or state name. |
| Zipcd | string | DBA’s ZIP code. |
| Country | string | DBA’s 2-character country code. |
| Address | object | Primary address of the business. |
| Address1 | string | Primary address of the business |
| Address2 | string | Street address or PO Box of the business. |
| City | string | City of the business. |
| ProvinceOrState | 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 SSA 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. |
| string | Email address of the contact person. | |
| Fax | string | Fax number of the contact person. |
| ReturnData | object[] | Contains information about the employee details and Form W-2C details. |
| SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. |
| RecordId | string | A unique identifier of the record |
| ReturnManifest | object[] | Returns a high-level summary of a return, including information about the postal service, federal filing, state filing, and employee 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 employee distribution is enabled for the return |
| DistributionDetails | object | Returns employee distribution configuration details |
| DistributionType | string | Employee copy distribution type. |
| PostalType | string | Returns postal service type |
| CorrectionDetails | object | Returns information required to identify the correction type for the Form W-2C return |
| PrevReportedRecordId | Guid | Record ID of the original Form W-2 |
| IsEmployeeSSNNameCorrection | Boolean | When True, Identifies that you are correcting the SSN or Name of the employee. |
| PrevReportedemployeeData | object | Object containing the employeeinformation that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId. |
| EmployeeId | Guid | Optional A unique ID generated by TaxBandits after the employee is created and will be returned in the Response. |
| PayeeRef | string | Optional Your unique identifier for the employee. |
| TINDetails | object | Employee TIN information. |
| Format | string | Returns the format of the TIN passed. |
| TINType | string | Returns the TIN type of the employee. |
| 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 employee 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 employee business. Required when TINType is EIN. |
| NameCtrl | string | Name control of the business as registered with the IRS. |
| DBADetails | object | DBA (Doing Business As) information. |
| DBAId | Guid | TaxBandits-generated DBA identifier. Returned in the response. |
| DBANm | string | Name of the DBA. |
| DBARef | string | Your unique identifier for this DBA. |
| Address | object | Address information of the DBA. |
| Address1 | string | Street address or PO Box. |
| Address2 | string | Suite or apartment number. |
| City | string | DBA's city. |
| ProvinceOrState | string | DBA's province or state name. |
| ZipCd | string | DBA's ZIP code. |
| Country | string | DBA's 2-character country code. |
| DOB | string | Date of Birth of the employee. |
| Address | object | Primary address of the employee. |
| Address1 | string | Street address or PO Box of the employee. |
| Address2 | string | Suite or apartment number of the employee. |
| City | string | City of the employee. |
| ProvinceOrState | string | Province or state name of the employee. |
| ZipCd | string | ZIP code of the employee. |
| Country | string | 2-character country code of the employee. |
| string | Email address of the employee. | |
| Fax | string | Fax number of the employee. |
| Phone | string | Phone number of the employee. |
| CorrectEmployeeData | object | Enter the corrected Employee Name and SSN value. This Object is required, when the IsEmployeeSSNNameCorrection is true. The object should be "null", when the IsEmployeeSSNNameCorrection is false. |
| PayeeRef | string | Your unique identifier for the employee. |
| TINDetails | object | Employee TIN information. |
| Format | string | Returns the format of the TIN passed |
| TINType | string | Returns the TIN type of the employee. |
| 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 employee is "SSN". |
| FirstNm | string | The first name of the individual. |
| MiddleNm | string | Optional The middle name of the individual. |
| LastNm | string | The last name of the individual. |
| Suffix | string | Optional The suffix of the individual's name. |
| string | Email address of the employee. | |
| PrevReportedW2FormData | object | Employee's previously reported Form W-2C information. |
| Wages | number | Previously reported Wages, Tips, Other Compensation. |
| FedTaxWH | number | Previously reported Federal Income Tax Withheld. |
| SocSecWages | number | Previously reported Social Security Wages. |
| SocSecTaxWH | number | Previously reported Social Security Tax Withheld. |
| MediWages | number | Previously reported Medicare Wages and Tips. |
| MediTaxWH | number | Previously reported Medicare Tax Withheld. |
| SocSecTips | number | Previously reported Social Security Tips. |
| AllocatedTips | number | Previously reported Allocated Tips. |
| DependtCareBenefits | number | Previously reported Dependent Care Benefits. |
| Sec457Plan | number | Previously reported Nonqualified Plans, Section 457 portion. |
| NonSec457Plan | number | Previously reported Nonqualified Plans, Non-Section 457 portion. |
| CompCode1 | string | Previously reported Compensation Code 1. |
| CompAmt1 | number | Previously reported Amount for Code 1. |
| CompCode2 | string | Previously reported Compensation Code 2. |
| CompAmt2 | number | Previously reported Amount for Code 2. |
| CompCode3 | string | Previously reported Compensation Code 3. |
| CompAmt3 | number | Previously reported Amount for Code 3. |
| CompCode4 | string | Previously reported Compensation Code 4. |
| CompAmt4 | number | Previously reported Amount for Code 4. |
| IsStatEmp | boolean | Previously reported Statutory Employee indicator. |
| IsRetPlan | boolean | Previously reported Retirement Plan indicator. |
| Is3rdPartySickPay | boolean | Previously reported Third-Party Sick Pay indicator. |
| Other | string | Previously reported Other Free-form text used to report items such as state PFL / PML, union dues, etc. |
| TTOC1 | string | Previously reported Treasury Tipped Occupation Code #1 — identifies the Employee's qualifying tipped occupation. New for TY 2026 — supports OBBBA No-Tax-on-Tips reporting. — supports OBBBA No-Tax-on-Tips reporting. |
| TTOC2 | string | Previously reported Treasury Tipped Occupation Code #2 — secondary qualifying tipped occupation, if applicable. New for TY 2026. |
| ControlNum | string | Previously reported Control Number assigned by the Employer to uniquely identify the W-2C. |
| State | object [] | Previously reported State filing data — Boxes 15–20. |
| StateCd | string | Box 15 — Two-letter State Code. |
| StateIdNum | string | Box 15 — Employer's State ID Number. |
| StateWages | number | Box 16 — State Wages, Tips, etc. |
| StateTax | number | Box 17 — State Income Tax. |
| LocalityData | object | Boxes 18–20 — Local income / locality information. |
| LocalWages | number | Box 18 — Local Wages, Tips, etc. |
| LocalTax | number | Box 19 — Local Income Tax. |
| LocalityNm | string | Box 20 — Locality Name. |
| County | string | County name (used in states where county-level reporting is required). |
| TaxTypeCd | string | Tax Type Code identifying the type of local tax being reported. |
| SchoolDistrictNum | string | School District Number (required for certain Ohio / Pennsylvania filings). |
| CorrectedW2FormData | object | Employee's corrected Form W-2C information. |
| Wages | number | Enter the corrected Wages, Tips, Other Compensation. |
| FedTaxWH | number | Enter the corrected Federal Income Tax Withheld. |
| SocSecWages | number | Enter the corrected Social Security Wages. |
| SocSecTaxWH | number | Enter the corrected Social Security Tax Withheld. |
| MediWages | number | Enter the corrected Medicare Wages and Tips. |
| MediTaxWH | number | Enter the corrected Medicare Tax Withheld. |
| SocSecTips | number | Enter the corrected Social Security Tips. |
| AllocatedTips | number | Enter the corrected Allocated Tips. |
| DependtCareBenefits | number | Enter the corrected Dependent Care Benefits. |
| Sec457Plan | number | Enter the corrected Nonqualified Plans, Section 457 portion. |
| NonSec457Plan | number | Enter the corrected Nonqualified Plans, Non-Section 457 portion. |
| CompCode1 | string | Enter the corrected Compensation Code 1. |
| CompAmt1 | number | Enter the corrected Amount for Code 1. |
| CompCode2 | string | Enter the corrected Compensation Code 2. |
| CompAmt2 | number | Enter the corrected Amount for Code 2. |
| CompCode3 | string | Enter the corrected Compensation Code 3. |
| CompAmt3 | number | Enter the corrected Amount for Code 3. |
| CompCode4 | string | Enter the corrected Compensation Code 4. |
| CompAmt4 | number | Enter the corrected Amount for Code 4. |
| IsStatEmp | boolean | Enter the corrected Statutory Employee indicator. |
| IsRetPlan | boolean | Enter the corrected Retirement Plan indicator. |
| Is3rdPartySickPay | boolean | Enter the corrected Third-Party Sick Pay indicator. |
| Other | string | Enter the corrected Other Free-form text used to report items such as state PFL / PML, union dues, etc. |
| TTOC1 | string | Enter the corrected Treasury Tipped Occupation Code #1 — identifies the Employee's qualifying tipped occupation. New for TY 2026 — supports OBBBA No-Tax-on-Tips reporting. |
| TTOC2 | string | Enter the corrected Treasury Tipped Occupation Code #2 — secondary qualifying tipped occupation, if applicable. New for TY 2026. |
| ControlNum | string | Enter the corrected Control Number assigned by the Employer to uniquely identify the W-2C. |
| State | object [] | Enter the corrected State filing data — Boxes 15–20. |
| StateCd | string | Box 15 — Two-letter State Code. |
| StateCorrectionType | string | Type of state correction you are filing. |
| StateIdNum | string | Box 15 — Employer's State ID Number. |
| StateWages | number | Box 16 — State Wages, Tips, etc. |
| StateTax | number | Box 17 — State Income Tax. |
| LocalityData | object | Boxes 18–20 — Local income / locality information. |
| LocalWages | number | Box 18 — Local Wages, Tips, etc. |
| LocalTax | number | Box 19 — Local Income Tax. |
| LocalityNm | string | Box 20 — Locality Name. |
| County | string | County name (used in states where county-level reporting is required). |
| TaxTypeCd | string | Tax Type Code identifying the type of local tax being reported. |
| SchoolDistrictNum | string | School District Number (required for certain Ohio / Pennsylvania filings). |
| Errors | object[] | Validation error details. |
| Id | string | Validation error code. |
| Name | string | Name of the validation rule that failed. |
| Message | string | Clear description of what went wrong and how to fix it. |
Payload
Request Params
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Query Params - Use the SubmissionId alone to get the full submission, or include RecordId to get a specific record. |
Sample 1
FormW2C/get?submissionId=519a84f4-5e56-496a-82f3-18f51fdf3d75&recordIds=519a84f4-5e56-496a-82f3-18f51fdf3d75,519a84f4-5e56-496a-82f3-18f51fdf3d75
Response JSON
| Response | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. |
Response: 200
{
"FormW2CRecords": [
{
"SubmissionManifest": {
"SubmissionId": "d53a7767-f458-4d18-a423-4c5ed1cd9861",
"TaxYear": "2026",
"IsScheduleFiling": false,
"ScheduleFiling": null,
"IsFederal": true,
"IsState": true,
"IsDistribution": true,
"DistributionDetails": {
"DistributionType": "POSTAL_AND_ONLINE",
"PostalType": "USPS_FIRST_CLASS"
}
},
"ReturnHeader": {
"Business": {
"BusinessId": "f636dced-7054-4a2a-8208-1451e7f764a3",
"PayerRef": "HZN-10001",
"IsDefaultBusiness": false,
"IsActive": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "12-0239751"
},
"IndividualNm": null,
"BusinessNm": "Horizon LLC",
"NameCtrl": "HORI",
"DBADetails": null,
"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": "(972) 555-0100",
"PhoneExtn": "205",
"Email": "horizonllc@sample.com",
"Fax": "(972) 555-0199"
},
"W2Specific": null,
"Form1042SSpecific": null,
"ACASpecific": null,
"Form480Specific": null,
"BusinessType": null,
"SigningAuthority": null
}
},
"ReturnData": [
{
"SequenceId": "1",
"RecordId": "4cc50265-da74-4a97-861b-f777440e6203",
"ReturnManifest": {
"IsFederal": true,
"IsState": true,
"IsDistribution": true,
"DistributionDetails": {
"DistributionType": "POSTAL_AND_ONLINE",
"PostalType": "USPS_FIRST_CLASS"
},
"CorrectionDetails": {
"PrevReportedRecordId": null,
"IsEmployeeSSNNameCorrection": true
}
},
"PrevReportedemployeeData": {
"EmployeeId": "c9687573-c4f4-46a2-89f1-fac155c3dc42",
"PayeeRef": "DAI0k9",
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "SSN",
"TIN": "021-44-5778"
},
"IndividualNm": {
"FirstNm": "David2",
"MiddleNm": "R2",
"LastNm": "Thompson2",
"Suffix": null
},
"DBADetails": null,
"Address": {
"Address1": "780 Market Street",
"Address2": "Suite 1200",
"City": "San Francisco",
"ProvinceOrState": "CA",
"ZipCd": "94103",
"Country": "US"
},
"DOB": null,
"Email": "david.thompson1@sample.com",
"Fax": "(214) 555-0198",
"Phone": "(214) 555-0110"
},
"CorrectEmployeeData": {
"Payeeref": "DAI0k9",
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "SSN",
"TIN": "021-44-5778"
},
"IndividualNm": {
"FirstNm": "David2",
"MiddleNm": "R2",
"LastNm": "Thompson12",
"Suffix": "Jr"
}
},
"PrevReportedW2FormData": {
"Wages": 176000,
"FedTaxWH": 36821,
"SocSecWages": 175000,
"SocSecTaxWH": 10340,
"MediWages": 184502,
"MediTaxWH": 0,
"SocSecTips": 501,
"AllocatedTips": 46.91,
"DependtCareBenefits": 79,
"Sec457Plan": 100,
"NonSec457Plan": 0,
"CompCode1": "TT",
"CompAmt1": 100,
"CompCode2": "TT",
"CompAmt2": 100,
"CompCode3": "TT",
"CompAmt3": 100,
"CompCode4": "TT",
"CompAmt4": 100,
"IsStatEmp": true,
"IsRetPlan": true,
"Is3rdPartySickPay": true,
"TTOC1": "407",
"TTOC2": "409",
"Other": "MA PFL 316.96, MA PML 493.10",
"ControlNum": "35231",
"States": [
{
"StateCd": "VA",
"StateWages": 180.64,
"StateIdNum": "9999999999",
"StateTax": 0,
"LocalityData": [
{
"LocalWages": 220.23,
"LocalTax": 10.45,
"LocalityNm": "Prisine",
"TaxTypeCd": "D ",
"County": null,
"SchoolDistrictNum": null
}
],
"StateCorrectionType": null
}
],
"EmployeeStateSpecificData": null
},
"CorrectedW2FormData": {
"Wages": 176000,
"FedTaxWH": 36821,
"SocSecWages": 175000,
"SocSecTaxWH": 10340,
"MediWages": 184502,
"MediTaxWH": 0,
"SocSecTips": 501,
"AllocatedTips": 46.91,
"DependtCareBenefits": 79,
"Sec457Plan": 100,
"NonSec457Plan": 0,
"CompCode1": "A",
"CompAmt1": 100,
"CompCode2": "TP",
"CompAmt2": 100,
"CompCode3": "TP",
"CompAmt3": 100,
"CompCode4": "TP",
"CompAmt4": 100,
"IsStatEmp": true,
"IsRetPlan": true,
"Is3rdPartySickPay": true,
"TTOC1": "407",
"TTOC2": "409",
"Other": "MA PFL 316.96, MA PML 493.10",
"ControlNum": "35231",
"States": [
{
"StateCd": "CA",
"StateWages": 100.05,
"StateIdNum": "999-9999-8",
"StateTax": 1.86,
"LocalityData": [
{
"LocalWages": 300.24,
"LocalTax": 100.46,
"LocalityNm": "Pristine",
"TaxTypeCd": "D",
"County": null,
"SchoolDistrictNum": null
}
],
"StateCorrectionType": "CORRECTION"
},
{
"StateCd": "VA",
"StateWages": 80.64,
"StateIdNum": "9999999999",
"StateTax": 0,
"LocalityData": [
{
"LocalWages": 220.23,
"LocalTax": 10.45,
"LocalityNm": "Prisine",
"TaxTypeCd": "D ",
"County": null,
"SchoolDistrictNum": null
}
],
"StateCorrectionType": "CORRECTION"
}
],
"EmployeeStateSpecificData": null
}
}
]
}
],
"Errors": null
}