ViewAttachment

This endpoint can be used to view the identifying documents attached to your BOI reports. The request must include the BeneficialOwnerIds and/or CompanyApplicantIds.

POSTBOIR/ViewAttachment

Request Body

Field	Type	Description
ComapanyApplicantIds	object[]	Provide the CompanyApplicantId (the unique identifier for the Company Applicant created by TaxBandits) to identify which attachments need to be shown. You can include up to 25 CompanyApplicantIds in a single request.
BeneficialOwnerIds	object[]	Provide the BeneficialOwnerId (unique identifier of the Beneficial Owner created by TaxBandits) to identify which attachments need to be shown. You can include up to 25 BeneficialOwnerIds in a single request.

Request JSON

Request using multiple company applicant Ids and beneficial owner ids.

{
    "CompanyApplicantIds": [
        "bbd8fbdb-3ea2-40bc-916c-0c3383b5daed","4670812c-ea76-4330-a760-b27b3712f11c"
    ],
    "BeneficialOwnerIds": [
        "7963e570-f414-4316-b9a6-6bf964b6e00d","a0a64ab2-ddb8-43e8-81ef-d5498d9e8fdc"
    ]
}

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
CompanyApplicants	object[]	Retrieves the attachment objects for the Company Applicants.
CompanyApplicantId	string	Returns the unique identifier of the Company Applicant for which the attachment is provided.
Filepath	string	Returns the file path of the identification document.
Info	object	Returns the attachment information of the Company Applicant (if no attachment exists for the provided ID).
BeneficialOwners	object[]	Retrieves the attachment objects for the Beneficial Owners
BeneficialOwnerId	String	Returns the unique identifier of the Beneficial Owner for which the attachment is provided.
Filepath	String	Returns the Filepath of the Identification Document
Info	object[]	Returns the attachment information of the Beneficial Owners (if no attachment exists for the provided ID).
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",
    "CompanyApplicants": [
        {
            "CompanyApplicantId": "a0a64ab2-ddb8-43e8-81ef-d5498d9e8fdc",
            "FilePath": "https://expressirsforms.s3.amazonaws.com/pdfs/66badf6c02714f1adeda218c/boir/ca/26a18cd5-0a1d-492a-877-ab6cd33876fd_1727775878234.pdf",
            "Info": null
        }
    ],
    "BeneficialOwners": [
        {
            "BeneficialOwnerId": "30a99399-99db-41c2-abde-47588e39fdea",
            "FilePath": "https://expressirsforms.s3.amazonaws.com/pdfs/66badf6c02714f1adeda218c/boir/bo/fe816149-23ba-4a8a-a9e2-2348f66a9b0_1727775879727.pdf",
            "Info": null
        }
    ],
    "Errors": null
}

300

You’ll get the below response if your API request contains both valid and invalid details.

{
    "StatusCode": 300,
    "StatusName": "MultiStatus",
    "StatusMessage": "Multiple statuses are available for the request",
    "CompanyApplicants": null,
    "BeneficialOwners": [
        {
            "BeneficialOwnerId": "30a99399-99db-41c2-abde-47588e39fdea",
            "FilePath": "https://expressirsforms.s3.amazonaws.com/pdfs/66badf6c02714f1adeda218c/boir/bo/fe816149-23ba-4a8a-a92-23548f66a9b0_1727775879727.pdf",
            "Info": null
        }
    ],
    "Errors": [
        {
            "Id": "BOI-ER-1668",
            "Name": "CompanyApplicantIds[0].CompanyApplicantId",
            "Message": "Invalid CompanyApplicantId"
        }
    ]
}

400

You'll get the below response when your API requests contain any validation errors.

{
    "StatusCode": 400,
    "StatusName": "BadRequest",
    "StatusMessage": "Validation error has occurred",
        "CompanyApplicants": [
        {
            "CompanyApplicantId": "a0a64ab2-ddb8-43e8-81ef-d5498d9e8fdc",
            "FilePath": null,
            "Info": "No Document attached for this Company Applicant"
        }
    ],
    "BeneficialOwners": [
        {
            "BeneficialOwnerId": "30a99399-99db-41c2-abde-47588e39fdea",
            "FilePath": null,
            "Info":  "No Document attached for this Beneficial Owner"
        }
    ],
    "Errors": null
}

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