Create
This endpoint can be used to create a 5498-SA Correction form. You can send multiple 5498-SA correction forms in a single request for the same Payer. In response, a SubmissionId is created, which can be used for future references.
To understand the key points regarding the 5498 correction, click here.
POST Form5498SACorrection/Create
Request Body
Field | Type | Description |
---|---|---|
SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like
|
TaxYear | string | Tax year of Form 5498 SA Correction to be filed.Allowed values"2024" |
IsFederalFiling | Boolean | This value must be set as True in order to have Form 5498-SA Correction filed to the IRS. |
IsPostal | Boolean | If this value is set as True, the postal mailing service will be opted for all the recipients included in the submission.Once the returns are transmitted, the 5498-SA correction form copies will be mailed to the recipient's address via USPS. Note: Postal Orders for Foreign Address will not be created. |
IsOnlineAccess | Boolean | If this value is set as True, the Online Access service will be enabled for all the recipients included in the submission.Once the returns are transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipients. The recipients can then provide consent and download Form 5498-SA Correction copies from the portal. The Online Access portal can be customized with the client logo. |
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), 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. |
BusinessNm | string | Name of the business Size Range: ..75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
TradeNm | string | Optional Name under which the business operates Size Range: ..75 |
IsEIN | Boolean | When true, identifies the business with an EIN. |
EINorSSN | string | When IsEIN is true, use Employer Identification Number (EIN). When IsEIN is false, use Social Security Number (SSN) Size Range: 9-11 |
string | Optional Email address of the Business Size Range: ..100 | |
ContactNm | string | Optional Name of the person who can be contacted by the IRS Size Range: ..27 |
Phone | string | Optional Phone number of the business Size Range: 10 |
PhoneExtn | string | Optional Extension of the business phone number Size Range: ..5 |
Fax | string | Optional Fax number of the Business Size Range: 10 |
BusinessType | string | Optional Type of business. Optional for W-2/5498SA and mandatory for 94X series Size Range: 4 Allowed values"ESTE", "PART", "CORP", "EORG", "SPRO" |
SigningAuthority | object | Optional Details of the person who is authorized to sign the return |
Name | string | Optional Name of the signing authority Size Range: ..35 |
Phone | string | Optional Phone number of the signing authority Size Range: 10 |
BusinessMemberType | string | Optional 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" |
KindOfEmployer | string | Optional Identifies the kind of employer. Mandatory for W-2 and optional for 5498-SA and 94X seriesAllowed values"FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY" |
KindOfPayer | string | Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in 5498-SA and 94X seriesAllowed values"REGULAR941", "REGULAR944", "AGRICULTURAL943", "HOUSEHOLD", "MILITARY", "MEDICAREQUALGOVEM", "RAILROADFORMCT1" |
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 or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional 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" |
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 | Optional 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 recipient details and Form 5498 SA correction details. |
Manifest | object | Collects the Record id, Sequence Id and Correction Type information |
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 |
PrevReportedRecordId | Guid | If you are correcting a 5498-SA that was originally filed with TaxBandits, provide the Record ID of the original Form 5498-SA here. The PrevReportedRecipient Object is not required if you provide the PrevReportedRecordID |
CorrectionType | string | Provide the type of correction you are filing for the recipient. Allowed valuesVOID -The Form shouldn't have been filed, |
IsPostal | Boolean | If this value is set as true, the Postal Mailing service will be opted for the recipient included in the record. Once the return is transmitted, the 5498-SA correction copy will be mailed to the recipient's address via USPS.Postal Orders for Foreign Address will not be created. Note: To enable this, you must have set the IsPostal value as True under the SubmissionManifest. You can set this value as False for the other records for which you don’t want this service. |
IsOnlineAccess | Boolean | If this value is set as true, the Online Access service will be enabled for the recipient included in the record. Once the return is transmitted, an email with a link to the secure TaxBandits portal will be sent to the recipient. The recipient can then provide consent and download a Form 5498-SA correction copy from the portal. Note: To enable this, you must have set the IsOnlineAccess value as True under the submission. You can set this value as False for the other records for which you don’t want this service. |
PrevReportedRecipientData | object[] | Enter the Recipient information that was submitted in the Original Form 5498-SA. The information is not required if you have provided the PrevReportedRecordId. |
RecipientId | Guid | Optional 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. |
TINType | string | Specify the TIN type of the recipient. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values"SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Enter the nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9-11 |
FirstPayeeNm | string | Enter the name of the recipient (preferably last name first for an Individual). If more space is required for the name, use the Second Payee Name Field. Size Range: 75 |
SecondPayeeNm | string | Optional If there are multiple recipients (for example, partners, joint owners, or spouses), use this field for those names not associated with the TIN or if not enough space was provided in the First Payee Name, continue the name in this field. Size Range: 75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient'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" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient'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 | Recipient's Postal Code Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 Note : This email address cannot be the same for two different recipients under the same business. | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
CorrectedRecipientData | object | Enter the corrected Recipient Name and TIN value. This Object is required, when the CorrectionType value is "RECIPIENT" or "RECIPIENT_AMOUNT". The object should be "null", when the CorrectionType value is "VOID" or "AMOUNT" |
TINType | string | Corrected TIN Type of the Recipient. Note: If the recipient doesn't have a TIN, enter the TIN type as 'NA' and input 'null' in the TIN field. Allowed values"SSN", "EIN", "ITIN", "ATIN", "NA" |
TIN | string | Corrected TIN of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
FirstPayeeNm | string | Corrected First Payee Name Size Range: 75 |
SecondPayeeNm | string | Optional Corrected Second Payee Name Size Range: 75 |
FirstNm | string | First Name of the Individual Size Range: ..20 |
MiddleNm | string | Middle Name of the Individual Size Range: ..20 |
LastNm | string | Last Name of the Individual Size Range: ..20 |
Suffix | string | Suffix of the IndividualAllowed values"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII" |
IsForeign | Boolean | When true, identifies the recipient address with a foreign address. |
USAddress | object | If IsForeign is false, pass US address of the recipient |
Address1 | string | Recipient's US address (street address or post office box of that locality) Size Range: ..46 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..46 |
City | string | Recipient's city Size Range: ..50 |
State | string | Recipient'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" |
ZipCd | string | Recipient's zip code Size Range: 5..10 |
ForeignAddress | object | If IsForeign is true, pass foreign address of the recipient |
Address1 | string | Recipient's foreign address (street address or post office box of that locality) Size Range: ..50 |
Address2 | string | Optional Recipient's suite or apartment Size Range: ..50 |
City | string | Recipient's city. Size Range: ..50 |
ProvinceOrStateNm | string | Recipient's Province or State Name. Size Range: ..50 |
Country | string | Recipient'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 | Recipient's Postal Code Size Range: ..16 |
string | Optional Recipient's email address. Size Range: 0..100 | |
Fax | string | Optional Recipient's Fax number. Size Range: 10 |
Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
Form5498SAData | object | The 5498 SA Form Data requirement varies based on the CorrectionType. Read the instructions below to fill the Form5498SAData for different Correction Types. VOID - The Form5498SAData values shoud be zero. Provide the Account number (AccountNum) alone, if it was provided on the original return, AMOUNT - Provide the Corrected Form 5498-SA data. Include all the actual amount for all the box number even if you are correcting a specific box value, RECIPIENT - Provide the Form 5498-SA data reported on the Original Form. Ignore if you provided the PrevReportedRecordId (We will retreive the amount information from the original return that was filed with us), RECIPIENT_AMOUNT - Provide the Corrected Form 5498-SA data. Include all the actual amount for all the box number even if you are correcting a specific box value. |
B1MSAContrib | number | Form 5498SA Box1. Gets employee's or self-employed person's regular contributions to the Archer MSA made in tax year. Size Range: 0-9999999999.99 |
B2TotalContrib | number | Form 5498SA Box2. Gets the total HSA or Archer MSA contributions made in tax year. Size Range: 0-9999999999.99 |
B3TotalHSAorMSAIn2024 | number | Form 5498SA Box3. Gets the total HSA or Archer MSA contributions made in the following year for the specified tax year. Size Range: 0-9999999999.99 |
B4RolloverContrib | number | Form 5498SA Box4. Gets rollover contributions to the HSA or Archer MSA received during the tax year. Size Range: 0-9999999999.99 |
B5FMV | number | Form 5498SA Box5. Gets the FMV of the account as of December 31 for the specified tax year. Size Range: 0-9999999999.99 |
B6AccType | string | Form 5498SA Box6. Recipient's account type.Allowed values"HSA", "Archer_MSA", "MA_MSA" |
AccountNum | string | Account number of Payer having multiple accounts for a recipient for whom more than one Form 5498SA is filed. Size Range: 4..20 Note: If the account number on the return you file is the same as any previously filed return, TaxBandits will append 3 random numbers at the end of the account number. |
Request JSON
- Sample 1
- Sample 2
- Sample 3
- Sample 4
Create a Form 5498-SA Correction return with both Business and Recipient TIN as EIN
{
"SubmissionManifest": {
"TaxYear": "2023",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": "Iceberg Icecreams",
"IsEIN": true,
"EINorSSN": "65-7369245",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "001",
"PrevReportedRecordId": "fa46ee66-f622-472a-b2d7-94da4d316377",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "b6fc9326-4029-40a1-a516-572218f500ef",
"TINType": "EIN",
"TIN": "39-3817572",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"CorrectedRecipientData": {
"TINType": "EIN",
"TIN": "39-3817582",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
Create a Form 5498-SA Correction return with both Business and Recipient TIN as SSN
{
"SubmissionManifest": {
"TaxYear": "2023",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": null,
"BusinessNm": null,
"FirstNm": "James",
"MiddleNm": null,
"LastNm": "Smith",
"Suffix": null,
"PayerRef": "Snow123",
"TradeNm": null,
"IsEIN": false,
"EINorSSN": "657-36-9245",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "1234567890",
"PhoneExtn": "12345",
"Fax": "1234567890",
"BusinessType": "ESTE",
"SigningAuthority": null,
"KindOfEmployer": "FederalGovt",
"KindOfPayer": "REGULAR941",
"IsBusinessTerminated": false,
"IsForeign": false,
"USAddress": {
"Address1": "3576 AIRPORT WAY",
"Address2": "UNIT 9",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "001",
"PrevReportedRecordId": "fa46ee66-f622-472a-b2d7-94da4d316377",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "b6fc9326-4029-40a1-a516-572218f500ef",
"TINType": "SSN",
"TIN": "393-81-7572",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"CorrectedRecipientData": {
"TINType": "SSN",
"TIN": "393-81-7582",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
Create a Form 5498-SA Correction return with BusinessId and RecipientId.
{
"SubmissionManifest": {
"TaxYear": "2023",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": "519a84f4-5e56-496a-82f3-18f51fdf3d75",
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "001",
"PrevReportedRecordId": "fa46ee66-f622-472a-b2d7-94da4d316377",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "b6fc9326-4029-40a1-a516-572218f500ef",
},
"CorrectedRecipientData": {
"TINType": "SSN",
"TIN": "393-81-7573",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
Create a Form 5498-SA Correction return with multiple returns.
{
"SubmissionManifest": {
"TaxYear": "2023",
"IsFederalFiling": true,
"IsStateFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": "bc039d93-7294-49b9-b1b0-28ae62e60c88"
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "001",
"PrevReportedRecordId": "b46ee6c5-35d3-411a-a108-0852c3b642c4",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "6b3f7f2f-e5d1-4494-998c-76460a994fd1"
},
"CorrectedRecipientData": {
"TINType": "SSN",
"TIN": "242-24-7502",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
},
{
"Manifest": {
"SequenceId": "2",
"PrevReportedRecordId": "e981a0ea-3f85-4102-afee-7db4c0ead9fe",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": true
},
"PrevReportedRecipientData": {
"RecipientId": "878c5eea-1b9c-4ccd-b6e1-5b9d5e134338"
},
"CorrectedRecipientData": {
"TINType": "SSN",
"TIN": "533-34-7972",
"FirstPayeeNm": null,
"SecondPayeeNm": null,
"FirstNm": "Shawn",
"MiddleNm": null,
"LastNm": "Williams",
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "Ontario",
"Country": "CA",
"PostalCd": "4168682600"
},
"Email": "shawn@sample.com",
"Fax": "6634567890",
"Phone": "9634567890"
},
"Form5498SAData": {
"B1MSAContrib": 7000,
"B2TotalContrib": 0,
"B3TotalHSAorMSAIn2024": 0,
"B4RolloverContrib": 0,
"B5FMV": 880,
"B6AccType": "HSA",
"AccountNum": "2023REC01"
}
}
]
}
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 |
SubmissionId | Guid | Unique identifier of a submission |
BusinessId | Guid | Unique identifier of a Business. |
PayerRef | string | Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: ..50 |
Form5498Type | string | Denotes the type of 5498 form. |
Form5498SARecords | object | Pulls Form 5498 SA correction records with Success and Error statuses |
SuccessRecords | object[] | It will show the detailed information about the success status of Form 5498 SA correction Records |
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. |
PrevReportedRecordId | Guid | Record ID of the original Form 5498-SA which is given while creating Form 5498 SA correction. |
RecordId | Guid | An unique identifier generated by TaxBandits when a 5498-SA correction return is created. You can use this id for your future reference to Update. |
RecipientId | Guid | An unique identifier generated by TaxBandits for a Recipient when a 5498-SA correction return is created. You can use this id for your future reference to Update. |
FederalReturn | object | Returns the record status and StatusTs of federal return. |
Status | string | Returns the record status. |
StatusTs | string | Returns date and time of return created. |
Info | string | Returns information about the Federal Filing service. |
Errors | object[] | Shows error information of state returns of Form 5498 SA correction |
Postal | object | Returns the status and StatusTs of postal mailing service for Form 5498 SA correction. |
Status | string | Returns the status of postal order. |
StatusTs | string | Returns the date and time of the postal order created. |
Info | string | Returns the information about Postal mailing service. |
OnlineAccess | object | Returns the Email address for whom the online access to be given and Status of online access. |
Status | string | Returns status of online access for Form 5498 SA correction return. |
string | Email address for whom the online access to be given. | |
Info | string | Information about the online access service. |
ErrorRecords | object[] | It will show the detailed information about the error status of Form 5498 SA correction Records. |
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. |
RecordId | Guid | Unique identifier of a record |
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
- 200
- 300
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "c672df52-6d1e-45ba-8631-aff8339d7fa3",
"BusinessId": "bc039d93-7294-49b9-b1b0-28ae62e60c88",
"Form5498Type": "5498SACorrection",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "001",
"PrevReportedRecordId": "b46ee6c5-35d3-411a-a108-0852c3b642c4",
"RecordId": "c255de11-7c2a-4f5e-8411-8902911d328b",
"RecipientId": "6b3f7f2f-e5d1-4494-998c-76460a994fd1",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-28 14:29:26 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the recipient (or) business has foreign address"
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": null
},
"Errors": null
}
Multi-status Response - You'll get the below response when multiple statuses are included.
{
"StatusCode": 300,
"StatusName": "MultiStatus",
"StatusMessage": "Multiple statuses are available for the request",
"SubmissionId": "1e9f0431-03e0-43f4-8f70-f2ce9de8aebe",
"BusinessId": "fd846e96-1524-4e15-8c47-2d38b1d0b211",
"Form5498Type": "5498SACorrection",
"Form5498SARecords": {
"SuccessRecords": [
{
"SequenceId": "001",
"PrevReportedRecordId": "5bb3f492-9d41-4e47-a7b2-1dc8ab99acb7",
"RecordId": "e17bbc1e-c896-4e86-9c3d-b71964293de5",
"RecipientId": "46076efe-29c5-4d39-863d-4c37c8922b37",
"FederalReturn": {
"Status": "CREATED",
"StatusTs": "2024-06-28 14:56:07 -04:00",
"Info": null,
"Errors": null
},
"Postal": {
"Status": "NOTCREATED",
"StatusTs": null,
"Info": "Postal Alert cannot be opted for the return, when the recipient (or) business has foreign address"
},
"OnlineAccess": {
"Status": "NA",
"Email": null,
"Info": "This Service will be available soon"
}
}
],
"ErrorRecords": [
{
"SequenceId": "2",
"RecordId": null,
"Errors": [
{
"Id": "F68-100084",
"Name": "ReturnData.Manifest.PrevReportedRecordId",
"Message": "Correction return already exists for the given PrevReportedRecordId [5bb3f492-9d41-4e47-a7b2-1dc8ab99acb7]"
}
]
}
]
},
"Errors": [
{
"Id": "F00-100155",
"Name": "Error Records",
"Message": "Some of the records are errored. Please read the Error Records for more details."
}
]
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"BusinessId": null,
"Form5498Type": "5498SACorrection",
"Form5498SARecords": {
"SuccessRecords": null,
"ErrorRecords": [
{
"SequenceId": "001",
"RecordId": null,
"Errors": [
{
"Id": "F17-100022",
"Name": "ReturnData.5498SAFormData",
"Message": "5498SAFormData is required."
},
{
"Id": "F17-100024",
"Name": "ReturnData.5498SAFormData",
"Message": "The values in 5498SAFormData should be different from previous 5498SAFormData Return for amount correction"
}
]
}
]
},
"Errors": null
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}