Skip to content
Webhooks
/
/
BUSINESS_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

BUSINESS_FRONTING_RELATIONSHIP_STATUS_CHANGEDWebhook

Request

The status of the fronting business relationship with a customer has changed.

Bodyapplication/json
idstring

The ID of the business resource whose business relationship status has changed.

Example: "3311ac2c0a6243a8836ab290380918facbiz"
statusstring

The status of the business relationship.

Example: "active"
application/json
{
  "id": "3311ac2c0a6243a8836ab290380918facbiz",
  "status": "active"
}

Responses

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

BUSINESS_IDENTIFICATIONWebhook

Request

A business identification was created, or its status was updated. The primary purpose of this webhook is to deliver the URL where the customer must be redirected to complete a video identification.

Bodyapplication/json
idstring

The unique ID of the business identification resource.

Example: "4c74c804eaea5d2a2d64ef400a27a4d3bid"
methodstring

The identification method. Default value is idnow.

Enum"idnow""itm""import"
Example: "idnow"
referencestring or null

The reference of the itm identification request. Empty when the identification method is idnow.

Example: null
urlstring

The URL to which you must redirect the business' legal representative(s) and/or authorized person(s) to complete the identification process.

Example: "https://go.test.idnow.de/..."
statusstring

The status of the business identification process.

Enum"created""pending""successful""failed""expired"
Example: "pending"
completed_atstring or null

The date and time when the business identification was completed.

Example: null
business_idstring

The ID of the business resource.

Example: "880bbac68a34add190786b9c74f4c82fcbiz"
application/json
{
  "id": "4c74c804eaea5d2a2d64ef400a27a4d3bid",
  "method": "idnow",
  "reference": null,
  "url": "https://go.test.idnow.de/...",
  "status": "pending",
  "completed_at": null,
  "business_id": "880bbac68a34add190786b9c74f4c82fcbiz"
}

Responses

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

BUSINESS_SEIZURE_CREATEDWebhook

Request

Solaris has received a request from the authorities (e.g., court, governmental agency) to seize the account(s) of a business.

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
Enum"ATTACHMENT""AUTHORITY_SEIZURE""COURT_SEIZURE""PRE_ATTACHMENT"
Example: "COURT_SEIZURE"
statusstring
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: true
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: "880bbac68a34add190786b9c74f4c82fcbiz"
customer_typestring

The type of customer whose account has the seizure.

Example: "Business"
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": true,
  "country": "DE",
  "multiple_drittschuldner": true,
  "customer_id": "880bbac68a34add190786b9c74f4c82fcbiz",
  "customer_type": "Business"
}

Responses

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