Version: 2.0

Get

Use this endpoint to retrieve a W-2G submission and its records. Provide the SubmissionId to retrieve the whole submission, optionally narrowing to a specific RecordId.

The response includes the full payer, recipient, and form data as originally submitted — useful for audit trails and displaying return details in your application.

POST formw2g/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 W2-G returns.
SubmissionManifest	object[]	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsScheduleFiling & ScheduleFiling service details
SubmissionId	Guid	Unique identifier created by TaxBandits for each submission. Not required when you are creating a return.
TaxYear	string	Tax year of Form W2-G to be filed. Allowed values "2025", "2026"
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form W2-G returns under this submission.
ScheduleFiling	object[]	Contains the preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
EfileDate	string	Date of Schedule Filing. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY. Example: 01/25/2026 or 01-25-2026
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Optional 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
IsDefaultBusiness	Boolean	When set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetails	object	TIN information for the business.
Format	string	Specifies how the TIN is passed. Allowed values "PLAIN_TIN" — Pass TIN directly.
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 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	string	Name control of the business as registered with the IRS. 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.
Address	object[]	Address information of the 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: 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" When the country code is CA: Allowed values "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", "US"
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
ProvinceOrState	string	Province or state name of the business. Allowed values When the country code is US: 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" When the country code is CA: Allowed values "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 "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", "US"
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 digits
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 W2-G details.
SequenceId	string	A 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. Size Range: 50
RecordId	Guid	Unique Identifier of the Record. Mention the Form W2-G return's Record ID that you want to update. If you do not provide the Record ID, then a new record will be added to the submission.
ReturnManifest	object[]	Filing options for this record.
IsFederal	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2-G will be sent directly to the IRS.
IsState	Boolean	State Filing for the return will be enabled when the value is True. Form W2-G 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[]	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"
IsForced	Boolean	When TRUE, TaxBandits does not verify for duplicates and will create a new return for the recipient, even if it comprises the same amounts as in previously filed returns. For more information on duplicate handling for Form 1099s, click here. Note: If there are multiple returns filed for the recipient with the same account number, TaxBandits will append 3 random numbers at the end of the account number.
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	Optional A unique ID generated by TaxBandits after the return is created and will be returned in the Response. You can use this ID for your future reference to Update.
PayeeRef	string	Optional Your unique identifier for the recipient. Can replace RecipientId in future requests. Size Range: 50
TINDetails	object	Recipient TIN information.
Format	string	Specifies how the TIN is passed. Allowed values "PLAIN_TIN" — Pass TIN directly.
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	The TIN value, formatted according to the Format field 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	Name control of the business as registered with the IRS. Size Range: 3..4
DBADetails	object	Optional DBA (Doing Business As) information.
DBAId	Guid	TaxBandits-generated DBA identifier. Returned in the response.
DBANm	string	Name of the DBA. Size Range: 75
DBARef	string	Your unique identifier for this DBA. Size Range: 1–50
Address	object	Address information of the 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: 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" When the country code is CA: Allowed values "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", "US"
DOB	string	Optional Date of Birth of the recipient. Format: MM/DD/YYYY
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: 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" When the country code is CA: Allowed values "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 recipient. Size Range: 5 – 16
Country	string	2-character country code of the recipient. 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", "US"
Email	string	Email address of the recipient. Size Range: 100 Note: Required if DistributionType is ONLINE_ACCESS.
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. Size Range: 8
WagerType	Enum	Enter the type of wager Size Range: 1 Allowed values Allowed values "HORSE_RACETRACK", "DOG_RACETRACK", "JAI_ALAI", "STATE_CONDUCTED_LOTTERY","KENO", "BINGO", "SLOT_MACHINES", "POKER_WINNINGS","ANY_OTHER_TYPE_OF_GAMBLING_WINNINGS"
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 serialnumber, other identifying number or any other information that will helpidentify 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[]	Contains list of state returns information.
StateCd	string	State Code. Size Range: 2 Allowed values 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	Identification Number of State. Size Range: ..20
StateWinnings	number	Enter the Reportable state winning amount. Size Range: 0-9999999999.99
StateWH	number	Income tax amount withheld for State. 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

"FormW2G/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

