Get
Retrieves the 1098 Correction return information based on the Submission ID given in the request.
GET Form1098Correction/Get 
Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | An unique identifier generated by TaxBandits when a 1098 return is created. Mention the Form 1098 return's Record ID that you want to Get. |
Request Params
- Sample 1
- Sample 2
Get with only the SubmissionID
"Form1098Correction/Get?SubmissionId=9b93d963-7ab8-4967-b766-997fa5d63c20"
Get with SubmissionID and 2 RecordIDs
"Form1098Correction/Get?SubmissionId=9b93d963-7ab8-4967-b766-997fa5d63c20&RecordIds=9ecfd957-cd3b-44a2-a08a-326f36c07bef,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 |
| Form1098Records | object | Contains information about Form 1098 returns. |
| SubmissionManifest | object | SubmissionManifest provides brief information about a particular submission on the whole. It contains information like
|
| SubmissionId | Guid | Unique identifier created by TaxBandits for each submission. Not required when you are creating a return. |
| TaxYear | string | Tax year of Form 1098 Correction to be filed.Allowed values |
| IsFederalFiling | Boolean | Federal Filing for the return will be enabled when the value is True. Form 1098 Correction will be e-filed to the IRS. |
| IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, the 1098 correction 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 set to the Recipient. The recipient can provide consent and download the 1098 correction Recipient copies on the portal. |
| 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. |
| 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 |
| 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 |
| 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 Taxpayer Identification Number of the Business Size Range: 9 |
| string | Optional 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 | Optional 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 |
| 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 |
| KindOfEmployer | string | Identifies the kind of employer. Mandatory for W-2 and optional for 1098 and 94X seriesAllowed values |
| KindOfPayer | string | Identifies the kind of payer. This field is mandatory in W-2 and optional in 1098 and 94X seriesAllowed values |
| 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 |
| 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 |
| PostalCd | string | Employer/Payer's postal code Size Range: ..16 |
| ReturnData | object[] | Contains information about the recipient details and Form 1098 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 | Returns the PrevReportedRecordId given in the Request |
| RecordId | Guid | This Record ID is for the 1098 Correction. It will be generated and provided in the Response after you create the correction form. |
| CorrectionType | string | Provide the type of correction you are filing for the recipient. Allowed values |
| IsPostal | Boolean | Postal Order will be created when the value is set as True. Once the return is Transmitted, the 1098 correction 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 set to the Recipient. The recipient can provide consent and download the 1098 correction Recipient copies on the portal. |
| PrevReportedRecipientData | object | The Recipient information that was submitted in the Original Form 1098. The information is not required if you have provided the PrevReportedRecordId. |
| RecipientId | 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. |
| TINType | string | Specify the TIN type of the recipient.Allowed values |
| TIN | string | The nine-digit taxpayer identification number of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
| 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 | 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 |
| 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 | 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 |
| 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 | 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 |
| PostalCd | string | Recipient's Postal Code. Size Range: ..16 |
| string | Optional Recipient's email address. Size Range: 0..100 | |
| Fax | string | 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.Allowed values |
| TIN | string | Corrected TIN of the Recipient (SSN, ITIN, ATIN, or EIN). Size Range: 9 |
| FirstPayeeNm | string | Corrected First Payee Name |
| SecondPayeeNm | string | Corrected Second Payee Name |
| 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 |
| 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 |
| 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 |
| PostalCd | string | Recipient's Postal Code Size Range: ..16 |
| string | Optional Recipient's email address. Size Range: 0..100 | |
| Fax | string | Recipient's Fax number. Size Range: 10 |
| Phone | string | Optional Recipient's Phone Number. Size Range: 10 |
| Form1098Data | object | The Form1098Data requirement varies based on the CorrectionType. Read the instructions below to fill the Form1098Data for different Correction Types. VOID - The Form1098Data values should be zero. Provide the Account number (AccountNum) alone, if it was provided on the original return, AMOUNT - Provide the Corrected Form 1098 data. Include all the actual amount for all the box number even if you are correcting a specific box value, RECIPIENT - Provide the Form 1098 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 1099-DIV data. Include all the actual amount for all the box number even if you are correcting a specific box value. |
| B1IntRec | number | Mortgage Interest Received from recipient Size Range: 0-9999999999.99 |
| B2OutPrin | number | Outstanding Mortgage Principal Size Range: 0-9999999999.99 |
| B3OrgDate | string | Date of the origination of the mortgage. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 01/25/2025 or 01-25-2025 |
| B4RfdPd | number | Optional Total refund or credit of a prior year(s) overpayment of interest Size Range: 0-9999999999.99 |
| B5MIP | number | OptionalTotal Mortgage Insurance Premiums paid by the recipient Size Range: 0-9999999999.99 |
| B6PtsPd | number | OptionalPoints paid on the purchase of the recipient's principal residence Size Range: 0-9999999999.99 |
| B7PropAddSameAsRec | Boolean | When true, identifies that the address of the property securing the mortgage is the same as the recipient's mailing address. When false, provide the address or Description of the Property Securing Mortgage in B8PropDescr. |
| B8PropDescr | object | If 'B7PropAddSameAsRec' is False, provide the address or Description of the Property Securing Mortgage. |
| Descr | string | Description of the property securing the mortgage. Size Range: 100 |
| 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 | US address (street address or post office box of that locality) Size Range: ..46 |
| Address2 | string | OptionalMortgage property's suite or apartment Size Range: ..46 |
| City | string | Mortgage property's city Size Range: ..50 |
| State | string | Mortgage property's state code. Refer Static values. Size Range: 2 Allowed values |
| ZipCd | string | Mortgage property's zip code. |
| ForeignAddress | object | If IsForeign is true, pass foreign address of the Mortgage property |
| Address1 | string | Mortgage property's foreign address (street address or post office box of that locality) Size Range: ..50 |
| Address2 | string | Optional Mortgage property's suite or apartment Size Range: ..50 |
| City | string | Mortgage property's city Size Range: ..50 |
| ProvinceOrStateNm | string | Mortgage property's province or state name Size Range: ..50 |
| Country | string | Mortgage property's country Size Range: 2 Allowed values |
| PostalCd | string | Mortgage property's postal code Size Range: ..16 |
| B9NumOfProp | number | Optional Total number of properties secured by the particular mortgage Size Range: 0-9999 |
| B10Other | string | Optional Any other item lender wish to report to the recipient, such as real estate taxes, insurance paid from escrow etc. Size Range: ..39 |
| B11AcqDate | string | Optional If lender acquired the mortgage in the calendar year, enter the date of acquisition. Enter the date in the format: MM/DD/YYYY or MM-DD-YYYY Example: 01/25/2025 or 01-25-2025 |
| AccountNum | string | Account number of lender having multiple accounts for a recipient for whom more than one Form 1098 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. |
| 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
- 404
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"Form1098Records": {
"SubmissionManifest": {
"SubmissionId": "9b93d963-7ab8-4967-b766-997fa5d63c20",
"TaxYear": "2024",
"IsFederalFiling": true,
"IsPostal": true,
"IsOnlineAccess": true
},
"ReturnHeader": {
"Business": {
"BusinessId": "52fee3c3-3ddf-4b96-814f-2b6e94799483",
"PayerRef": "Snow123",
"BusinessNm": "Snowdaze LLC",
"FirstNm": null,
"MiddleNm": null,
"LastNm": null,
"Suffix": null,
"TradeNm": "BrightFuture",
"IsEIN": true,
"EINorSSN": "65-7369200",
"Email": "james@sample.com",
"ContactNm": null,
"Phone": "(123) 456-7890",
"PhoneExtn": "12345",
"Fax": "(123) 456-7890",
"BusinessType": null,
"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,
"ACADetails": null
}
},
"ReturnData": [
{
"Manifest": {
"SequenceId": "72305",
"PrevReportedRecordId": "9ae90a42-b8fd-4f0f-a03d-44f31b4b726b",
"RecordId": "9ecfd957-cd3b-44a2-a08a-326f36c07bef",
"CorrectionType": "RECIPIENT_AMOUNT",
"IsPostal": true,
"IsOnlineAccess": false
},
"PrevReportedRecipientData": {
"RecipientId": "c317648a-f591-4572-ad1c-66ed8e8e9675",
"TINType": "EIN",
"TIN": "39-3817572",
"PayeeRef": null,
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"LastNm": null,
"MiddleNm": 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+1@sample.com",
"Fax": "6834567890",
"Phone": "(763) 456-7890"
},
"CorrectedRecipientData": {
"TINType": "EIN",
"TIN": "36-3814509",
"FirstPayeeNm": "Dairy Delights LLC",
"SecondPayeeNm": "Coco Milk",
"FirstNm": null,
"LastNm": null,
"MiddleNm": null,
"Suffix": null,
"IsForeign": true,
"USAddress": null,
"ForeignAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "Toronto",
"ProvinceOrStateNm": "ONTARIO",
"Country": "CA",
"PostalCd": "416868260"
},
"Email": "Shawn+1@sample.com",
"Fax": "6834567890",
"Phone": "(763) 456-7890"
},
"Form1098Data": {
"B1IntRec": 10000,
"B2OutPrin": 750,
"B3OrgDate": "03/04/2023",
"B4RfdPd": 700,
"B5MIP": 700,
"B6PtsPd": 2000,
"B7PropAddSameAsRec": false,
"B8PropDescr": {
"Descr": "Bremne",
"IsForeign": false,
"USAddress": {
"Address1": "120 Bremner Blvd",
"Address2": "Suite 800",
"City": "FAIRBANKS",
"State": "AK",
"ZipCd": "99709"
},
"ForeignAddress": null
},
"B9NumOfProp": 0,
"B10Other": "Residential tax paid for the recipient",
"B11AcqDate": null,
"AccountNum": "20123130000009000001"
}
}
]
},
"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",
"Form1098Records": null,
"Errors": [
{
"Id": "F00-100146",
"Name": "Submission Id",
"Message": "Submission Id is invalid"
}
]
}