Version: 1.7.3

GetbyRecordIds

POST Form5498/GetByRecordIds

Request Params

Field	Type	Description
RecordIds	object[]	Contains the object of RecordId.
RecordId	Guid	The unique identifier of the record. Provide the RecordId for which you need to obtain the information.

Request Params

{
    "RecordIds": [
        {
            "RecordId": "7e2b2902-fc16-4dce-bdfd-747617b35c77"
        },
        {
            "RecordId": "7e2b2902-fc16-4dce-bdfd-747617b35c77"
        }
    ]
}

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
Form5498Records	object	Contains information about Form 5498 returns.
SubmissionManifest	object	SubmissionManifest provides brief information about a particular submission on the whole. It contains information like Submission ID Tax Year IsPostal IsFederalFiling IsStateFiling IsOnlineAccess 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 5498 to be filed. Allowed values: "2022","2023","2024"
IsFederalFiling	Boolean	Federal Filing for the return will be enabled when the value is True. The Form 5498 will be sent directly to the IRS.
IsStateFiling	Boolean	State Filing for the return will be enabled when the value is True. Form 5498 forms 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.
IsPostal	Boolean	Postal Order will be created when the value is set as True. Once the return is Transmitted, Form 5498 Recipient copies will be postal mailed to the recipient'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 Recipient. The recipient can provide consent and download Form 5498 Recipient copies from the portal.
IsScheduleFiling	Boolean	When true, schedule filing services will be provided for Form 5498 returns under this submission.
ScheduleFiling	object	Contains preferred date to submit the returns to the IRS. Required only when "IsScheduleFiling" is True.
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	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
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 Individual Allowed values "Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"
IsEIN	Boolean	When true, identifies the business with an EIN.
EINorSSN	string	Returns the Employer Identification Number of Business Size Range: 9
Email	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/1099 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 Form 5498 and 94X series Allowed values "FEDERALGOVT", "STATEORLOCAL501C", "NONGOVT501C", "STATEORLOCALNON501C", "NONEAPPLY"
KindOfPayer	string	Optional Identifies the kind of payer. This field is mandatory in W-2 and optional in Form 5498 and 94X series Allowed 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 details.
RecordId	Guid	Unique identifier of a record. Not required when you are creating a return.
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 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 submission. 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 Form 5498 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.
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.
Recipient	object	Object to identify the recipient details.
RecipientId	Guid	An unique identifier generated by TaxBandits for a Recipient when a 5498 return is created. You can use this id for your future reference to Update.
TINType	string	Specify the TIN type of the recipient. 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
PayeeRef	string	A unique identifier for each payee completing their information.
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.
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.
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 Individual Allowed 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
Email	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
Form5498Data	object	Recipient's Form 5498 information.
B1IRAContrib	number	Form 5498 Box1. Gets contributions to a traditional IRA made in a given tax year Size Range: 0-9999999999.99
B2RolloverContrib	number	Form 5498 Box2. Gets rollover contributions (or contributions treated as rollovers) to any IRA received during the tax year. Size Range: 0-9999999999.99
B3RothIRAConversionAmt	number	Form 5498 Box3. Gets the amount converted from a traditional IRA, SEP IRA,or SIMPLE IRA to a Roth IRA during the tax year. Size Range: 0-9999999999.99
B4RecharacterizedContrib	number	Form 5498 Box4. Gets amounts recharacterized plus earnings from one type of IRA to another. Size Range: 0-9999999999.99
B5FMVofAccount	Boolean	Form 5498 Box5. Gets the FMV of the account as of December 31 for the specified tax year. Size Range: 0-9999999999.99
B6LifeInsInB1	number	Form 5498 Box6. Gets the amount included in 'B1IRAContrib' allocable to the cost of life insurance (For endowment contracts only). Size Range: 0-9999999999.99
B7FilingFor	string	Form 5498 Box7. Gets the retirement plan type. Allowed values "IRA", "SEP", "SIMPLE", "ROTH_IRA"
B8SEPContrib	number	Form 5498 Box8. Gets employer contributions made to a SEP IRA (including salary deferrals under a SARSEP) during tax year. Size Range: 0-9999999999.99
B9SIMPLEContrib	number	Form 5498 Box9. Gets employer contributions, including salary deferrals, made to a SIMPLE IRA during tax year. Size Range: 0-9999999999.99
B10RothIRAContrib	number	Form 5498 Box10. Gets contributions made to a Roth IRA in tax year. Size Range: 0-9999999999.99
B11IsRMDfor2024	Boolean	Form 5498 Box11. When true, For the year in which the IRA participant reaches age 72, even though the RMD for that year need not be made until April 1 of the following year.
B12aRMDDate	number	Form 5498 Box12. Gets RMD date if using Form 5498 to report the additional information. format: MM/DD/YYYY
B12bRMDAmt	number	Form 5498 Box12b. Gets RMD amount if you are using Form 5498. Size Range: 0-9999999999.99
B13aLateContrib	number	Form 5498 Box13a. Gets amount of any postponed contribution made during the tax year for a previous year. Size Range: 0-9999999999.99
B13bYear	number	Form 5498 Box13b. Gets the year for which the postponed contribution in box13a was made. Size Range: 0-9999999999.99
B13cCode	number	Form 5498 Box13c. Gets the reason the participant made the postponed contribution. Allowed values "FD", "PL", "EO", "PO","SC"
B13dPostponeReason	number	Form 5498 Box13d. Gets the federally declared disaster area, public law number or executive order number under which the postponed contribution is being issued. Size Range: 0-6
B14aRepymt	number	Form 5498 Box14a. Gets the amount of any repayment of a qualified reservist distribution, a qualified disaster distribution, or a qualified birth or adoption distribution. Size Range: 0-9999999999.99
B14bCode	number	Form 5498 Box14b. Gets “QR” for the repayment of a qualified reservist distribution, “DD” for repayment of a qualified disaster distribution, or “BA” for repayment of a qualified birth or adoption distribution.
B15aFMVofAssets	number	Form 5498 Box15a. Gets the FMV of the investments in the IRA.
B15bCode	number	Form 5498 Box15b. Gets the code for the type(s) of investments held in the IRA for which the FMV is reported in box 15a. A maximum of two codes can be entered in box 15b. Allowed values "A", "B", "C", "D","E", "F", "G","H" with "A" to "H" maximum 2 letters"
AccountNum	number	Gets account number of Payer having multiple accounts for a recipient for whom more than one Form 5498 is filed. Size Range: 4..20
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",
    "Form5498Records": [
        {
            "SubmissionManiFest": {
                "SubmissionId": "f14cf437-c3a3-4413-8ea6-bea04613ffbf",
                "TaxYear": "2024",
                "IsFederalFiling": true,
                "IsStateFiling": null,
                "IsPostal": true,
                "IsOnlineAccess": true,
                "IsScheduleFiling": false,
                "ScheduleFiling": null
            },
            "ReturnHeader": {
                "Business": {
                    "BusinessId": "6c1f489f-7f6f-4853-a269-b6149ff2f4f4",
                    "PayerRef": null,
                    "BusinessNm": null,
                    "FirstNm": "James",
                    "MiddleNm": null,
                    "LastNm": "Smith",
                    "Suffix": null,
                    "TradeNm": null,
                    "IsEIN": false,
                    "EINorSSN": "804-66-3137",
                    "Email": "james@sample.com",
                    "ContactNm": "John",
                    "Phone": "(998) 655-4045",
                    "PhoneExtn": "32154",
                    "Fax": "(858) 812-5864",
                    "BusinessType": "ESTE",
                    "SigningAuthority": {
                        "Name": "James Smith",
                        "Phone": "(962) 777-6807",
                        "BusinessMemberType": "ADMINISTRATOR"
                    },
                    "KindOfEmployer": "FEDERALGOVT",
                    "KindOfPayer": "REGULAR941",
                    "IsBusinessTerminated": false,
                    "IsForeign": false,
                    "USAddress": {
                        "Address1": "3521 AIRPORT WAY",
                        "Address2": "UNIT 9",
                        "City": "AK",
                        "State": "AK",
                        "ZipCd": "99709"
                    },
                    "ForeignAddress": null,
                    "ACADetails": null
                }
            },
            "ReturnData": [
                {
                    "RecordId": "b95e4183-bf8d-4812-a808-199823ced336",
                    "SequenceId": "1",
                    "IsPostal": false,
                    "IsOnlineAccess": true,
                    "Recipient": {
                        "RecipientId": "eff36c38-4592-427a-8405-dfa187cde82e",
                        "TINType": "SSN",
                        "TIN": "141-26-4749",
                        "PayeeRef": "Payee001",
                        "FirstPayeeNm": null,
                        "SecondPayeeNm": null,
                        "FirstNm": "Shawn",
                        "LastNm": "Willams",
                        "MiddleNm": null,
                        "Suffix": null,
                        "IsForeign": true,
                        "USAddress": null,
                        "ForeignAddress": {
                            "Address1": "SECOT 34",
                            "Address2": "4TH AVENUE",
                            "City": "ONTARIO",
                            "ProvinceOrStateNm": "ONTARO",
                            "Country": "CA",
                            "PostalCd": "DAS 858"
                        },
                        "Email": "shawn@sample.com",
                        "Fax": "(573) 861-7739",
                        "Phone": "(457) 339-0118"
                    },
                    "Form5498Data": {
                        "B1IRAContrib": "4990.00",
                        "B2RolloverContrib": "350.00",
                        "B3RothIRAConversionAmt": "4000.00",
                        "B4RecharacterizedContrib": "500.00",
                        "B5FMVofAccount": "950.00",
                        "B6LifeInsInB1": "750.00",
                        "B7FilingFor": "IRA",
                        "B8SEPContrib": "5000.00",
                        "B9SIMPLEContrib": "650.00",
                        "B10RothIRAContrib": "480.00",
                        "B11IsRMDfor2024": false,
                        "B12aRMDDate": "11/12/2023",
                        "B12bRMDAmt": "650.00",
                        "B13aLateContrib": "850.00",
                        "B13bYear": "2023",
                        "B13cCode": "FD",
                        "B13dPostponeReason": "B675OP",
                        "B14aRepymt": "150.00",
                        "B14bCode": "QR",
                        "B15aFMVofAssets": "980.00",
                        "B15bCode": "BH",
                        "AccountNum": "654987"
                    }
                }
            ]
        }
    ],
    "Errors": null
}

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