List

This endpoint can be used to retrieve the list of BOI reports created in TaxBandits. You can retrieve the results based on reporting company, report type, SubmissionId, and various other parameters between a specified period.

GETBOIR/List

Request Params

Field	Type	Description
SubmissionId	Guid	SubmissionId is a unique identifier created by TaxBandits for a particular submission.
ReportNumber	string	Provide the ReportNumber (a unique identifier created by TaxBandits for a report) to retrieve a particular BOI report.
ReportType	string	Provide the type of BOI Report which needs to be listed. Allowed values INITIAL, UPDATE, CORRECT, NEWLYEXEMPT
TINType	string	List the BOIR reports based on the given TINType and TIN of the reporting company.
TIN	string	List the BOIR reports based on the given TIN of the reporting company.
Page	number	Pulls the records listed on the page selected
PageSize	number	Number of BOIR reports to be listed in each page.
FromDate	string	Enter a start date from which the BOIR Reports must be listed in MM/DD/YYYY format.
ToDate	string	Enter the end date until which the BOIR Reports must be listed in MM/DD/YYYY format.

Request Params

List the BOI reports based on the given parameters.

BOIR/list?Page=1&PageSize=1&TINType=EIN&TIN=349756386&FromDate=10/01/2024&ToDate=10/01/2024&SubmissionId=45b79a0b-0912-479c-a942-2ae26d023b06&ReportNumber=113186&ReportType=INITIAL

Response Body

Field	Type	Description
StatusCode	number	Returns the HTTP status codes (e.g., 200, 300, etc.).
StatusName	string	Name of the status code.
StatusMessage	string	Provides a detailed message for the status code.
ReportType	string	The type of the report created in the submission.
BOIRRecords	object[]	Pulls BOIR (Beneficial Ownership Information Reporting) records with both Success and Error statuses.
SubmissionId	Guid	Returns the SubmissionId of the report.
ReportNumber	number	Returns the Report Number for which the request was made.
ReportingCompanyId	Guid	Provides the unique identifier of the Reporting Company for which the request is made.
LegalNm	string	Returns the Legal name of the Reporting company created in the submission.
TINType	string	Provides the TIN Type provided when creating the report.
TIN	string	Provides the TIN of the Reporting company.
IsCompanyFormedBefore2024	boolean	Returns the company formation details.
IsForeignPooled	boolean	Returns the Foreign pooled information of the Reporting company as given in the submission.
CompanyApplicants	object[]	Shows the detailed information of Company Applicants provided in the BOI Report.
SequenceId	Guid	Returns the sequenceId provided in the submission.
CompanyApplicantId	Guid	Returns the unique identifier of the Company Applicant.
FinCENID	string	Returns the FinCEN Id of the Company Applicant, if provided.
FirstNm	string	Returns the First name of the Company Applicant as given in the submission.
LastNm	string	Returns the Last name of the Company Applicant as given in the submission.
Attachment	string	Returns the identifying document attached for the Company Applicant in base64 URL format.
BeneficialOwners	object[]	Shows the detailed information of Beneficial Owners provided in the BOI Report.
SequenceId	string	Returns the sequenceId provided in the submission.
BeneficialOwnerId	Guid	Returns the unique identifier of the Beneficial Owner.
BORef	String	Provides the unique referenceId of the Beneficial Owner if provided in your request. Note: This is returned only for the BO/RequestByEmail endpoint.
FinCENID	string	Returns the FinCEN Id of the Beneficial Owner if provided.
LegalNm	string	Returns the legal name of the Beneficial Owner.
IsExemptEntity	boolean	Returns whether the Beneficial Owner is an Exempt entity.
ExemptEntityInformation	object	Returns the information of the Beneficial Owner as an Exempt entity.
EntityLegalNm	string	Returns the entity's legal name of the Beneficial Owner as given in the submission.
IndividualLastNm	string	Returns the individual’s last name of the Beneficial Owner as given in the submission.
FirstNm	string	Returns the first name of the Beneficial Owner as given in the submission.
LastNm	string	Returns the last name of the Beneficial Owner as given in the submission.
Attachment	string	Returns the identifying document attached for the Beneficial Owner in base64 URL format.
Errors	object[]	Provides a collection of error information in the request.
Id	string	Returns the unique error ID assigned by TaxBandits for each error.
Name	string	Name of the errored node.
Message	string	Shows the description of the error message.

Response Body

200

This is a sample response for successful API requests.

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "ReportType": "INITIAL",
    "BOIRRecords": {
        "SubmissionId": "45b79a0b-0912-479c-a942-2ae26d023b06",
        "ReportNumber": "113186",
        "ReportingCompanyId": "18011445-62cb-4b5d-b51d-e2225a638217",
        "LegalNm": "Snowdaze LLC",
        "TINType": "EIN",
        "TIN": "349756386",
        "IsCompanyFormedBefore2024": false,
        "IsForeignPooled": false,
        "CompanyApplicants": [
            {
                "SequenceId": "1",
                "CompanyApplicantId": "fdbccb4e-3c62-48d8-8e28-94dc36b0500b",
                "FinCENID": null,
                "FirstNm": "Shawn",
                "LastNm": "Williams",
                "Attachment": "https://expressirsforms.s3.amazonaws.com/pdfs/66fba5b6738372f3b379fb96/boir/ca/fdbccb4e-3c62-48d8-8e28-94dc36b0500b_17277687350.pdf"
            }
        ],
        "BeneficialOwners": [
            {
                "SequenceId": "1",
                "BeneficialOwnerId": "bfc03776-1d2f-4f80-bd6b-b55d322bbe04",
                "BORef": "66fba7f1e0bef3aae8193b13",
                "FinCENID": null,
                "LegalNm": null,
                "IsExemptEntity": false,
                "ExemptEntityInformation": {
                    "EntityLegalNm": null,
                    "IndividualLastNm": null
                },
                "FirstNm": "Chandler",
                "LastNm": "Smith",
                "Attachment": "https://expressirsforms.s3.amazonaws.com/pdfs/66fba5b6738372f3b379fb96/boir/bo/bfc03776-1d2f-4f80-bd6b-b55d322bbe04_17277687289.pdf"
            }
        ]
    },
    "Page": 1,
    "TotalRecords": 1,
    "TotalPages": 1,
    "PageSize": 1,
    "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",
    "ReportType": null,
    "BOIRRecords": null,
    "TotalRecords": 0,
    "TotalPages": 0,
    "Page": 0,
    "PageSize": 0,
    "Errors": [
        {
            "Id": "BOI-ER-1717",
            "Name": "FromDate",
            "Message": "From Date is required in the date format (MM/DD/YYYY)"
        }
    ]
}

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",
    "ReportType": "INITIAL",
    "BOIRRecords": null,
    "TotalRecords": 0,
    "TotalPages": 0,
    "Page": 0,
    "PageSize": 0,
    "Errors": [
        {
            "Id": "BOI-ER-1623",
            "Name": "SubmissionId",
            "Message": "Invalid Submission Id"
        }
    ]
}