Status

This endpoint is used to retrieve the status of the BOI Report created in TaxBandits. To get the status of the report, you'll need to include the Submission ID or Report Number in your request. The response will include the states listed below,

• Created: BOIR has been created and has not yet been transmitted by the user.
• Transmitted: BOIR has been transmitted by the user.
• Accepted: BOIR is accepted by the FinCEN.
• Rejected: BOIR is rejected by the FinCEN due to some errors. Please correct the errors and retransmit them.

GETBOIR/Status

Request Params

Field	Type	Description
SubmissionId	Guid	Provide the SubmissionId (unique identifier created by TaxBandits for a submission) to identify for which submission needs to get the status. Either SubmissionId or ReportNumber can be provided to Get the status.
ReportNumber	string	Provide the ReportNumber (unique identifier created by TaxBandits for a report) to identify for which report to get the status

Request Params

Sample 1

Request using SubmissionId.

BOIR/Status?SubmissionId=954cdad5-3b8a-4123-9052-8beba4be5376

Sample 2

Request using ReportNumber.

BOIR/Status?ReportNumber=109685

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	Returns the SubmissionId of the report.
ReportNumber	number	Returns the Report Number for which the request was made.
ReportType	string	The type of the report created in the submission.
ReportStatus	string	Returns the current status of the Report.
FilingReference	object	Returns the details of the report where its filed.
FiledWith	String	Returns the details where the report is filed.
BOIRId	String	Returns the BOIRId received from the fincen.
SubmissionTrackingId	String	Returns the SubmissionTrackingId received from the fincen.
BOITranscript	String	Returns the BOITranscript once the return is accepted.
FinCENID	String	Returns the FinCENID which is sent from the Fincen.
StatusTs	string	Date and time of the report created.
RejectedBy	string	Returns the details of who has rejected the report.
RejectionError	object	Returns the reason for the rejection of report by the fincen.
Code	String	Returns the Rejected error code.
Message	String	Returns the reason for the rejection of the report.
Errors	object[]	Object that provides the collection of error information in the request.
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the description of the error message.

Response json

200

This is a sample response for successful API requests.

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "a232b5fe-b6cb-4bc7-a17a-0d907811e56c",
    "ReportNumber": "109735",
    "ReportType": "INITIAL",
    "ReportStatus": "REJECTED",
    "FilingReference": {
        "FiledWith": "FinCEN",
        "BOIRId": null,
        "SubmissionTrackingId": "235235",
        "BOITranscript": "https://s3.amazonaws.com/expressirsforms.com/UserFiles/66a2a4692b4686925b996281/efileBoir/Transcript/c88a2e8f-f44f-40f4-bf61-5d85478eada7/BOIRKEvL8YLsCgmsU9aq.pdf",
        "FinCENID": null
    },
    "StatusTime": "2024-07-22T06:49:48.4429266-04:00",
    "RejectedBy": "FinCEN",
    "RejectionError": [
        {
            "Code": "SBE02",
            "Message": "Initial BOIR already has been filed for the reporting company, Multiple submissions for Initial Report are not allowed by FinCEN."
        }
    ],
   "Errors": null
}

400

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,
    "ReportNumber": null,
    "ReportType": null,
    "ReportStatus": null,
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1624",
            "Name": "SubmissionId",
            "Message": "Either SubmissionId or ReportNumber is required"
        }
    ]
}

401

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-100026",
            "Name": "Authorization ",
            "Message": "Authorization Failed"
        }
    ]
}

404

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",
    "SubmissionId": "fe061e50-1fbc-41d2-bad8-f1970d74ed9",
    "ReportNumber": null,
    "ReportType": null,
    "ReportStatus": null,
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1623",
            "Name": "SubmissionId",
            "Message": "Invalid Submission Id"
        }
    ]
}