Account snapshots

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.

get/v1/persons/{person_id}/account_snapshots/{account_snapshot_id}

Path parameters

person_idstring required

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

account_snapshot_idstring required

The ID of the customer's account snapshot resource.

Response

AccountSnapshot

wizard_session_keystring nullable

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

status_descriptionstring nullable

Additional context around the account snapshot status.

status'pending' | 'available' | 'expired' | 'failed' required

The status of the account snapshot.

providerstring required

The provider of the account snapshot.

locationstring nullable

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

idstring required

The ID of the account snapshot resource.

ibanstring nullable

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

account_idstring nullable

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

Example response

{
  "wizard_session_key": "wiz04852083740",
  "status": "available",
  "provider": "FINREACH",
  "location": "https://ui.solaris-i.prod.finleap.cloud?token=xxxxxx",
  "id": "6c8f81a234df4052a9cde197577347b7snap",
  "iban": "DE87110101001000057123",
  "account_id": "adc123a45d6d7cf8fbfeed537ba919d5cacc"
}