Version: 2.0.0

ValidateForm

Use this endpoint to validate W-2G Correction data against IRS business rules before creating the form.

POST FormW2GCorrection/validateform

Run in Postman

Request Body

Field	Type	Description
SubmissionManifest	object[]	SubmissionManifest provides brief information about a particular submission on the whole.
TaxYear	string	Tax year of Form W-2G Correction to be filed. Allowed values "2025", "2026"
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Use the unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
PayerRef	string	Optional Your unique identifier for the payer. Can replace BusinessId in future requests. Size Range: 50
TINDetails	object	TIN information for the business
Format	string	Specifies how the TIN is passed. Allowed values "PLAIN_TIN" — Pass TIN directly. "ENCRYPTED_TIN" — Pass encrypted TIN. "TOKENIZED_TIN" — Pass tokenized TIN.
TINType	string	Specify the TIN type of the business. Allowed values "EIN", "SSN", “QI-EIN”, “ITIN”, “WP-EIN”, “WT-EIN”, “NQI-EIN”, “IRSN”
TIN	string	The TIN value according to the Format selected.
IndividualNm	object	Required when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNm	string	The first name of the individual. Size Range: 20
MiddleNm	string	Optional Middle name of the individual. Size Range: 20
LastNm	string	The last name of the individual. Size Range: 20
Suffix	string	Optional Optional Suffix of the individual’s name. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
BusinessNm	string	Legal name of the business. Required when TINType is EIN. Size Range: 75
NameCtrl	number	IRS name control of the business. Size Range: 3..4
DBADetails	object[]	Optional DBA (Doing Business As) information.
DBANm	string	Name of the DBA. Size Range: 75
DBARef	string	Unique identifier for the DBA. Size Range: 1-50
DBAId	GUID	TaxBandits-generated DBA identifier. Use the unique DBA ID (Generated by TaxBandits) that you received in the response of the Business/AddDBA Endpoint. If you do not have a DBA ID, ignore the field. By giving the DBA ID, you do not have to provide all the DBA information again.
IsDefaultDBA	Boolean	When TRUE, marks this DBA as the default.
Address	object[]	Address information of DBA
Address1	string	Street address or PO Box. Size Range: 46
Address2	string	Optional Suite or apartment number. Size Range: 46
City	string	DBA’s city. Size Range: 50
City	string	DBA’s city. Size Range: 50
ProvinceOrStateNm	string	DBA's province or state name. Allowed values When the country code is CA: "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" When the country code is CA:“AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT” Note: The size range is set to 50 for all countries except the United States and Canada.
Zipcd	string	DBA’s ZIP code. Size Range: 5-16
Zipcd	string	DBA’s ZIP code. Size Range: 5-16
Country	string	DBA’s 2-character country code. Allowed values “US”,"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
Email	string	Optional Email address of the Business Size Range: 100
Address	object	Primary address of the business
Address1	string	Street address or PO Box of the business. Size Range: 46
Address2	string	Optional Suite or apartment number of the business. Size Range: 46
City	string	City of the business. Size Range: 50
ProvinceOrStateNm	string	Province or state name of the business. Allowed values When the country code is US : "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" When the country code is CA: “AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT” Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCd	string	ZIP code of the business. Size Range: 5-16
Country	string	2-character country code of the business. Allowed values “US”,"AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
ContactDetails	object[]	Details of the person the IRS can contact regarding the given business.
FirstNm	string	First name of the contact person. Size Range: 20
MiddleNm	string	Optional Middle name of the contact person. Size Range: 20
LastNm	string	Last name of the contact person. Size Range: 20
Suffix	string	Optional The suffix of the contact person. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
Phone	string	Optional Phone number of the contact person Size Range: 10
PhoneExtn	string	Optional Phone extension number. Size Range: 5
Email	string	Optional Email address of the contact person. Size Range: ...100
Fax	string	Optional Fax number of the contact person. Size Range: 10 digits
ReturnData	object[]	Contains information about the recipient details and Form W-2G correction details.
SequenceId	string	Optional A unique reference ID for the return that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. Size Range: 50
ReturnManifest	object[]	Return Manifest provides a high-level summary of a return. It includes information such as the federal filing, state filing, postal service, recipient copy distribution configuration, correction type, and the IRIS unique identifiers associated with the return.
IsFederal	Boolean	Federal Filing for the return will be enabled when the value is True. Form W-2G will be sent directly to the IRS.
IsState	Boolean	State Filing for the return will be enabled when the value is True. Form W-2G will be directly filed with the respective recipient states. Note: State Filing will not be created for the states that do not require State filing.
IsDistribution	Boolean	When TRUE, recipient distribution is enabled (postal mail / online access/email).
DistributionDetails	object[]	Recipient distribution configuration. Required when IsDistribution is TRUE.
DistributionType	string	Recipient copy distribution type. Allowed values "POSTAL_ONLY", "ONLINE_ACCESS", "POSTAL_AND_ONLINE"
PostalType	string	Postal service type. Allowed values “USPS_FIRST_CLASS”
CorrectionDetails	Object	Object containing the information required to identify the correction type for the Form W-2G return
FederalCorrectionType	string	Provide the type of correction for federal filing you are filing for the recipient. Allowed values VOID - The Form shouldn't have been filed,RECIPIENT - Correcting only the recipient details, such as Name and TIN. AMOUNT - Correcting only the amount fields, including check boxes and codes. RECIPIENT_AMOUNT - Correcting both recipient details and amount-related fields, including Name, TIN, amounts, check boxes, and codes. ADDRESS_ONLY - Correcting only recipient address information
PrevReportedRecordId	Guid	If you are correcting a W-2G that was originally filed with TaxBandits, provide the Record ID of the original Form W-2G here. The PrevReportedRecipientData Object is not required if you provide the PrevReportedRecordID
OriginalFilingMethod	String	Filing method used to submit the Form W-2G return to the IRS (Not required when the return is processed through TaxBandits) Allowed values "IRIS", "FIRE"
IRISUniqueIds	Object	Gets the IRIS unique identifiers associated with the previously filed original return. Note: IRISUniqueIds is required only if the original return was filed using the IRIS filing format, but it is not required if the original return was already filed through TaxBandits.
UTID	String	Gets the IRIS unique identifiers associated with the previously filed original return.An Unique Transmission Identifier (UTID) used to track the original return
ReceiptId	String	An identifier that confirms IRIS received the transmission.
SubmissionId	String	An identifier that represents a specific submission within a transmission.
RecordId	String	An identifier that represents an Indivdual return within a submission.
PrevReportedRecipientData	object	Object containing the recipient information that was submitted in the Original Form W-2G. The information is not required if you have provided the PrevReportedRecordId.
RecipientId	Guid	Optional A unique ID generated by TaxBandits after the recipient is created and will be returned in the Response.
PayeeRef	string	Optional Your unique identifier for the recipient. Size Range: 50
TINDetails	object	Recipient TIN information.
Format	string	Specifies how the TIN is passed. Allowed values • "PLAIN_TIN" — Pass TIN directly. • "ENCRYPTED" — Pass encrypted TIN. • "TOKEN" — Pass tokenized TIN.
TINType	string	Specify the TIN type of the recipient. Allowed values ""EIN", "SSN", "ATIN", "ITIN", "NA"
TIN	string	TIN value according to the Format selected.
IndividualNm	Object	Required when TINType is SSN, ITIN, or ATIN. Provide individual name fields instead of BusinessNm.
FirstNm	string	The first name of the individual. Size Range: 20
MiddleNm	string	Optional The middle name of the individual. Size Range: 20
LastNm	string	The last name of the individual. Size Range: 20
Suffix	string	Optional The suffix of the individual’s name. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
BusinessNm	string	Legal name of the recipient business. Required when TINType is EIN. Size Range: 75
NameCtrl	string	IRS name control of the recipient. Size Range: 3..4
CorrectRecipientData	object	Enter the corrected Recipient Name and TIN value. This Object is required, when the CorrectionType value is "RECIPIENT" or "RECIPIENT_AMOUNT" or "ADDRESS_ONLY" (only for recipient's address correction). The object should be "null", when the CorrectionType value is "VOID" or "AMOUNT"
TINDetails	object	Recipient TIN information.
Format	string	Specifies how the TIN is passed. Allowed values • "PLAIN_TIN" — Pass TIN directly. • "ENCRYPTED" — Pass encrypted TIN. • "TOKEN" — Pass tokenized TIN.
TINType	string	Specify the TIN type of the recipient. Allowed values "EIN", "SSN", “QI-EIN”, “ITIN”, “WP-EIN”, “WT-EIN”, “NQI-EIN”, “IRSN”
TIN	string	TIN value according to the Format selected.
IndividualNm	Object	Required when TINType is SSN, ITIN, or ATIN. Provide individual name fields instead of BusinessNm.
FirstNm	String	The first name of the individual. Size Range: 20
MiddleNm	String	Optional The middle name of the individual. Size Range: 20
LastNm	String	The last name of the individual. Size Range: 20
Suffix	String	Optional The suffix of the individual’s name. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
BusinessNm	String	Legal name of the recipient business. Required when TINType is EIN. Size Range: 75
NameCtrl	String	IRS name control of the recipient. Size Range: 3..4
DBADetails	Object	Optional DBA (Doing Business As) information.
DBAId	GUID	TaxBandits-generated DBA identifier. Use the unique DBA ID (Generated by TaxBandits) that you received in the response of the Recipient/AddDBA Endpoint. If you do not have a DBA ID, ignore the field. By giving the DBA ID, you do not have to provide all the DBA information again.
DBANm	String	Name of the DBA. Size Range: 75
DBARef	String	Your unique identifier for this DBA. Size Range: 1–50 characters
Address	Object	Address information of DBA
Address1	String	Street address or PO Box. Size Range: 46
Address2	String	Optional Suite or apartment number. Size Range: 46
City	String	DBA’s city. Size Range: 50
ProvinceOrState	String	DBA’s province or state name. Allowed values When the country code is US : "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" When the country code is CA:“AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT” Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCd	String	ZIP code of the business. Size Range: 5 - 16
Country	String	DBA’s 2-character country code. Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
Address	Object	Primary address of the recipient.
Address1	String	Street address or PO Box of the recipient. Size Range: 46
Address2	String	Optional Suite or apartment number of the recipient. Size Range: 46
City	String	City of the recipient. Size Range: 50
ProvinceOrState	String	Province or state name of the recipient. Allowed values When the country code is US : "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" When the country code is CA: “AB”, ”BC”, ”MB”, ”NB”, ”NL”, ”NT”, ”NS”, ”NU”, ”ON”, ”PE”, ”QC”, ”SK”, ”YT” Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCd	String	DBA’s ZIP code. Size Range: 5 – 16
Country	String	DBA’s 2-character country code. Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
Email	String	Email address of the recipient. Size Range: 100 Note: Required if the DistributionType is either "ONLINE_ACCESS" or "POSTAL_AND_ONLINE"
Fax	String	Optional Fax number of the recipient. Size Range: 10
Phone	String	Optional Phone number of the recipient. Size Range: 10
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

Response Body

Field	Type	Description
ErrorRecords	object[]	It will show the detailed information about the error status of Form W-2G Records.
SequenceId	string	Shows detailed error information.
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description of the validation error
Errors	Object []	Top-level request errors if the entire request cannot be processed.
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 Json

Sample	Description	Action
Sample 1	Create a Form W-2G return for the specific business and include recipient and income information.

Sample 1

{
  "SubmissionManifest": {
      "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"
          }
          ]
  }

Response Json

Response	Description	Action
200	Success Response - This is a sample response for successful API requests.
401	Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

Response: 200

{
  "ErrorRecords": null,
  "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

ValidateForm

ValidateForm

Request Body

Response Body

Sample 1

Response: 200