Skip to main content
Version: 2.0.0

Get

Get

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

GET formw2c/get 

Request Params

FieldTypeDescription
SubmissionIdGuidAn 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.
RecordIdGuid[]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

FieldTypeDescription
FormW2CRecordsobject[]Contains information about Form W-2C correction returns.
SubmissionManifestobject[]SubmissionManifest provides brief information about a particular submission as a whole.
SubmissionIdGuidUnique identifier created by TaxBandits for each submission.
TaxYearstringTax year of Form W-2C Correction filed.
ReturnHeaderobjectContains information about the Business details.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidUnique identifier of the business generated by TaxBandits.
PayerRefstringYour unique identifier for the payer
TINDetailsobjectReturns the TIN information for the business
FormatstringReturns the format of the TIN passed
TINTypestringReturns the TIN type of the business.
TINstringReturns the TIN value according to the Format selected.
IndividualNmobjectReturns the individual's name details when the TIN type of the business is "SSN".
FirstNmstringThe first name of the individual.
MiddleNmstringMiddle name of the individual.
LastNmstringThe last name of the individual.
SuffixstringSuffix of the individual’s name.
BusinessNmstringLegal name of the business. Required when TINType is EIN.
NameCtrlstringIRS name control of the business.
DBADetailsobject[]Optional DBA (Doing Business As) information.
DBANmstringName of the DBA.
DBARefstringUnique identifier for the DBA.
DBAIdGuidTaxBandits-generated DBA identifier.
Addressobject[]Address information of the DBA.
Address1stringStreet address or PO Box.
Address2stringSuite or apartment number.
CitystringDBA’s city.
ProvinceOrStatestringDBA's province or state name.
ZipcdstringDBA’s ZIP code.
CountrystringDBA’s 2-character country code.
AddressobjectPrimary address of the business.
Address1stringPrimary address of the business
Address2stringStreet address or PO Box of the business.
CitystringCity of the business.
ProvinceOrStatestringProvince or state name of the business.
ZipCdstringZIP code of the business.
Countrystring2-character country code of the business.
ContactDetailsobject[]Returns details of the person the SSA can contact regarding this business.
FirstNmstringFirst name of the contact person.
MiddleNmstringMiddle name of the contact person.
LastNmstringLast name of the contact person.
SuffixstringThe suffix of the contact person.
PhonestringPhone number of the contact person
PhoneExtnstringPhone extension number.
EmailstringEmail address of the contact person.
FaxstringFax number of the contact person.
ReturnDataobject[]Contains information about the employee details and Form W-2C details.
SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record.
RecordIdstringA unique identifier of the record
ReturnManifestobject[]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.
IsFederalBooleanIdentifies whether Federal filing is enabled for the return
IsStateBooleanIdentifies whether State filing is enabled for the return
IsDistributionBooleanIdentifies whether employee distribution is enabled for the return
DistributionDetailsobjectReturns employee distribution configuration details
DistributionTypestringEmployee copy distribution type.
PostalTypestringReturns postal service type
CorrectionDetailsobjectReturns information required to identify the correction type for the Form W-2C return
PrevReportedRecordIdGuidRecord ID of the original Form W-2
IsEmployeeSSNNameCorrectionBooleanWhen True, Identifies that you are correcting the SSN or Name of the employee.
PrevReportedemployeeDataobjectObject containing the employeeinformation that was submitted in the Original Form W2-C. The information is not required if you have provided the PrevReportedRecordId.
EmployeeIdGuidOptional A unique ID generated by TaxBandits after the employee is created and will be returned in the Response.
PayeeRefstringOptional Your unique identifier for the employee.
TINDetailsobjectEmployee TIN information.
FormatstringReturns the format of the TIN passed.
TINTypestringReturns the TIN type of the employee.
TINstringReturns the TIN value according to the Format selected.
IndividualNmobjectReturns the individual's name details when the TIN type of the employee is "SSN".
FirstNmstringThe first name of the individual.
MiddleNmstringThe middle name of the individual.
LastNmstringThe last name of the individual.
SuffixstringThe suffix of the individual's name.
BusinessNmstringLegal name of the employee business. Required when TINType is EIN.
NameCtrlstringName control of the business as registered with the IRS.
DBADetailsobjectDBA (Doing Business As) information.
DBAIdGuidTaxBandits-generated DBA identifier. Returned in the response.
DBANmstringName of the DBA.
DBARefstringYour unique identifier for this DBA.
AddressobjectAddress information of the DBA.
Address1stringStreet address or PO Box.
Address2stringSuite or apartment number.
CitystringDBA's city.
ProvinceOrStatestringDBA's province or state name.
ZipCdstringDBA's ZIP code.
CountrystringDBA's 2-character country code.
DOBstringDate of Birth of the employee.
AddressobjectPrimary address of the employee.
Address1stringStreet address or PO Box of the employee.
Address2stringSuite or apartment number of the employee.
CitystringCity of the employee.
ProvinceOrStatestringProvince or state name of the employee.
ZipCdstringZIP code of the employee.
Countrystring2-character country code of the employee.
EmailstringEmail address of the employee.
FaxstringFax number of the employee.
PhonestringPhone number of the employee.
CorrectEmployeeDataobjectEnter 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.
PayeeRefstringYour unique identifier for the employee.
TINDetailsobjectEmployee TIN information.
FormatstringReturns the format of the TIN passed
TINTypestringReturns the TIN type of the employee.
TINstringReturns the TIN value according to the Format selected.
IndividualNmobjectReturns the individual's name details when the TIN type of the employee is "SSN".
FirstNmstringThe first name of the individual.
MiddleNmstringOptional The middle name of the individual.
LastNmstringThe last name of the individual.
SuffixstringOptional The suffix of the individual's name.
EmailstringEmail address of the employee.
PrevReportedW2FormDataobjectEmployee's previously reported Form W-2C information.
WagesnumberPreviously reported Wages, Tips, Other Compensation.
FedTaxWHnumberPreviously reported Federal Income Tax Withheld.
SocSecWagesnumberPreviously reported Social Security Wages.
SocSecTaxWHnumberPreviously reported Social Security Tax Withheld.
MediWagesnumberPreviously reported Medicare Wages and Tips.
MediTaxWHnumberPreviously reported Medicare Tax Withheld.
SocSecTipsnumberPreviously reported Social Security Tips.
AllocatedTipsnumberPreviously reported Allocated Tips.
DependtCareBenefitsnumberPreviously reported Dependent Care Benefits.
Sec457PlannumberPreviously reported Nonqualified Plans, Section 457 portion.
NonSec457PlannumberPreviously reported Nonqualified Plans, Non-Section 457 portion.
CompCode1stringPreviously reported Compensation Code 1.
CompAmt1numberPreviously reported Amount for Code 1.
CompCode2stringPreviously reported Compensation Code 2.
CompAmt2numberPreviously reported Amount for Code 2.
CompCode3stringPreviously reported Compensation Code 3.
CompAmt3numberPreviously reported Amount for Code 3.
CompCode4stringPreviously reported Compensation Code 4.
CompAmt4numberPreviously reported Amount for Code 4.
IsStatEmpbooleanPreviously reported Statutory Employee indicator.
IsRetPlanbooleanPreviously reported Retirement Plan indicator.
Is3rdPartySickPaybooleanPreviously reported Third-Party Sick Pay indicator.
OtherstringPreviously reported Other Free-form text used to report items such as state PFL / PML, union dues, etc.
TTOC1stringPreviously 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.
TTOC2stringPreviously reported Treasury Tipped Occupation Code #2 — secondary qualifying tipped occupation, if applicable. New for TY 2026.
ControlNumstringPreviously reported Control Number assigned by the Employer to uniquely identify the W-2C.
Stateobject []Previously reported State filing data — Boxes 15–20.
StateCdstringBox 15 — Two-letter State Code.
StateIdNumstringBox 15 — Employer's State ID Number.
StateWagesnumberBox 16 — State Wages, Tips, etc.
StateTaxnumberBox 17 — State Income Tax.
LocalityDataobjectBoxes 18–20 — Local income / locality information.
LocalWagesnumberBox 18 — Local Wages, Tips, etc.
LocalTaxnumberBox 19 — Local Income Tax.
LocalityNmstringBox 20 — Locality Name.
CountystringCounty name (used in states where county-level reporting is required).
TaxTypeCdstringTax Type Code identifying the type of local tax being reported.
SchoolDistrictNumstringSchool District Number (required for certain Ohio / Pennsylvania filings).
CorrectedW2FormDataobjectEmployee's corrected Form W-2C information.
WagesnumberEnter the corrected Wages, Tips, Other Compensation.
FedTaxWHnumberEnter the corrected Federal Income Tax Withheld.
SocSecWagesnumberEnter the corrected Social Security Wages.
SocSecTaxWHnumberEnter the corrected Social Security Tax Withheld.
MediWagesnumberEnter the corrected Medicare Wages and Tips.
MediTaxWHnumberEnter the corrected Medicare Tax Withheld.
SocSecTipsnumberEnter the corrected Social Security Tips.
AllocatedTipsnumberEnter the corrected Allocated Tips.
DependtCareBenefitsnumberEnter the corrected Dependent Care Benefits.
Sec457PlannumberEnter the corrected Nonqualified Plans, Section 457 portion.
NonSec457PlannumberEnter the corrected Nonqualified Plans, Non-Section 457 portion.
CompCode1stringEnter the corrected Compensation Code 1.
CompAmt1numberEnter the corrected Amount for Code 1.
CompCode2stringEnter the corrected Compensation Code 2.
CompAmt2numberEnter the corrected Amount for Code 2.
CompCode3stringEnter the corrected Compensation Code 3.
CompAmt3numberEnter the corrected Amount for Code 3.
CompCode4stringEnter the corrected Compensation Code 4.
CompAmt4numberEnter the corrected Amount for Code 4.
IsStatEmpbooleanEnter the corrected Statutory Employee indicator.
IsRetPlanbooleanEnter the corrected Retirement Plan indicator.
Is3rdPartySickPaybooleanEnter the corrected Third-Party Sick Pay indicator.
OtherstringEnter the corrected Other Free-form text used to report items such as state PFL / PML, union dues, etc.
TTOC1stringEnter 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.
TTOC2stringEnter the corrected Treasury Tipped Occupation Code #2 — secondary qualifying tipped occupation, if applicable. New for TY 2026.
ControlNumstringEnter the corrected Control Number assigned by the Employer to uniquely identify the W-2C.
Stateobject []Enter the corrected State filing data — Boxes 15–20.
StateCdstringBox 15 — Two-letter State Code.
StateCorrectionTypestringType of state correction you are filing.
StateIdNumstringBox 15 — Employer's State ID Number.
StateWagesnumberBox 16 — State Wages, Tips, etc.
StateTaxnumberBox 17 — State Income Tax.
LocalityDataobjectBoxes 18–20 — Local income / locality information.
LocalWagesnumberBox 18 — Local Wages, Tips, etc.
LocalTaxnumberBox 19 — Local Income Tax.
LocalityNmstringBox 20 — Locality Name.
CountystringCounty name (used in states where county-level reporting is required).
TaxTypeCdstringTax Type Code identifying the type of local tax being reported.
SchoolDistrictNumstringSchool District Number (required for certain Ohio / Pennsylvania filings).
Errorsobject[]Validation error details.
IdstringValidation error code.
NamestringName of the validation rule that failed.
MessagestringClear description of what went wrong and how to fix it.
Request Params
SampleDescriptionAction
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
ResponseDescriptionAction
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
}