Transmit

This endpoint should be used to submit the BOI report to FinCEN. In your request JSON, provide the SubmissionId or Report Number. Note that after transmitting the report, it cannot be edited or deleted.

note

Before submitting a BOI report, make sure that the necessary identification documents are attached for both the Company Applicant and the Beneficiary Owner.

POSTBOIR/Transmit

Request Body

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

Request JSON

Sample 1

Request using SubmissionId.

{
  "SubmissionId": "e081f20f-6f4f-4984-a369-bf409cc59a8a",
  "ReportNumber": null
}

Sample 2

Request using ReportNumber.

{
  "SubmissionId": null,
  "ReportNumber": "100039"
}

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	Unique identifier provided by TaxBandits for each success submission.
ReportNumber	number	Unique identifier provided by TaxBandits for each success report in reference to view the report in TaxBandits application
ReportType	string	The type of the report created in the submission
ReportingCompanyId	Guid	Unique identifier provided by TaxBandits for each successfully added Reporting Company.
BOIRRecords	object	Pulls BOIR records with Success and Error statuses
SuccessRecords	object	It will show the detailed information about the success status of BOIR Report
ReportStatus	string	Provides the Status of the report
CreatedTs	string	Return created date and time
UpdatedTs	string	Return updated date and time
ErrorRecords	object[]	Object that provides the collection of error information in Return Data
CompanyApplicants	object[]	Pulls the information of errored node under the object Company Applicant
SequenceId	string	A unique reference ID for the Company Applicant provided in the request to identify a particular applicant's error in the request
Errors	object[]	Object that provides the collection of error information in Company Applicant
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
BeneficialOwners	object[]	Pulls the information of errored node under the object Beneficial Owners
SequenceId	string	A unique reference ID for the Beneficial Owner provided in the request to identify a particular owner's error in the request
Errors	object[]	Object that provides the collection of error information in Beneficial Owners
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
SubmitterInformation	object[]	Pulls the information of errored node under the object Submitter Information
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
Errors	object[]	Object that provides the collection of error information in Return Header
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": "d6d5511a-9cfc-4905-94e8-98c59561f5a8",
    "ReportNumber": "110002",
    "ReportType": "INITIAL",
    "ReportingCompanyId": "ba7633b3-3a23-4e5c-828d-1a73b8c8070e",
    "BOIRRecords": {
        "SuccessRecords": {
            "ReportStatus": "TRANSMITTED",
            "CreatedTs": "2024-08-08 03:09:05 -04:00",
            "UpdatedTs": "2024-08-08 03:09:05 -04:00"
        },
        "ErrorRecords": null
    },
    "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": "c1ae12d2-16a1-4230-8fbc-4a4949ee1a89",
    "ReportNumber": null,
    "ReportType": "INITIAL",
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1621",
            "Name": "Report Number, Submission ID",
            "Message": "Submission ID Not Linked with Report Number"
        }
    ]
}

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"
        }
    ]
}

402

Insufficient credits.

{
    "StatusCode": 402,
    "StatusName": "CreditsNotSufficient",
    "StatusMessage": "The Credit in your account is not sufficient to transmit the requested reports",
    "SubmissionId": "2e7dd7ff-2101-4bbb-8b5d-42b967980ad8",
    "ReportNumber": "101573",
    "ReportType": "INITIAL",
    "ReportingCompanyId": "f4b7496e-a8c5-4dbf-a3a4-d66660b26af6",
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1626",
            "Name": "SubmissionId",
            "Message": "InSufficient Credits"
        }
    ]
}