Skip to main content
Version: 1.7.3

Status

This method will return the current status of Form 3922 for a particular submission or for a particular recipient.

Federal​

  • CREATED - Form 3922 has been created and has not yet been transmitted.
  • TRANSMITTED - Form 3922 has been transmitted by the user.
  • SENT TO AGENCY - Form 3922 has been sent to the IRS, and we are waiting for the result from the IRS.
  • ACCEPTED - Form 3922 is accepted by the IRS.
  • REJECTED - Form 3922 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 3922 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 3922 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 Form3922/status

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdGuid[]Optional An unique identifier generated by TaxBandits when a 3922 return is created.

Request Params

Get status with only the SubmissionID

"Form3922/Status?SubmissionId=9b65b95a-9e23-4c3a-91a5-41bab5580606"

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 the payer.
FormTypestringDenoted the Form Type.
Form3922RecordsobjectPulls Form 3922 records with Success and Error statuses
    SuccessRecordsobject[]It will show detailed information about the success status of Form 3922 Records
        SequenceIdstringAn 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.
        RecordIdGuidA unique identifier generated by TaxBandits when a 3922 return is created.
        RecipientIdGuidAn unique identifier generated by TaxBandits for a Recipient when a 3922 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 3922-NEC 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.
        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 3922.
        PostalobjectReturns the status and StatusTs of postal mailing service for Form 3922 .
            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 3922 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 3922 Records.
        SequenceIdstringAn 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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows detailed error information
            IdstringReturns the validation error Id
            NamestringName of the validation error
            MessagestringDescription of the validation error
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": "9b65b95a-9e23-4c3a-91a5-41bab5580606",
    "BusinessId": "b594606b-c9fd-49ff-8d15-46d0ae3a76fb",
    "PayerRef": "Snow12",
    "FormType": "3922",
    "Form3922Records": {
        "SuccessRecords": [
            {
                "SequenceId": "1",
                "RecordId": "cb4bbdd1-4cee-45ec-995c-9fed9e23c708",
                "RecipientId": "7a429d4a-f22d-4c96-a776-76faac7348e0",
                "AccountNum": "20243590062021081794",
                "PayeeRef": null,
                "FederalReturn": {
                    "Status": "CREATED",
                    "StatusTs": "2024-12-24 04:17:27 -05:00",
                    "Info": null,
                    "Errors": null
                },
                "Postal": {
                    "Status": "CREATED",
                    "StatusTs": "2024-12-24 04:17:27 -05:00",
                    "Info": null
                },
                "OnlineAccess": {
                    "Status": "CREATED",
                    "Email": "mark@sample.com",
                    "Info": null
                },
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}