Sign in
Sessions API

This will return a wizard_session object.

get/sessions/{transaction-id}

Path parameters

transaction-idstring required

To query this, you can use the transaction-id, which is returned, after the session is created.

Response

Request successfully processed

idstring

Internal identifier.

transactionstring

Public transaction identifier.

wizard_session_keystring

Key to start the wizard

product'xs2a_verify' | 'xs2a_risk' | 'xs2a_pay' | 'xs2a_api'

The name of the xs2a product.

parametersobject

An array which contains the current wizard configuration.

last_error'accounts_failed' | 'age_verification_not_confirmed' | 'authorized_person' | 'balance_failed' | 'bank_code_unknown' | 'client_aborted' | 'client_not_started' | 'consent_invalid' | 'country_id_invalid' | 'forced_transport_disabled' | 'init_failed' | 'login_blacklisted' | 'login_failed' | 'login_next_failed' | 'max_login_tries' | 'max_tan_tries' | 'no_compatible_accounts' | 'no_transports_found' | 'pinned_holder_not_found' | 'pinned_iban_not_found' | 'pp_not_checked' | 'session_expired' | 'security_setting_rejection' | 'standing_orders_failed' | 'tech_error' | 'testmode_error' | 'token_mismatch' | 'transaction_failed' | 'turnovers_failed' | 'tx_rx_iban_equal' | 'validation_failed' | 'wrong_tan'

The last occurred error. This is overwritten, if another error occurs. You can find detailed explanations of the errors here.

testmodeboolean

true if this session runs in testmode. false otherwise.

finishedboolean

true if this session was finished successfully. false if not or still running.

current_step'WizardLoginStep' | 'WizardLoginNextStep' | 'WizardAccountsStep' | 'WizardDataStep' | 'WizardTanStep' | 'WizardScaStep' | 'WizardIrpaStep' | 'WizardAutoSubmitStep' | 'WizardFinishStep' | 'WizardStartStep' | 'WizardShowcaseStep' | 'WizardPreAccountsStep' | 'WizardPreDataStep' | 'WizardPreLoginStep' | 'WizardOauthRedirect' | 'WizardOauthRedirectNok' | 'RiskUpload'

The current wizard step of this session.

created_atstring

Date of creation (YYYY-MM-DD HH:MM:SS)

objectstring

String with content 'wizard_session'

Example response

{
  "id": "ws_xxxxxxxxxxxxxxxx",
  "transaction": "00000-xx-xxxx-xxxx",
  "product": "xs2a_risk",
  "parameters": {},
  "testmode": true,
  "finished": true,
  "created_at": "2021-09-23 10:40:10",
  "object": "wizard_session"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.