{
"FormW2GRecords": [
  {
    "SubmissionManifest": {
      "SubmissionId": "e50c27b8-631c-45f0-be19-f786fc69ba60",
      "TaxYear": "2026",
      "IsScheduleFiling": true,
      "ScheduleFiling": {
        "EfileDate": "01/25/2026"
      }
    },
    "ReturnHeader": {
      "Business": {
        "PayerRef": "Snow123",
        "BusinessId": null,
        "IsDefaultBusiness": true,
        "TINDetails": {
          "Format": "PLAIN_TIN",
          "TINType": "EIN",
          "TIN": "45-9875461"
        },
        "IndividualNm": {
          "FirstNm": "James",
          "MiddleNm": "A",
          "LastNm": "Anderson",
          "Suffix": "Jr"
        },
        "BusinessNm": "Snowdaze LLC",
        "NameCtrl": "SNOW",
        "DBADetails": {
          "DBANm": "Iceberg Icecreams",
          "DBARef": "DBA1001",
          "DBAId": null,
          "Address": {
            "Address1": "123 Main St",
            "Address2": "Suite 1001",
            "City": "Rock Hill",
            "ProvinceOrState": "SC",
            "ZipCd": "29730",
            "Country": "US"
          }
        },
        "Email": "james@sample.com",
        "Address": {
          "Address1": "123 Main St",
          "Address2": "Suite 1001",
          "City": "Rock Hill",
          "ProvinceOrState": "SC",
          "ZipCd": "29730",
          "Country": "US"
        },
        "ContactDetails": {
          "FirstNm": "James",
          "MiddleNm": "A",
          "LastNm": "Anderson",
          "Suffix": "Jr",
          "Phone": "8035551234",
          "PhoneExtn": "101",
          "Email": "contact@snowdaze.com",
          "Fax": "8035555678"
        }
      }
    },
    "ReturnData": [
      {
        "SequenceId": "1",
        "RecordId": "cfd6fe66-ac9f-49f7-b8a3-2d064abeeb9b",
        "IsFederal": true,
        "IsState": true,
        "IsDistribution": true,
        "DistributionDetails": {
           "DistributionType": "POSTAL_ONLY",
          "PostalType": "USPS_FIRST_CLASS"
        },
        "IsForced": false,
        "Recipient": {
          "PayeeRef": "DAI001",
          "TINDetails": {
            "Format": "PLAIN_TIN",
            "TINType": "EIN",
            "TIN": "45-9875461"
          },
          "IndividualNm": {
            "FirstNm": "James",
            "MiddleNm": "A",
            "LastNm": "Anderson",
            "Suffix": "Jr",
            "DOB": null
          },
          "BusinessNm": "Snowdaze LLC",
          "NameCtrl": "SNOW",
          "DBADetails": {
            "DBANm": "Iceberg Icecreams",
            "DBARef": "DBA1001",
            "Address": {
              "Address1": "123 Main St",
              "Address2": "Suite 1001",
              "City": "Rock Hill",
              "ProvinceOrState": "SC",
              "ZipCd": "29730",
              "Country": "US"
            }
          },
          "Address": {
            "Address1": "123 Main St",
            "Address2": "Suite 1001",
            "City": "Rock Hill",
            "ProvinceOrState": "SC",
            "ZipCd": "29730",
            "Country": "US"
          },
          "Email": "shawn@sample.com",
          "Fax": "6634567890",
          "Phone": "9634567890"
        },
        "W2GFormData": {
          "ReportableWinnings": 50000.65,
          "DateWon": "02/01/2023",
          "WagerType": "DOG_RACETRACK",
          "FedTaxWH": 500.82,
          "Txn": null,
          "Race": "Horse",
          "WinningsIdWagers": 700.89,
          "Cashier": "Yugyu",
          "Window": 78.35,
          "FirstId": "GA93393935",
          "SecondId": "NR935IIT935",
          "States": {
            "StateCd": "CA",
            "StateIdNum": "999-9999-9",
            "StateWinnings": 1000.56,
            "StateWH": 100.28,
            "LocalWinnings": 300.23,
            "LocalWH": 100.45,
            "LocalityNm": "Pristine"
          }
        }
      }
    ],
    "StateReconData": 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

Get

Get

Request Params

Response Body

Response: 200