Get AIS options

get https://example.com/ob/Ais/access/options/{connectorId}

This operation is used to retrieve account access options,

You'll be able to determine how to request account access for the specific bank, which data is optional or mandatory

Path Params

connectorId

int32

required

The id of the connector (see /ob/banks)

Headers

X-Request-ID

string

length ≤ 50

Request identifier, unique to the call, as determined by the client. Maximum length of 50 characters.

X-Correlation-ID

string

length ≤ 50

Unique identifier for all the calls of the same flow. Determined by the client in direct/TPP mode, ignored in Gateway mode. Maximum length of 50 characters.

Responses

Response body

object

maxConsentDuration

int32

Maximum duration of the consent in days

accessOption

int32

Customizable (0) – PSU can provide specific account numbers, granting access to balances and/or transactions for those accounts (via TransactionAccounts and BalanceAccounts properties). If no accounts are specified, depending on the consent types supported by the bank, either global consent or, if the bank allows it, the user will choose accounts during SCA authorization.
NotCustomizable (1) – accounts can not be specified on the SDK level. Depending on the bank, PSU may have an option to choose accounts during SCA authorization.
SingleAccount (2) – PSU must specify single account to give access to (SingleAccount property)
Detailed (3) – PSU must provide specific account numbers, to give access to balances and/or transactions for them (TransactionAccounts and BalanceAccounts properties).
MultipleAccounts (4) – (Premium Connectors Only!!!) PSU must provide specific account numbers, to give access to balances and transactions for them (Accounts property).

1 2 3 4

currencyOption

int32

NA (0)
Optional (1) – Currency is optional.
Required (2) – Currency is required.

1 2

linkingOption

int32

Linked (0) – all accounts have to be added and/or renewed together at the same time.
Separate (1) – accounts can be added and/or renewed separately.

1

transactionsSavingDateField

int32

ExecutionDate (0) – transactions are processed using their ExecutionDate.
ValueDate (1) – transactions are processed using their ValueDate.

1

accountSchemes

array of int32s | null

accountSchemes

browserData

object | null

psuIp

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuIpPort

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuAccept

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuAcceptCharset

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuAcceptEncoding

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuAcceptLanguage

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuDate

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuDeviceId

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuGeoLocation

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuHttpMethod

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuLastLoggedTime

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuReferer

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

psuUserAgent

int32

Required (0) – The field is required.
Optional (1) – The field is optional.
Unused (2) – The field won't be transmitted to the bank
RequiredIfInternational (3) – The field is required if in international use (creditor from different country than debtor).

1 2 3

additionalPropertiesRequested

array of objects | null

additionalPropertiesRequested

object

name

string | null

Property name

title

string | null

Property title (display name)

required

boolean

Indicates if property is required

description

string | null

Property description

template

string | null

Property template (regex)

Headers

object

X-Request-ID

string

Contains the X-Request-ID provided in the headers of the request.

X-Correlation-ID

string

Unique identifier for all the calls of the same flow. In direct/TPP mode, the value provided in the headers of the request. In Gateway mode, provided by the Gateway. Required for customer support

X-Operation-ID

string

Unique identifier of the request. Gateway mode only. Empty in direct/TPP mode. Required for customer support.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/ob/Ais/access/options/0 \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request Accounts Access Options

400Error