Skip to content
/Postbox Items

Compliance features (1.0)

Download OpenAPI description
compliance.json
compliance.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/onboarding/compliance/

AML follow-up

Operations

Testing endpoints for Postbox API

Operations

Postbox Items

Operations

Index Postbox items for a person

Request

Returns an array containing all Postbox items associated with the person specified in the request URL.
Note that you can filter the results by created_at (min or max) and document_type—see the descriptions below.

Path
person_idstringrequired

ID of the person.

Query
filter[document_type]string

Filters the response by the Postbox item type. You can supply multiple document_type values separated by commas.

string
filter[created_at][min]string(date-time)

Filters the response by Postbox items created from a certain date (i.e., the minimum date in the past when the document was created).

filter[created_at][max]string(date-time)

Filters the response by Postbox items created up until a certain date (i.e., the maximum date in the past when the document was created).

page[number]integer

The number of pages of results to load.

Default 0
page[size]integer

Amount of entries to return in a single page.

Default 10
No request payload

Responses

The Postbox items were fetched successfully.

Headers
per-pagestring

Amount of Postbox items in a single page.

totalstring

Total amount of Postbox items for the given request.

linkstring

Links to first/previous/next/last pages.

Bodyapplication/jsonArray [
idstring

ID of the Postbox item.

belongs_tostring

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

owner_typestring

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

Enum"Person""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_typestring

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"
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(int64)

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

]
Response
application/json
[
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
    "belongs_to": "12345",
    "owner_type": "Person",
    "created_at": "2021-10-22T05:23:30Z",
    "document_date": "2021-06-30",
    "document_type": "BALANCE_CONFIRMATION",
    "name": "Balance confirmation for June 2021",
    "description": "This account statement includes all bookings from the given period of time",
    "customer_notification": false,
    "customer_confirmation": false,
    "document_size": 66092,
    "document_content_type": "image/jpeg",
    "document_id": "e953cbf8af064839b3e3bf2568d1130fdocc"
  },
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
    "belongs_to": "12345",
    "owner_type": "Person",
    "created_at": "2021-10-22T05:23:30Z",
    "document_date": "2021-06-30",
    "document_type": "BALANCE_CONFIRMATION",
    "name": "Balance confirmation for June 2021",
    "description": "This account statement includes all bookings from the given period of time",
    "customer_notification": false,
    "customer_confirmation": false,
    "document_size": 66092,
    "document_content_type": "image/jpeg",
    "document_id": "e953cbf8af064839b3e3bf2568d1130fdocc"
  }
]

Index Postbox items for a business

Request

Returns an array containing all Postbox items associated with the business specified in the request URL.
Note that you can filter the results by created_at (min or max) and document_type—see the descriptions below.

Path
business_idstringrequired

ID of the business.

Query
filter[document_type]string

Filters the response by the Postbox item type. You can supply multiple document_type values separated by commas.

string
filter[created_at][min]string(date-time)

Filters the response by Postbox items created from a certain date (i.e., the minimum date in the past when the document was created).

filter[created_at][max]string(date-time)

Filters the response by Postbox items created up until a certain date (i.e., the maximum date in the past when the document was created).

page[number]integer

The number of pages of results to load.

Default 0
page[size]integer

Amount of entries to return in a single page.

Default 10
No request payload

Responses

The Postbox items were fetched successfully.

Headers
per-pagestring

Amount of Postbox items in a single page.

totalstring

Total amount of Postbox items for the given request.

linkstring

Links to first/previous/next/last pages.

Bodyapplication/jsonArray [
idstring

ID of the Postbox item.

belongs_tostring

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

owner_typestring

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

Enum"Person""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_typestring

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"
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(int64)

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

]
Response
application/json
[
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
    "belongs_to": "12345",
    "owner_type": "Business",
    "created_at": "2021-10-22T05:23:30Z",
    "document_date": "2021-06-30",
    "document_type": "BALANCE_CONFIRMATION",
    "name": "Balance confirmation for June 2021",
    "description": "This account statement includes all bookings from the given period of time",
    "customer_notification": false,
    "customer_confirmation": false,
    "document_size": 66092,
    "document_content_type": "image/jpeg",
    "document_id": "e953cbf8af064839b3e3bf2568d1130fdocc"
  },
  {
    "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
    "belongs_to": "12345",
    "owner_type": "Business",
    "created_at": "2021-10-22T05:23:30Z",
    "document_date": "2021-06-30",
    "document_type": "BALANCE_CONFIRMATION",
    "name": "Balance confirmation for June 2021",
    "description": "This account statement includes all bookings from the given period of time",
    "customer_notification": false,
    "customer_confirmation": false,
    "document_size": 66092,
    "document_content_type": "image/jpeg",
    "document_id": "e953cbf8af064839b3e3bf2568d1130fdocc"
  }
]

Retrieve a Postbox item

Request

Returns the Postbox item specified in the request URL.

Path
item_idstringrequired

ID of the Postbox item.

No request payload

Responses

The Postbox item was fetched successfully.

Bodyapplication/json
idstring

ID of the Postbox item.

belongs_tostring

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

owner_typestring

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

Enum"Person""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_typestring

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"
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(int64)

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

Response
application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "12345",
  "owner_type": "Person",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Balance confirmation for June 2021",
  "description": "Balance confirmation",
  "customer_notification": false,
  "customer_confirmation": false,
  "document_size": 66092,
  "document_content_type": "image/jpeg",
  "document_id": "e953cbf8af064839b3e3bf2568d1130fpbxd",
  "has_been_read": false,
  "has_been_confirmed": false
}

Download document for a Postbox item

Request

Downloads the document associated with the Postbox item specified in the request URL. The only supported media type is application/pdf.

Path
item_idstringrequired

ID of the Postbox item.

No request payload

Responses

The document was downloaded successfully.

Bodyapplication/pdf
string(byte)
Response
No content

Postbox Confirmations

Operations

Questions and Answers

Operations

Terms and Conditions events

Operations