Skip to content
Webhooks
/
/
POSTBOX_ITEM_CREATED 

Webhooks (1.0)

Download OpenAPI description
webhooks.json
webhooks.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/onboarding/webhooks/

Webhook subscription

Operations

Webhook events

Webhooks

PERSON_TAX_IDENTIFICATION_CHANGEDWebhook

Request

The tax identification number of a person was modified. The webhook contains the id of the relevant person tax identification in the header and the id of the relevant person in the payload.

Headers
Solaris-Entity-Idstring

ID of the person tax identification that triggered the webhook notification.

Example: cba4289c773b7450482ee88a6e5126e9ctin
Bodyapplication/json
idstring

The person ID of the customer whose tax identification has changed.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
application/json
{
  "id": "dc1a6812a14f6cc338cd084208535bcdcper"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

POSTBOX_ITEM_CREATED Webhook

Request

Solaris has published a new item, and it is now available via Postbox.

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

application/json
{
  "id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi",
  "belongs_to": "dc1a6812a14f6cc338cd084208535bcdcper",
  "owner_type": "Person",
  "created_at": "2021-10-22T05:23:30Z",
  "document_date": "2021-06-30",
  "document_type": "BALANCE_CONFIRMATION",
  "name": "Account statement 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": "e953cbf8af064839b3e3bf2568d1130fpbxd"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.

POTENTIAL_ACCOUNT_BLOCKINGWebhook

Request

The customer's identification document is about to expire. If no valid identification document is submitted by the blocking date, the account will be blocked.

Bodyapplication/json
blocking_datestring

The date by which the account will be blocked.

Example: "2022-10-09"
reasonstring

Reason why the account will be blocked.

Example: "IDENTIFICATION_DOCUMENT_EXPIRED"
application/json
{
  "blocking_date": "2022-10-09",
  "reason": "IDENTIFICATION_DOCUMENT_EXPIRED"
}

Responses

Return 200 to indicate that you successfully received the webhook notification.