Skip to main content
Version: 1.7.3

Status

It will give you an overview of the status of your Form 1098 returns. To get this, you'll need to submit the Submission ID and RecordIds. In response, the specific return status will be listed for state filing, federal filing, online access and postal mailing status 

Federal​

  • CREATED - Form 1098 has been created and has not yet been transmitted.
  • TRANSMITTED - Form 1098 has been transmitted by the user.
  • SENT TO AGENCY - Form 1098 has been sent to the IRS, and we are waiting for the result from the IRS.
  • ACCEPTED - Form 1098 is accepted by the IRS.
  • REJECTED - Form 1098 is rejected by the IRS due to some errors. The user must correct the errors and retransmit the forms.
  • ACCEPTED WITH ERRORS - The IRS has accepted the return with some validation errors, and a correction must be filed as soon as possible with the correct information.

Postal Mailing​

  • CREATED - Postal mailing opted for the 1098 Forms.
  • SENT - Form copies are mailed to the recipients.
  • RECEIVED - Form copies are received by the recipients.
  • NOTCREATED - Postal mailing wasn't opted. To opt for postal mailing, the 'IsPostalMailing' in the submission manifest of the Create request must be set to TRUE.

Online Access​

  • CREATED - Online Access opted for the 1098 forms, and the secure link to download form copies forms will be emailed to the recipients as soon as the form is transmitted.
  • ORDER_RECIEVED - An order for online access has been received, and the email will be sent to the recipient soon.
  • EMAIL_SENT - A secure link to download form copies has been emailed to the recipients.
  • DOWNLOADED_FORM - The recipient successfully viewed and downloaded the form.
  • VIEWED_FORM - The Recipient has successfully viewed the form.
GET Form1098/Status
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsstringNumber of record Ids to get status.

Request Param

Get status with only the SubmissionID

"Form1098/status?SubmissionId=b77babf6-5855-41dd-9495-f0879ce832af"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of a Payer.
Form1098TypestringDenotes the type of 1098 form.
Form1098RecordsobjectPulls Form 1098 records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1098 Records
        SequenceIdstringA 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.
        RecordIdGuidAn unique identifier generated by TaxBandits when a 1098 return is created.
        RecipientIdGuidA unique identifier generated by TaxBandits for a Recipient when a 1098 return is created. You can use this id for your future reference to Update.
        PayeeRefstringA unique identifier for each payee completing their information.
        AccountNumstringAccount number of Payer having multiple accounts for a recipient for whom more than one Form 1098 is filed.
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.
        FederalReturnobjectReturns the record status and StatusTs of federal return.
            StatusstringReturns the record status.
            StatusTsstringReturns date and time of return created.
            InfostringReturns information about the Federal Filing service.
            Errorsobject[]Shows error information in state returns of Form 1098
                IdstringReturns the validation error Id.
                NamestringName of the validation error.
                MessagestringDescription of the validation error.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 1098.
            StatusstringReturns the status of postal order.
            StatusTsstringReturns the date and time of the postal order created.
            InfostringReturns the information about Postal mailing service.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 1098 return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
        ScheduleFilingobjectReturns the date of the schedule filing.
            ScheduledOnstringDate of the schedule filing to know when the return to be filed to the IRS.
            InfostringInformation about Schedule Filing service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 1098 Records.
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription 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",
  "SubmissionId": "b77babf6-5855-41dd-9495-f0879ce832af",
  "BusinessId": "129bc397-2fdf-4318-ac39-d89112443e91",
  "PayerRef": "WEYCF8FBAV",
  "Form1098Type": "1098",
  "Form1098Records": {
    "SuccessRecords": [
      {
        "SequenceId": "1",
        "RecordId": "71b7db23-64a1-4c0b-9414-e7ecc0d8df41",
        "RecipientId": "2d3b7444-a3a1-4a46-ac5d-311f02d8d16a",
        "PayeeRef": "Payee001",
        "AccountNum": "20241520058563079953",
        "FederalReturn": {
          "Status": "CREATED",
          "StatusTs": "2023-05-11 07:03:50 +00:00",
          "Info": null,
          "Errors": null
        },
        "Postal": {
          "Status": "CREATED",
          "StatusTs": "2023-05-11 07:03:50 +00:00",
          "Info": null
        },
        "OnlineAccess": {
          "Status": "CREATED",
          "Email": "shawn@sample.com",
          "Info": null
        },
        "ScheduleFiling": {
          "ScheduledOn": null,
          "Info": "This service will be available soon"
        }
      }
    ],
    "ErrorRecords": null
  },
  "Errors": null
}