Skip to content
Webhooks
/
/
PERSON_TAX_IDENTIFICATION...

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_SEIZURE_UPDATEDWebhook

Request

The processing method for a seizure for a person has switched from automated to manual.

Bodyapplication/json
idstring

Unique ID of the seizure resource.

Example: "211c5c2f34ac442ff6f93d09fc8fb3edseiz"
enactment_datestring(date)

The date when the authority issued the seizure.

Example: "2019-01-31"
delivery_datestring

The date when the seizure notice was delivered to Solaris.

Example: "2019-01-28"
authority_namestring

The name of the authority that issued the seizure.

Example: "Court"
resolution_case_numberstring

The seizure's case ID number, generated by the issuing authority.

Example: "Number 212121212"
seizure_typestring

The type of seizure.

Enum"ATTACHMENT""AUTHORITY_SEIZURE""COURT_SEIZURE""PRE_ATTACHMENT"
Example: "COURT_SEIZURE"
statusstring

The current status of the seizure.

Enum"ACTIVE""FULFILLED""WAITING_FOR_AUTHORITY"
Example: "ACTIVE"
amountobject
additional_costobject
debtorobject
creditorobject
creditor_representativeobject
automatic_payout_datestring

The automatic payout date of the seizure amount.

Example: "2022-01-29"
insolvencyboolean

Field to indicate whether or not there's an insolvency case related to the customer.

Example: false
social_benefitsboolean

Field to indicate whether or not social benefits are applicable to the customer.

Example: false
seizure_protectedboolean

Field to indicate whether or not there's a seizure protection related to the customer.

Example: false
automatedboolean

Field to indicate whether or not the seizure will be processed automatically or manually.

Example: false
countrystring

The country in which the seizure happened.

Example: "DE"
multiple_drittschuldnerboolean

Field to indicate whether or not there are multiple third party debtors related to the customer.

Example: true
customer_idstring

The person or business ID of the customer whose account has the seizure.

Example: "dc1a6812a14f6cc338cd084208535bcdcper"
customer_typestring

The type of customer whose account has the seizure.

Example: "Person"
application/json
{
  "id": "211c5c2f34ac442ff6f93d09fc8fb3edseiz",
  "enactment_date": "2019-01-31",
  "delivery_date": "2019-01-28",
  "authority_name": "Court",
  "resolution_case_number": "Number 212121212",
  "seizure_type": "COURT_SEIZURE",
  "status": "ACTIVE",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "additional_cost": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "debtor": {
    "name": "string",
    "address": "string",
    "postal_code": "string",
    "city": "string",
    "country": "AD",
    "state": "BE"
  },
  "creditor": {
    "name": "Betflix LLC",
    "address": "Bethousestrasse 43",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE",
    "iban": "DE72110101001000014344"
  },
  "creditor_representative": {
    "name": "Lawyer LLC",
    "address": "Gunsterstrasse 22",
    "postal_code": "10409",
    "city": "Berlin",
    "country": "DE",
    "state": "BE",
    "case_number": "42ABC-2",
    "iban": "DE87110101001000057123"
  },
  "automatic_payout_date": "2022-01-29",
  "insolvency": false,
  "social_benefits": false,
  "seizure_protected": false,
  "automated": false,
  "country": "DE",
  "multiple_drittschuldner": true,
  "customer_id": "dc1a6812a14f6cc338cd084208535bcdcper",
  "customer_type": "Person"
}

Responses

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

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.