Skip to content
Webhooks
/
/
ACCOUNT_SNAPSHOT

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

ACCOUNT_OPENING_REQUESTWebhook

Request

An account opening request has been either accepted or rejected.

Bodyapplication/json
account_opening_request_idstring

The ID of the account opening request.

Example: "f8d7fbbd587047a0aa449ce69d2d6c08aorq"
customer_idstring

The ID (i.e., person_id or business_id) of the customer for whom you're opening the account.

Example: "b109ee6f66d2a061e006bd31c6455df2cper"
statusstring

The status of the account opening request.

Enum"INITIATED""IN_PROGRESS""COMPLETED""REJECTED"
Example: "COMPLETED"
account_idstring

The ID of the account that was created for the customer.

Example: "c5a0e32369e9372e0fdf490294cecd8dcacc"
updated_atstring(date-time)

The timestamp (date-time) when the AOR was last updated.

Example: "2021-12-22T15:05:33.634+00:00"
errorobject or null

An object containing information about the reason why an account opening request has failed.

Example: {"code":"green_person_vetting","detail":"CustomerVettingStatus for person has to be 'green' to open an account."}
application/json
{
  "account_opening_request_id": "f8d7fbbd587047a0aa449ce69d2d6c08aorq",
  "customer_id": "b109ee6f66d2a061e006bd31c6455df2cper",
  "status": "COMPLETED",
  "account_id": "c5a0e32369e9372e0fdf490294cecd8dcacc",
  "updated_at": "2021-12-22T15:05:33.634+00:00",
  "error": {
    "code": "green_person_vetting",
    "detail": "CustomerVettingStatus for person has to be 'green' to open an account."
  }
}

Responses

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

ACCOUNT_SNAPSHOTWebhook

Request

The status of an account snapshot has changed. This webhook is used in the context of different lending products.

Bodyapplication/json
entity_uuidstring

Resource unique ID.

Example: "bc9eee989fb84f3aa8089e244bb8dfc1snap"
event_typestring

Webhook event

Example: "ACCOUNT_SNAPSHOT"
payloadobject(AccountSnapshotWeb.AccountSnapshot.ShowAccountSnapshotResponse)
application/json
{
  "entity_uuid": "bc9eee989fb84f3aa8089e244bb8dfc1snap",
  "event_type": "ACCOUNT_SNAPSHOT",
  "payload": {
    "wizard_session_key": "wiz04852083740",
    "status_description": "string",
    "status": "available",
    "provider": "FINREACH",
    "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx",
    "id": "6c8f81a234df4052a9cde197577347b7snap",
    "iban": "DE87110101001000057123",
    "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
  }
}

Responses

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

ACTIVATION_CHALLENGE_CREATIONWebhook

Request

This webhook event denotes that a new activation challenge is created. The payload contains the challenge_id which can be used to fetch the actual challenge itself.

Bodyapplication/json
person_idstring

The ID of the person for whom the challenge was created.

Example: "b9c5661fc7d240b8b51b9059b580cper"
challenge_idstring

ID of the challenge that is created.

Example: "a5f454e3f96447d6b3f7ecda46328040"
created_atstring

UTC timestamp when the challenge_id was created.

Example: "2025-02-31T10:55:55Z"
expires_atstring

UTC timestamp when the challenge_id will expire.

Example: "2025-03-31T10:55:55Z"
requested_bystring

The origin of the request that created this challenge. Possible values are - SOLARISBANK, WEBUI, MOBILE_APP, WEB

Example: "SOLARISBANK"
purposestring

The purpose for which the activation code is generataed. Currently it is only - DEVICE_BINDING

Example: "DEVICE_BINDING"
application/json
{
  "person_id": "b9c5661fc7d240b8b51b9059b580cper",
  "challenge_id": "a5f454e3f96447d6b3f7ecda46328040",
  "created_at": "2025-02-31T10:55:55Z",
  "expires_at": "2025-03-31T10:55:55Z",
  "requested_by": "SOLARISBANK",
  "purpose": "DEVICE_BINDING"
}

Responses

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