Version: 1.7.0

Get

GET endpoint can be used to fetch the complete details of a submission in whole or individual records. It requires the Submission ID as a parameter & Record ID(s) as optional parameter.

GET FormW2/Get

Request Params

Field	Type	Description
SubmissionId	Guid	Mention the W2 returns Submission ID that you want to Get the records.
RecordIds	Guid	Mention the W2 returns Record ID that you want to Get the records. Multiple RecordIds under the same Submission can be received by sending the RecordIds comma separated.

Request Params

   "formW2/Get?SubmissionId=b1c1fca0-41d4-4be1-bfd4-3b6756c22790&RecordIds=065d46f2-4b5e-49e6-a62a-4c9d2f2f0515"

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes like 200,300 etc.
StatusName	string	Name of the status code.
StatusMessage	string	Detailed status message.
FormW2Records	object	Pulls the submission and record 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 to be filed. Allowed values: "2021"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. Form W2 will be sent directly to the IRS.
IsStateFiling	Boolean	State Filing for the return will be enabled when the value is True. Form W2 will be directly filed with the respective employee states. Note: State Filing will not be created for the states that do not require State filing.
IsPostal	Boolean	Postal Order will be created when the value is set as True. Once the return is Transmitted, Form W2 employee copies will be postal mailed to the employee's address via USPS. Note: Postal Orders for Foreign Address will not be created.
IsOnlineAccess	Boolean	Online Access will be enabled when the value is set as True. Once the return is Transmitted, an email with the link to the secure TaxBandits portal will be sent to the employee. The employee can provide consent and download Form W2 employee copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for W2 returns under this submission.
ScheduleFiling	object	Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True .
EfileDate	string	Returns date of schedule filing.
ReturnHeader	object	Contains information about the Business details.
Business	object	Object to identify the Business Details.
BusinessId	Guid	Returns the unique Business ID for the Business. It can be used in future to refer the same business.
PayerRef	string	Unique identifier of the payer. Size Range: ..50
BusinessNm	string	Name of the business Size Range: ..75
TradeNm	string	Name under which the business operates Size Range: ..75
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	Returns the Employer Identification Number of Business Size Range: 9
Email	string	Email address of the Business Size Range: ..100
ContactNm	string	Name of the person who can be contacted by the IRS Size Range: ..27
Phone	string	Phone number of the business Size Range: 10
PhoneExtn	string	Extension of the business phone number Size Range: ..5
Fax	string	Fax number of the Business Size Range: 10
BusinessType	string	Type of business. Optional for W-2/1099 and mandatory for 94X series Size Range: 4 Allowed values "ESTE", "PART", "CORP", "EORG", "SPRO&quot
SigningAuthority	object	Details of the person who is authorized to sign the return
Name	string	Name of the signing authority Size Range: ..35
Phone	string	Phone number of the signing authority Size Range: 10
BusinessMemberType	string	Business title of the signing authority Size Range: 5..29 Allowed values "CORPORATESECRETARY", "SECRETARYTREASURER", "PARTNER", "GENERALPARTNER", "LIMITEDPARTNER", "LLCMEMBER", "MANAGINGMEMBER", "MANAGER", "TAXMATTERPARTNER", "PRESIDENT", "VICEPRESIDENT", "CORPORATETREASURER", "TREASURER", "ASSISTANTTREASURER", "CHIEFACCOUNTINGOFFICER", "CHIEFEXECUTIVEOFFICER", "CHIEFFINANCIALOFFICER", "TAXOFFICER", "CHIEFOPERATINGOFFICER", "CORPORATEOFFICER", "EXECUTIVEDIRECTOR", "DIRECTOR", "CHAIRMAN", "EXECUTIVEADMINISTRATOR", "RECEIVER", "PASTOR", "ASSISTANTTORELIGIOUSLEADER", "REVEREND", "PRIEST", "MINISTER", "RABBI", "LEADEROFRELIGIOUSORGANIZATION", "SECRETARY", "DIRECTOROFTAXATION", "DIRECTOROFPERSONNEL", "ADMINISTRATOR", "EXECUTOR", "TRUSTEE", "FIDUCIARY", "OWNER", "SOLEPROPRIETOR", "MEMBER", "SOLEMEMBER&quot
KindOfEmployer	string	Identifies the kind of employer. Mandatory for W-2 and optional for 1099-MISC and 94X series Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY&quot
KindOfPayer	string	Identifies the kind of payer. This field is mandatory in W-2 and optional in 1099-MISC and 94X series Allowed values "REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1&quot
IsBusinessTerminated	Boolean	When true, identifies the business as terminated.
IsForeign	Boolean	When true, identifies the business address with a foreign address.
USAddress	object	If IsForeign is false, pass US address of the business
Address1	string	Employer/Payer's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Employer/Payer's suite or apartment Size Range: ..46
City	string	Employer/Payer's city Size Range: ..50
State	string	Employer/Payer's state code. Refer Static values. Size Range: 2 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&quot
ZipCd	string	Employer/Payer's zip code. Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the business
Address1	string	Employer/Payer's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Employer/Payer's suite or apartment Size Range: ..50
City	string	Employer/Payer's city Size Range: ..50
ProvinceOrStateNm	string	Employer/Payer's province or state name Size Range: ..50
Country	string	Employer/Payer's country Size Range: 2 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"
PostalCd	string	Employer/Payer's postal code Size Range: ..16
ReturnData	object[]	Contains information about the employee details and Form W2 details.
SequenceId	string	An 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 a record. Not required when you are creating a return.
Employee	object	Object to identify the employee details.
EmployeeId	Guid	An 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.
SSN	string	Employee's Social Security Number (SSN) Size Range: 9-11
FirstNm	string	Employee's first name.
MiddleNm	string	Employee's middle name.
LastNm	string	Employee's last name.
Suffix	string	Employee's suffix. Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII&quot
Email	string	Employee's email address. Size Range: 0..100
Fax	string	Employee's fax number. Size Range: 10
Phone	string	Employee's phone number including area code. Size Range: 10
IsForeign	Boolean	When true, identifies the employee address with a foreign address.
USAddress	object	Object to identify the employee's US address
Address1	string	Employee's US address (street address or post office box of that locality) Size Range: ..46
Address2	string	Employee's suite or apartment Size Range: ..46
City	string	Employee's city Size Range: ..50
State	string	Employee's State code. Refer Static values. Size Range: 2 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&quot
ZipCd	string	Employee's zip code Size Range: 5..10
ForeignAddress	object	If IsForeign is true, pass foreign address of the employee
Address1	string	Employee's foreign address (street address or post office box of that locality) Size Range: ..50
Address2	string	Employee's suite or apartment Size Range: ..50
City	string	Employee's city. Size Range: ..50
ProvinceOrStateNm	string	Employee's Province or State Name. Size Range: ..50
Country	string	Employee's country code. Refer Static values. Size Range: 2 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"
PostalCd	string	Employee's Postal Code Size Range: ..16
W2FormData	object	Employee's Form W-2 information
B1Wages	number	Gets the total taxable wages, tips, and other compensation paid by the employer to employees during the year. These figures should be prior to payroll deductions. Size Range: 0-999999999.99
B2FedTaxWH	number	Gets the total federal income tax withheld from the employee's wages for the year. Include the 20% excise tax withheld on excess parachute payments. Size Range: 0-999999999.99
B3SocSecWages	number	Gets the total wages paid (before payroll deductions) subject to employee social security tax. Size Range: 0-999999999.99
B4SocSecTaxWH	number	Gets the total amount of social security tax withheld from employees. Include only taxes withheld for wages and tips. Size Range: 0-999999999.99
B5MediWages	number	Gets the amount of wages and tips subject to medicare tax. These are similar to those subject to social security tax (boxes 3 and 7) except that there is no wage base limit for Medicare tax. Size Range: 0-999999999.99
B6MediTaxWH	number	Gets the amount of taxes withheld from employees for Medicare tax Size Range: 0-999999999.99
B7SocSecTips	number	Gets the tips reported by the employee for which the employer did not have enough employee funds to collect the social security tax for the tips. Size Range: 0-999999999.99
B8AllocatedTips	number	Gets the tips allocated to your employee if you operate a large food or beverage establishment. Size Range: 0-999999999.99
B10DependtCareBenefits	number	Gets the total amount of dependent care benefits paid or incurred by the employer for employees under a dependent care assistance program. Size Range: 0-999999999.99
B11Sec457Plan	number	Gets the amount distributed to an employee from the employer's non-qualified plan Size Range: 0-999999999.99
B11NonSec457Plan	number	Gets the amount distributed to an employee from the employer's non-governmental section 457(b) plan Size Range: 0-999999999.99
B12aAmt	number	The amount value for the code selected under Box 12a. Size Range: 0-999999999.99
B12bAmt	number	The amount value for the code selected under Box 12b. Size Range: 0-999999999.99
B12cAmt	number	The amount value for the code selected under Box 12c. Size Range: 0-999999999.99
B12dAmt	number	The amount value for the code selected under Box 12d. Size Range: 0-999999999.99
B12aCd	string	The Box 12a Code. Allowed values "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH&quot
B12bCd	string	The Box 12b Code. Allowed values "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH&quot
B12cCd	string	The Box 12c Code. Allowed values "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH&quot
B12dCd	string	The Box 12d Code. Allowed values "A", "B", "C", "D", "E", "F", "G", "H", "J", "K", "L", "M", "N", "P", "Q", "R", "S", "T", "V", "W", "Y", "Z", "AA", "BB", "CC", "DD", "EE", "FF", "GG", "HH&quot
B13IsStatEmp	Boolean	When true, identifies the statutory employees whose earnings are subject to social security and Medicare taxes but not subject to federal income tax withholding. They are independent contractors under the common-law rules but are treated by statute as employees.
B13IsRetPlan	Boolean	When true, identifies if the employee is an active participant of a retirement plan.
B13Is3rdPartySickPay	Boolean	When true, identifies if the business reports third-party sick pay.
B14Other	string	Gets any additional information that the employer wants to give to employees that cannot be reported in boxes 1-13. Examples include auto allowance, travel reimbursement, relocation expenses, job uniforms, after-tax employee contributions to an HSA, etc. Size Range: 1..51
ControlNum	string	Identifies individual Forms W-2 and this box is optional.
States	object[]	Contains list of state returns information.
B15StateCd	string	State Code of Employer's State. Size Range: 2 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&quot
B15StateIdNum	string	Identification Number of Employer's State. Size Range: ..20
B16StateWages	number	Amount of Wages, tips, etc for State. Size Range: 0-999999999.99
B17StateTax	number	Income Tax of State. Size Range: 0-999999999.99
LocalityData	object[]	Contains list of locality information about the state.
LocalWages	number	Amount of Local Wages, tips, etc for State. Size Range: 0-999999999.99
LocalTax	number	Local Income Tax of State. Size Range: 0-999999999.99
LocalityNm	string	Locality name of State.
TaxTypeCd	enum	Enter the Tax Type Code for the amount entered in "LocalWages" and "LocalTax". Allowed values "C City Income Tax", "D County Income Tax", "E School District Income Tax", "F Other Income Tax&quot
County	enum	Enter the Indiana County code if the "TaxTypeCd" code is "D" - County Income Tax. Allowed values "Adams", "Allen", "Bartholomew", "Benton", "Blackford", "Boone", "Brown", "Carrol", "Cass", "Clark", "Clay", "Clinton", "Crawford", "Daviess", "Dearborn", "Decatur", "DeKalb", "Delaware", "Dubois", "Elkhart", "Fayette", "Floyd", "Fountain", "Franklin", "Fulton", "Gibson", "Grant", "Greene", "Hamilton", "Hancock", "Harrison", "Hendricks", "Henry", "Howard", "Huntington", "Jackson", "Jasper", "Jay", "Jefferson", "Jennings", "Johnson", "Knox", "Kosciusko", "LaGrange", "Lake", "LaPorte", "Lawrence", "Madison", "Marion", "Marshall", "Martin", "Miami", "Monroe", "Montgomery", "Morgan", "Newton", "Noble", "Ohio", "Orange", "Owen", "Parke", "Perry", "Pike", "Porter", "Posey", "Pulaski", "Putnam", "Randolph", "Ripley", "Rush", "St.Joseph", "Scott", "Shelby", "Spencer", "Starke", "Steuben", "Sullivan", "Switzerland", "Tippecanoe", "Tipton", "Union", "Vanderburgh", "Vermillion", "Vigo", "Wabash", "Warren", "Warrick", "Washington", "Wayne", "Wells", "White", "Whitley&quot
SchoolDistrictNum	string	Enter the School District Number if the "TaxTypeCd" is "E" - School District Income Tax.
EmployeeStateSpecificData	object	Contains employee specific data for the selected states.
KS	object	Contains employee state specific data for Kansas.
EmployeeContribution	number	Enter the amount of Employee Contribution to KPERS, KP & F and Judges. Size Range: 0-999999999.99
ME	object	Contains employee state specific data for Maine.
MEPERScontribution	number	Enter the amount of pick-up contributions deducted from this employee’s salary and contributed to MEPERS on behalf of the employee. Size Range: 0-999999999.99
MD	object	Contains employee state specific data for Maryland.
W4ExemptionCount	int	Enter the number of exemptions claimed on Form W-4.
NJ	object	Contains employee state specific data for New Jersey.
PvtFmlLeaveInsuranceNum	string	Enter the Private Family Leave Insurance Plan Number. Size Range: ..14
FmlLeaveInsuranceWH	number	Enter the amount withheld as Family Leave Insurance workers contributions. Size Range: 0-999.99
PvtDisabilityPlanNum	string	Enter the Private Disability Plan Number. Size Range: ..14
DisabilityInsuranceWH	number	Enter the amount withheld as workers’ contributions for Disability Insurance. Size Range: 0-999.99
CombNJUnempInsWrkFrceDevProgHCSubWH	number	Enter the amount withheld as workers contributions for Combined NJ unemployment insurance, Workforce Development Program and health Care Subsidy. Size Range: 0-999.99
DeffCompAmt	number	Enter the total employee elective deferrals to a Code Section 401(k) plan, made during the year. Size Range: 0-9999999.99
IsRetirementPlan	Boolean	When TRUE, identifies that the employee was an active participant (for any part of the year) in a retirement plan.
OR	object	Contains employee state specific data for Oregon.
DateFirstEmployed	date	Enter the date first employed.
DateOfSeparation	date	Enter the date of separation.
TaxableWagesForStateTransitTax	number	Enter the State Taxable Wages for Statewide Transit Tax. Size Range: 0-999999999.99
StateTransitTaxWH	number	Enter the Statewide Transit Tax Withheld. Size Range: 0-999999999.99
MA	object	Contains employee state specific data for Massachusetts.
EeContributionMAPFML	number	Enter the Employee contribution for Paid Family and Medical Leave. Size Range: 0-999999999.99
StateReconData	object	Collects State Recon fields specific for each state. Click here, for the description of each state specific Recon fields.
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

