Account snapshots (1.0)

Download OpenAPI specification:Download

Account snapshots

Create an account snapshot

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.

Request
Security:
path Parameters
person_id
required
string

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

Request Body schema: application/json

The account snapshot attributes

source
required
string

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"
object 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_number
string or null

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

iban
string 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_id
string or null

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

Responses
201

Application

post/v1/persons/{person_id}/account_snapshots
Request samples
application/json
{
  • "source": "FIN_TEC_SYSTEMS",
  • "snapshot_data": {
    },
  • "partner_reference_number": "string",
  • "iban": "string",
  • "account_id": "string"
}
Response samples
application/json
{}

Retrieve account snapshot

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.

Request
Security:
path Parameters
person_id
required
string

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

account_snapshot_id
required
string

The ID of the customer's account snapshot resource.

Responses
200

AccountSnapshot

404

Not Found

get/v1/persons/{person_id}/account_snapshots/{account_snapshot_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/persons/{person_id}/account_snapshots/{account_snapshot_id}'
Response samples
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"
}