Sign in
latestOpenAPI 3.0.12026-08-101936151.3 KB

61701b027c74

Testing endpoints for Postbox API

Create a Postbox item for a person

Deprecated! Use POST /v1/persons/{person_id}/postbox instead.<br> Creates a Postbox item for the person specified in the request URL. Note that you can only use this endpoint for testing purposes on the testing, staging, and sandbox environments.

post/v1/persons/{person_id}/postbox/items

Path parameters

person_idstring required

Person Id.

Request body

namestring

The name to apply to the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_idstring

ID of a document to associate with the Postbox item. Use the POST /v1/postbox_documents endpoint to upload test documents.

idempotency_keystring

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.

Response

The Postbox item was created successfully.

idstring

ID of the Postbox item.

belongs_tostring

ID of the person or business with whom the Postbox item is associated.

owner_type'Person' | 'Business'

Indicates whether the Postbox item is owned by a person or business.

created_atstring

UTC timestamp from when the Postbox item was created.

document_datestring

The date of the document associated with the Postbox item.

document_type'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'

The type of document associated with the Postbox item.

namestring

The name of the Postbox item.

descriptionstring

A description for the Postbox item.

customer_notificationboolean

Boolean value to indicate whether or not customers should receive a notification when the Postbox item is created.

customer_confirmationboolean

Boolean value to indicate whether or not customers must confirm the Postbox item.

document_sizeinteger

The file size of the associated document.

document_content_typestring

The content type of the associated document.

document_idstring

The ID of the associated document.

has_been_readboolean

The item was marked as read via patch endpoint.

has_been_confirmedboolean

The item has at least 1 confirmation.

reference_idstring

Reference of original source of a document, e.g. bill_id for credit card statement