# Upload a document and create a Postbox item for a business

Uploads a document and creates a Postbox item for the business specified in the request URL.   To pass the Postbox item details, you may use either the  object or separate request parts (i.e., the request properties , , etc.) If you use the second option, you must set the  of boolean properties to .

Endpoint: POST /v1/businesses/{business_id}/postbox
Version: 1.0

## Path parameters:

  - `business_id` (string, required)
    ID of the business.

## Request fields (multipart/form-data):

  - `file` (string)
    The file to upload.

  - `metadata` (object)
    Object containing metadata related to the document.

  - `metadata.document_name` (string)
    Name of the document.
    Example: "account_statement_01_04_2023_12365.pdf"

  - `metadata.document_description` (string)
    Description of the document.
    Example: "Account statement for 01_04_2023 for the customer 12365"

  - `metadata.document_type` (string)
    The type of document associated with the Postbox item.
    Enum: "ACCOUNT_STATEMENT", "ASSETS_ACQUISITION_COSTS", "ASSETS_ACQUISITION", "BALANCE_CONFIRMATION", "CREDIT_CARD_CONTRACT_SIGNED", "CREDIT_CARD_CONTRACT", "CREDIT_CARD_SECCI", "CREDIT_CARD_STATEMENT", "CUSTOMER_INFORMATION", "DEPOT_STATEMENT_MIFID", "DEPOT_STATEMENT", "DUNNING_INFORMATION", "EX_POST_COST_INFORMATION", "FEE_SUMMARY_STATEMENT", "LOAN_SCHEDULE", "PROFIT_TAX_STATEMENT", "RELATIONSHIP_TERMINATION", "SECURITIES_INVOICE", "SECURITIES_EVENT", "SECURITIES_EVENT_NOTIFICATION", "SINGLE_FEE_STATEMENT", "SINGLE_TRANSACTION_STATEMENT", "TAX_SETTLEMENT_CALCULATION", "YEARLY_TAX_STATEMENT"

  - `metadata.document_date` (string)
    The date of the document associated with the Postbox item.
    Example: "2024-07-30"

  - `metadata.idempotency_key` (string)
    Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created entity.

  - `metadata.sign_document` (boolean)
    (Optional) If set to true, then the document will be signed.

  - `metadata.customer_notification` (boolean)
    Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

  - `metadata.customer_confirmation` (boolean)
    Boolean value to indicate whether or not customers must confirm the Postbox item.

  - `sign_document` (boolean)
    (Optional) If set to true, then the document will be signed. Please note that you must use  for boolean properties in this request.

  - `customer_notification` (boolean)
    Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.  Please note that you must use  for boolean properties in this request.

  - `customer_confirmation` (boolean)
    Boolean value to indicate whether or not customers must confirm the Postbox item.  Please note that you must use  for boolean properties in this request.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the Postbox item.

  - `belongs_to` (string)
    ID of the person or business with whom the Postbox item is associated.

  - `owner_type` (string)
    Indicates whether the Postbox item is owned by a person or business.
    Enum: "Person", "Business"

  - `created_at` (string)
    UTC timestamp from when the Postbox item was created.

  - `document_date` (string)
    The date of the document associated with the Postbox item.

  - `document_type` (string)
    The type of document associated with the Postbox item.
    Enum: "ACCOUNT_STATEMENT", "BALANCE_CONFIRMATION", "CUSTOMER_INFORMATION", "DUNNING_INFORMATION", "LOAN_SCHEDULE", "SECURITIES_INVOICE", "SECURITIES_EVENT", "SECURITIES_EVENT_NOTIFICATION", "DEPOT_STATEMENT_MIFID", "EX_POST_COST_INFORMATION", "DEPOT_STATEMENT", "ASSETS_ACQUISITION", "ASSETS_ACQUISITION_COSTS", "PROFIT_TAX_STATEMENT", "YEARLY_TAX_STATEMENT", "TAX_SETTLEMENT_CALCULATION", "CREDIT_CARD_STATEMENT", "RELATIONSHIP_TERMINATION", "CREDIT_CARD_SECCI", "CREDIT_CARD_CONTRACT", "CREDIT_CARD_CONTRACT_SIGNED", "FEE_SUMMARY_STATEMENT", "SINGLE_FEE_STATEMENT", "SINGLE_TRANSACTION_STATEMENT"

  - `name` (string)
    The name of the Postbox item.

  - `description` (string)
    A description for the Postbox item.

  - `customer_notification` (boolean)
    Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

  - `customer_confirmation` (boolean)
    Boolean value to indicate whether or not customers must confirm the Postbox item.

  - `document_size` (integer)
    The file size of the associated document.

  - `document_content_type` (string)
    The content type of the associated document.

  - `document_id` (string)
    The ID of the associated document.

  - `has_been_read` (boolean)
    The item was marked as read via patch endpoint.

  - `has_been_confirmed` (boolean)
    The item has at least 1 confirmation.

  - `reference_id` (string)
    Reference of original source of a document, e.g. bill_id for credit card statement

## Response 400 fields (application/json):

  - `id` (string)
    Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

  - `status` (string)
    Example: "400"

  - `code` (string)
    Example: "build_pagination_headers_failure"

  - `title` (string)
    Example: "Failed to build pagination headers."

  - `detail` (string)
    Example: "Cannot connect to database."

## Response 403 fields (application/json):

  - `id` (string)
    Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

  - `status` (string)
    Example: "403"

  - `code` (string)
    Example: "unauthorized_action"

  - `title` (string)
    Example: "Unauthorized Action"

  - `detail` (string)
    Example: "Unauthorized action is not allowed."

## Response 404 fields (application/json):

  - `id` (string)
    Example: "a95f2aaf-4e0c-4d49-8021-8a16a884ed86"

  - `status` (string)
    Example: "404"

  - `code` (string)
    Example: "model_not_found"

  - `title` (string)
    Example: "Model Not Found"

  - `detail` (string)
    Example: "Couldn't find 'Solaris::Identification' for id 'bbbcccfff388923eb899a5852df6cidt'."

## Response 500 fields (application/json):

  - `id` (string)
    Example: "e8915041-9d8c-4d96-9dd1-04e8522ecdbf"

  - `status` (string)
    Example: "500"

  - `code` (string)
    Example: "generic_error"

  - `title` (string)
    Example: "Generic Error"

  - `detail` (string)
    Example: "There was an error."