Skip to content
/Account snapshots

Account snapshots (1.0)

Download OpenAPI description
account-snapshot.json
account-snapshot.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/lending/account-snapshot/

Account snapshots

Operations

Create an account snapshot

Request

Creates an account snapshot for the customer with the person_id specified in the request URL. The account snapshot contains account information, such as balance, transactions, bookings, etc.
You can create an account snapshot in various ways by specifying the source. Check the properties descriptions and examples for more information.

Path
person_idstringrequired

The person ID of the customer for whom you're creating an account snapshot.

Bodyapplication/json

The account snapshot attributes

sourcestringrequired

The source of the account snapshot. You can either create an automated snapshot via FinTecSystems or FINREACH, upload an output of a snapshot you created (in this case, the snapshot_data field is required), or a snapshot of a Solarisbank account (in this case, the account_id field is required).

Enum"FIN_TEC_SYSTEMS""FINREACH""SOLARISBANK""PARTNER"
snapshot_dataobject or null(AccountSnapshotWeb.CreateAccountSnapshotRequest.SnapshotData)

An object to upload the output of the account snapshot you created. Only relevant if the source is PARTNER.

partner_reference_numberstring or null

Your internal reference number for the customer's account snapshot.

ibanstring or null

The customer's IBAN to be used for the account snapshot. Only relevant if the source is FIN_TEC_SYSTEMS or FINREACH.

account_idstring or null

The customer's account ID to be used to initiate a Solarisbank account snapshot. Only relevant if the source is SOLARISBANK.

application/json
{
  "source": "FIN_TEC_SYSTEMS",
  "snapshot_data": {
    "turnovers": [ … ],
    "days": 365,
    "date": "2020-02-28",
    "balance": { … },
    "account": { … }
  },
  "partner_reference_number": "string",
  "iban": "string",
  "account_id": "string"
}

Responses

Application

Bodyapplication/json
idstringrequired

The ID of the account snapshot resource.

Example: "6c8f81a234df4052a9cde197577347b7snap"
wizard_session_keystring or null

The wizard key session. Only relevant if the source is FIN_TEC_SYSTEMS.

Example: "wiz04852083740"
locationstring or null

The URL to which you must redirect the customer to complete the account snapshot. Only relevant if source is FINREACH.

Example: "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx"
account_idstring or null

The customer's account ID to be used to initiate a Solarisbank account snapshot. Only relevant if the source is SOLARISBANK.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
Response
application/json
{
  "wizard_session_key": "wiz04852083740",
  "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx",
  "id": "6c8f81a234df4052a9cde197577347b7snap",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}

Retrieve account snapshot

Request

Returns an account snapshot for a customer. You can use this endpoint to retrieve the details of an account snapshot and check its validity. Additionally, you can subscribe to the webhook event ACCOUNT_SNAPSHOT to receive notifications about status changes.

Path
person_idstringrequired

The person ID of the customer whose snapshot you want to retrieve.

account_snapshot_idstringrequired

The ID of the customer's account snapshot resource.

No request payload

Responses

AccountSnapshot

Bodyapplication/json
idstringrequired

The ID of the account snapshot resource.

Example: "6c8f81a234df4052a9cde197577347b7snap"
statusstringrequired

The status of the account snapshot.

Enum"pending""available""expired""failed"
Example: "available"
providerstringrequired

The provider of the account snapshot.

Example: "FINREACH"
wizard_session_keystring or null

The wizard key session. Only relevant if the source is FIN_TEC_SYSTEMS.

Example: "wiz04852083740"
status_descriptionstring or null

Additional context around the account snapshot status.

locationstring or null

The URL to which you must redirect the customer to complete the account snapshot. Only relevant if source is FINREACH.

Example: "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx"
ibanstring or null

The customer's IBAN to be used for the account snapshot. Only relevant if the source is FIN_TEC_SYSTEMS or FINREACH.

Example: "DE87110101001000057123"
account_idstring or null

The customer's account ID to be used to initiate a Solarisbank account snapshot. Only relevant if the source is SOLARISBANK.

Example: "adc123a45d6d7cf8fbfeed537ba919d5cacc"
Response
application/json
{
  "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"
}