Get

This endpoint can be used to retrieve information from the BOI Report created in TaxBandits. The request must include the SubmissionId or Report Number. The response will include the report data, including the reporting company, company applicants, and beneficial owners details.

GETBOIR/Get

Request Params

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 retrieve.
ReportNumber	string	Provide the ReportNumber (unique identifier created by TaxBandits for a report) to identify which report needs to be retrieved.

Request Params

Sample 1

Request using SubmissionId.

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

Sample 2

Request using ReportNumber.

BOIR/Get?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 SubmisssionId for which the request was made.
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
BOIRRecords	object	It will show the detailed information of BOI Report created in TaxBandits
IsRequestFinCENId	boolean	Returns the information about the request of the FinCEN Id for the Reporting Company
ReportingCompany	object	It will show the detailed information of Reporting Company of BOI Report created
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
DBAs	object[]	Returns the DBA informations of the Reporting company
TINType	string	This gives the TIN Type provided when creating the report.
TIN	string	Provides the TIN of the Reporting company
TaxIDCountry	string	It gives the Country of where the TIN was provided if the TIN type is Foreign
FormationInformation	object	It will show the detailed information of Company Formation information
IsCompanyFormedBefore2024	boolean	Returns the company formed detail
CountryOfFormation	string	Returns the country of formation of the company
DomesticReportingCompany	object	It will show the detailed Domestic information of Reporting Company for BOI Report
FormedState	string	Provides the state where the company was formed, as given in the submission.
FormedTribalJurisdiction	string	Provides the Tribal Jurisdiction where the company was formed, as given in the submission.
OtherTribeNm	string	Provides the Tribe name given in the submission.
ForeignReportingCompany	object	It will show the detailed Foreign information of Reporting Company for BOI Report
FirstRegisteredState	string	Provides the Foreign state where the company was first registered, as given in the submission.
FirstRegisteredTribalJurisdiction	string	Provides the Foreign Tribal Jurisdiction where the company was first registered, as given in the submission.
OtherTribeNm	string	Provides the Tribe name given in the submission.
USAddress	object	It will show the detailed address information of Reporting Company.
StreetAddress	string	Returns the street address of the Reporting company as given in the submission
City	string	Returns the city of the Reporting company as given in the submission
State	string	Returns the state of the Reporting company as given in the submission
ZipCd	string	Returns the ZIP code of the Reporting company as given in the submission
IsForeignPooled	boolean	Returns the Foreign pooled information of the Reporting company as given in the submission
CompanyApplicants	object[]	It will show the detailed information of Company Applicants provided in the BOI Report
SequenceId	string	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
MiddleNm	string	Returns the Middle 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
Suffix	string	Returns the Suffix of the company applicant as given in the submission
DOB	string	Returns the DOB of the company applicant as given in the submission
AddressType	string	Returns the Address Type of the company applicant
Address	object	It will show the address information of the Company Applicant
Address1	string	Returns the address line1 of the company applicant as given in the submission
City	string	Returns the city of the company applicant as given in the submission
State	string	Returns the state of the company applicant as given in the submission
ZipCd	string	Returns the ZIP code of the company applicant as given in the submission
Country	string	Returns the country of the company applicant as given in the submission
FormOfIdentification	object	It will show the identification information of the Company Applicant
DocumentType	string	Returns the type of the document attached for Company applicant
DocumentNumber	string	Returns the document number given for the company applicant
ForeignDocumentCountry	string	Returns the Foreign country of the document of the company applicant
DocumentIssuedState	string	Returns the document issued state of the company applicant as given in the submission
DocumentIssuedLocalOrTribal	string	Returns the document issued local or tribal of the company applicant as given in the submission
OtherLocalOrTribal	string	Returns the document issued other local or tribal of the company applicant as given in the submission
BeneficialOwners	object[]	It will show 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
IsParentOrGuardian	boolean	Provides the value of Parent or guardian
FinCENID	string	Returns the FinCEN Id of the Beneficial owner if provided
LegalNm	string	Return the Legal name of the Beneficial owner
IsExemptEntity	boolean	Return the value of Beneficial owner is Exempt entity
ExemptEntityInformation	object	Return the information of Beneficial owner is 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
LegalNm	string	Returns the Legal 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
MiddleNm	string	Returns the Middle 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
Suffix	string	Returns the Suffix of the Beneficial owner as given in the submission
DOB	string	Returns the DOB of the Beneficial owner as given in the submission
ResidentialAddress	object	It will show the residential address information of the Beneficial owner
StreetAddress	string	Returns the street address of the Beneficial owner as given in the submission
City	string	Returns the city of the Beneficial owner as given in the submission
State	string	Returns the state of the Beneficial owner as given in the submission
ZipCd	string	Returns the ZIP code of the Beneficial owner as given in the submission
Country	string	Returns the country of the Beneficial owner as given in the submission
FormOfIdentification	object	It will show the identification information of the Beneficial owner
DocumentType	string	Returns the type of the document attached for Beneficial owner
DocumentNumber	string	Returns the document number given for the Beneficial owner
ForeignDocumentCountry	string	Returns the Foreign country of the document of the Beneficial owner
DocumentIssuedState	string	Returns the document issued state of the Beneficial owner as given in the submission
DocumentIssuedLocalOrTribal	string	Returns the document issued local or tribal of the Beneficial owner as given in the submission
OtherLocalOrTribal	string	Returns the document issued other local or tribal of the Beneficial owner as given in the submission
SubmitterInformation	object	It will show the detailed submitter information of the BOI Report
FirstNm	string	Returns the First name of the submitter as given in the submission
LastNm	string	Returns the Last name of the submitter as given in the submission
Email	string	Returns the Email of the submitter as given in the submission
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": "ec893456-2d31-45c9-a0c3-fd5968d068b2",
    "ReportNumber": "100032",
    "ReportType": "INITIAL",
    "ReportStatus": "CREATED",
    "BOIRRecords": {
        "IsRequestFinCENId": false,
        "ReportingCompany": {
            "ReportingCompanyId": "ec8f3ef7-47f1-443c-a531-dd589ed67aee",
            "LegalNm": "Snowdaze LLC",
            "DBAs": [
                "Iceberg Icecreams"
            ],
            "TINType": "EIN",
            "TIN": "349751386",
            "TaxIDCountry": null,
            "FormationInformation": {
                "IsCompanyFormedBefore2024": false,
                "CountryOfFormation": "US",
                "DomesticReportingCompany": {
                    "FormedState": "AL",
                    "FormedTribalJurisdiction": null,
                    "OtherTribeNm": null
                },
                "ForeignReportingCompany": {
                    "FirstRegisteredState": null,
                    "FirstRegisteredTribalJurisdiction": null,
                    "OtherTribeNm": null
                }
            },
            "USAddress": {
                "StreetAddress": "3576 AIRPORT WAY",
                "City": "FAIRBANKS",
                "State": "AK",
                "ZipCd": "99709"
            },
            "IsForeignPooled": false
        },
        "CompanyApplicants": [
            {
                "SequenceId": "1",
                "CompanyApplicantId": "9d2492b1-faea-4c5a-8cfb-3a4e2deb70ab",
                "FinCENID": null,
                "FirstNm": "Shawn",
                "MiddleNm": null,
                "LastNm": "Williams",
                "Suffix": null,
                "DOB": "01/28/1999",
                "AddressType": "Residential",
                "Address": {
                    "Address1": "120 Bremner Blvd",
                    "City": "Toronto",
                    "State": null,
                    "ZipCd": "AB4 568",
                    "Country": "CA"
                },
                "FormOfIdentification": {
                    "DocumentType": "Driving_License",
                    "DocumentNumber": "340007237",
                    "ForeignDocumentCountry": "US",
                    "DocumentIssuedState": "AK",
                    "DocumentIssuedLocalOrTribal": null,
                    "OtherLocalOrTribal": null
                }
            }
        ],
        "BeneficialOwners": [
            {
                "SequenceId": "1",
                "BeneficialOwnerId": "1161a7dd-86a1-47c2-aaea-ecdcb0797d33",
                "IsParentOrGuardian": false,
                "FinCENID": null,
                "IsExemptEntity": false,
                "ExemptEntityInformation": {
                    "EntityLegalNm": null,
                    "IndividualLastNm": "Smith"
                },
                "LegalNm":null,
                "FirstNm": "Chandler",
                "MiddleNm": null,
                "LastNm": "Smith",
                "Suffix": null,
                "DOB": "01/28/1999",
                "ResidentialAddress": {
                    "StreetAddress": "120 Bremner Blvd",
                    "City": "Toronto",
                    "State": null,
                    "ZipCd": "AB4 568",
                    "Country": "CA"
                },
                "FormOfIdentification": {
                    "DocumentType": "Driving_License",
                    "DocumentNumber": "340007237",
                    "ForeignDocumentCountry": "US",
                    "DocumentIssuedState": "AL",
                    "DocumentIssuedLocalOrTribal": null,
                    "OtherLocalOrTribal": null
                }
            }
        ],
        "SubmitterInformation": {
            "FirstNm": "James",
            "LastNm": "Smith",
            "Email": "james@sample.com"
        }
    }
}

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-1621",
            "Name": "Submission ID",
            "Message": "SubmissionId not associated 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"
        }
    ]
}

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": null,
    "ReportNumber": null,
    "ReportType": null,
     "ReportStatus": null,
    "BOIRRecords": null,
    "Errors": [
        {
            "Id": "BOI-ER-1623",
            "Name": "Submission Id",
            "Message": "Invalid Submission Id"
        }
    ]
}