Response JSON

Success Response - This is a sample response for successful API requests.

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "FormW2Records": {
        "SubmissionManifest": {
            "SubmissionId": "b1c1fca0-41d4-4be1-bfd4-3b6756c22790",
            "TaxYear": "2021",
            "IsFederalFiling": true,
            "IsStateFiling": true,
            "IsPostal": true,
            "IsOnlineAccess": true,
            "IsScheduleFiling": false,
            "ScheduleFiling": null
        },
        "ReturnHeader": {
            "Business": {
                "BusinessId": "417be5c4-0a9a-46f1-ba41-69c39f3a90de",
                "PayerRef": "379946",
                "BusinessNm": "Snowdaze LLC",
                "FirstNm": null,
                "MiddleNm": null,
                "LastNm": null,
                "Suffix": null,
                "TradeNm": "Snow123",
                "IsEIN": true,
                "EINorSSN": "52-6672586",
                "Email": "chandler@sample.com",
                "ContactNm": "Chandler White",
                "Phone": "(123) 456-7890",
                "PhoneExtn": "12345",
                "Fax": "(123) 456-7890",
                "BusinessType": "ESTE",
                "SigningAuthority": {
                    "Name": "Chandler White",
                    "Phone": "(123) 456-7890",
                    "BusinessMemberType": "ADMINISTRATOR"
                },
                "KindOfEmployer": "FederalGovt",
                "KindOfPayer": "REGULAR941",
                "IsBusinessTerminated": false,
                "IsForeign": false,
                "USAddress": {
                    "Address1": "3576 AIRPORT WAY",
                    "Address2": "UNIT 9",
                    "City": "FAIRBANKS",
                    "State": "AK",
                    "ZipCd": "99709"
                },
                "ForeignAddress": null,
                "ACADetails": null
            }
        },
        "ReturnData": [
            {
                "RecordId": "065d46f2-4b5e-49e6-a62a-4c9d2f2f0515",
                "SequenceId": "01",
                "IsOnlineAccess": true,
                "IsPostal": true,
                "Employee": {
                    "EmployeeId": "60f86bf9-a55a-4055-9eda-d7659b3c1b2b",
                    "SSN": "266-87-3255",
                    "PayeeRef": null,
                    "FirstNm": "Mark",
                    "MiddleNm": "Freek",
                    "LastNm": "Linda",
                    "Suffix": "Sr",
                    "Email": "mark+13@sample.com",
                    "Fax": "(456) 789-1234",
                    "Phone": "(425) 963-1478",
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "1751 Kinsey Rd",
                        "Address2": "Main St",
                        "City": "Dothan",
                        "State": "AL",
                        "ZipCd": "36303"
                    },
                    "ForeignAddress": null
                },
                "W2FormData": {
                    "B1Wages": 50000.65,
                    "B2FedTaxWH": 5263.32,
                    "B3SocSecWages": 137000.00,
                    "B4SocSecTaxWH": 46.15,
                    "B5MediWages": 137700.00,
                    "B6MediTaxWH": 78.21,
                    "B7SocSecTips": 700.00,
                    "B8AllocatedTips": 45.00,
                    "B10DependtCareBenefits": 78.00,
                    "B11Sec457Plan": 96.00,
                    "B11NonSec457Plan": 0.00,
                    "B12aCd": "EE",
                    "B12aAmt": 32.00,
                    "B12bCd": "B",
                    "B12bAmt": 21.00,
                    "B12cCd": "E",
                    "B12cAmt": 213.00,
                    "B12dCd": "H",
                    "B12dAmt": 210.00,
                    "B13IsStatEmp": true,
                    "B13IsRetPlan": true,
                    "B13Is3rdPartySickPay": true,
                    "B14Other": "Real Estate 4500",
                    "ControlNum": "35231",
                    "States": [
                        {
                            "B15StateCd": "DE",
                            "B16StateWages": 1000.65,
                            "B15StateIdNum": "9-999999999-123",
                            "B17StateTax": 100.32,
                            "LocalityData": [
                                {
                                    "LocalWages": 300.23,
                                    "LocalTax": 100.45,
                                    "LocalityNm": "Pristine",
                                    "TaxTypeCd": null,
                                    "County": null,
                                    "SchoolDistrictNum": null
                                }
                            ]
                        },
                        {
                            "B15StateCd": "SC",
                            "B16StateWages": 100.65,
                            "B15StateIdNum": "123456789",
                            "B17StateTax": 50.32,
                            "LocalityData": [
                                {
                                    "LocalWages": 856.23,
                                    "LocalTax": 632.45,
                                    "LocalityNm": "Pristine",
                                    "TaxTypeCd": null,
                                    "County": null,
                                    "SchoolDistrictNum": null
                                }
                            ]
                        }
                    ],
                    "EmployeeStateSpecificData": null
                }
            }
        ],
        "StateReconData": null
    },
    "Errors": null
}

Not Found Response - You'll get the below response if your API request contains a record that's not found in our database.

{
    "StatusCode": 404,
    "StatusName": "NotFound",
    "StatusMessage": "The resource you have specified cannot be found",
    "FormW2Records": null,
    "Errors": [
        {
            "Id": "F00-100146",
            "Name": "Submission Id",
            "Message": "Submission Id is invalid"
        }
    ]
}

W-9 Automation

BOIR Automation

TIN Matching

1099 Automation

941/940 Automation

W-2 Automation

ACA Automation

Supported Forms

Gig Software

Payroll Software

Affiliate Software

HOA Software

Reselling Platform

HCM Providers

Property Management

Supported Forms

Request Params

Request Params

Response Body

Response JSON