Consent API for V2.x (2.1)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

Create, retrieve, and cancel the consents a PSU grants for account information and confirmation of funds. A consent records which data the TPP may access, how long the access lasts, and how often it can be used, and it moves through a defined set of statuses over its lifecycle.

Create consent

POST /v2/consents/account-access

Creates an account information consent resource at the ASPSP regarding access to account information to account types and accounts specified in this request.

Header parameters

Header	Type	Description
PSU-IP-Port	string , optional	The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available. Example: `1234`
PSU-Accept	string , optional	The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: `application/json`
PSU-Accept-Charset	string , optional	The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: `*`
PSU-Accept-Encoding	string , optional	The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: `*`
PSU-Accept-Language	string , optional	The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available. Example: `en-gb,en;0.8`
PSU-User-Agent	string , optional	The forwarded Agent header field of the HTTP request between PSU and TPP, if available. Example: `Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0`
PSU-Http-Method	string , optional	HTTP method used at the PSU ? TPP interface, if available. Valid values are: * GET * POST * PUT * PATCH * DELETE Allowed values: GET, POST, PUT, PATCH, DELETE Example: `GET`
PSU-Device-ID	string , optional	UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. Example: `99435c7e-ad88-49ec-a2ad-99ddcb1f5555` Format: uuid
PSU-Geo-Location	string , optional	The forwarded Geo Location of the corresponding http request between PSU and TPP if available. Example: `GEO:52.506931;13.144558` Pattern: ^GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6}$
PSU-ID	string , optional	Client ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP's documentation. It might be contained even if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session. In this case the ASPSP might check whether PSU-ID and token match, according to ASPSP documentation. Example: `PSU-1234` Allowed length: max: 140
PSU-ID-Type	string , optional	Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. In this case, the mean and use are then defined in the ASPSP's documentation. Example: `PSU-ID-TYPE_C` Allowed length: max: 35
PSU-Corporate-ID	string , optional	Might be mandated in the ASPSP's documentation. Only used in a corporate context. Example: `PSU-CORP-ID1234` Allowed length: max: 140
PSU-Corporate-ID-Type	string , optional	Might be mandated in the ASPSP's documentation. Only used in a corporate context. Example: `PSU-CORP-ID-TYPE_A` Allowed length: max: 35
Client-SCA-Approach-Preference	string , optional	A comma separated list of attributes, where the first entry will have a higher priority than the next or to every SCA Approach which is not indicated at all, e.g. "decoupled, redirect, embedded" or "decoupled" This attribute may be ignored by the ASPSP Allowed values: redirect Example: `redirect`
Client-Redirect-URI	string , optional	URI the transaction flow returns to after a redirect. Required for the redirect SCA approach. Example: `https://exampleclient.com/redirectUri?clientEvent=11111111` Format: uri
Client-Nok-Redirect-URI	string , optional	If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the Client-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP. Example: `https://exampleclient.com/NokUri?clientEvent=11111111` Format: uri
Client-Explicit-Authorisation-Preferred	boolean , optional	If it equals "true", the API Client prefers to start the authorisation process separately, e.g. because of the usage of a signing basket or because of asynchronous authorisation. This preference might be ignored by the ASPSP, if a signing basket is not supported as functionality or if asynchronous authorisation is not supported. If it equals "false" or if the parameter is not used, there is no preference of the API Client. This especially indicates that the API Client assumes a direct authorisation of the transaction in the next step, without using a signing basket. Example: `true`
Client-Notification-URI	string , optional	URI for the Endpoint of the Client API to which the status of the resource should be sent. This header field may by ignored by the ASPSP if the resource status push function is not supported for the related API client. Example: `https://exampleclient.com/NotificationUri?clientEvent=11111111`
Client-Notification-Content-Preferred	string , optional	The string has the form status=X1, ..., Xn where Xi is one of the constants SCA, PROCESS, LAST and where constants are not repeated. The usage of the constants supports the of following semantics: SCA: A notification on every change of the scaStatus attribute for all related authorisation processes is preferred by the API Client. PROCESS: A notification on all changes of consentStatus or transactionStatus attributes is preferred by the API Client. LAST: Only a notification on the last consentStatus or transactionStatus as available in the XS2A interface is preferred by the API Client. This header field may be ignored, if the ASPSP does not support resource notification services for the related API Client. Example: `status=SCA`
Client-Brand-Logging-Information	string , optional	This header might be used by API Clients to inform the ASPSP about the brand used by the API Client towards the PSU. This information is meant for logging entries to enhance communication between ASPSP and PSU or ASPSP and API Client. This header might be ignored by the ASPSP. Example: `ClientBrandB` Allowed length: max: 140
Digest	string , optional	Integrity hash of the request body in the form `SHA-256=<base64>`. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built. Example: `SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=`
x-jws-signature	string , optional	Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed.
X-Request-ID	string , required	Unique ID of the request, set by the initiating party and echoed back in the response. Example: `99391c7e-ad88-49ec-a2ad-99ddcb1f7721` Format: uuid
Body-Sig-Profile	string , optional	Indicates the signature profile used for signing (parts of) the body. Shall be used if the body is signed. Allowed values: JAdES_JS, XAdES, EMV_AC Example: `XAdES`
Body-Enc-Profile	string , optional	Indicates the encryption profile used for the encryption of (parts of) the body. Allowed values: JWE_CS, XML_ENC Example: `JWE_CS`
Body-Enc-List	string , optional	Contains a List of names of data elements/ attributes of the body which contain encrypted information Example: `BODY`
PSU-IP-Address	string , required	IP address of the PSU's device as forwarded by the TPP. If unavailable, use the IP address the TPP used for this request. Example: `192.168.8.78` Format: ipv4

Body payload

Field	Type	Description
access	oneOf , required	The payment accounts the consent grants access to. See Consent types for how consent types differ.
cards	array[object] , optional	Account access rights for consentType "global". Only "ais" and "ownerName" allowed; account reference not used.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: ais, ownerName
payments	array[object] , optional	Account access rights for consentType "global". Only "ais" and "ownerName" allowed; account reference not used.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: ais, ownerName
cardAccounts	array[object] , optional	Account access rights for consentType "global". Only "ais" and "ownerName" allowed; account reference not used.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: ais, ownerName
validTo	string , required	This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date
consentType	string , required	The technical consent type. NOTE: The choice of this type has an effect on attribute conditions in the "access" attribute, see below. Allowed values: global, detailed, aspspManaged, accountList
frequencyPerDay	integer , required	This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4. Example: `4` Value: >= 1 <= 4
recurringIndicator	boolean , required	`true` for recurring access to the account data, `false` for one-off access.

Field	Type	Description
access	oneOf , required	The payment accounts the consent grants access to. See Consent types for how consent types differ.
cards	array[object] , optional	Account access rights for consentType "detailed". Account reference mandated; rights from detailed allowlist.
rights	array[string] , required	Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName, initiatePayments
account	object , required	Identifies an account. Use iban for payment accounts; currency narrows a multi-currency account.
pan	string , optional	Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.
bban	string , optional	BBAN of the account. This data elements is used for payment accounts which have no IBAN.
iban	string , optional	International Bank Account Number.
name	string , optional	Name of the account
other	object , optional	An alias with a proprietary coding
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of an account.
schemeNameCode	string , optional	An entry provided by an external ISO code list Allowed values: AIIN, BBAN, CUID, UPIC
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
owner	object , optional	A party involved in the transaction.
name	string , optional	Name of the party.
postaladdress	object , optional	Postal Address of the party.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
proxy	object , optional	A proxy that identifies the account, such as a phone number or email.
typeCode	string , optional	Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
identification	string , required
typeProprietary	string , optional
msisdn	string , optional	An alias to access a payment account via a registered mobile phone number.
currency	string , optional	ISO 4217 Alpha 3 currency code
servicer	object , optional	Identification of a financial institution.
name	string , optional	Name of the financial institution
bicfi	string , optional	Business Identifier Code (BIC) of a financial institution.
other	object , optional	Unique identification of an organisation, as assigned by an institution, using an identification scheme.
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of a financial insitution.
schemeNameCode	string , optional	An entry provided by an external ISO code list
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
postalAddress	object , optional	Postal Address of the financial institution.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
clearingSystemMemberId	object , optional	Information used to identify a member within a clearing system.
memberId	string , optional	Identification of a member of a clearing system.
clearingSystemIdentificationCode	string , optional	Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK
clearingSystemIdentificationProprietary	string , optional	Identification code for a clearing system, that has not yet been identified in the list of clearing systems.
maskedPan	string , optional	Primary Account Number (PAN) of a card in a masked form.
payments	array[object] , optional	Account access rights for consentType "detailed". Account reference mandated; rights from detailed allowlist.
rights	array[string] , required	Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName, initiatePayments
account	object , required	Identifies an account. Use iban for payment accounts; currency narrows a multi-currency account.
pan	string , optional	Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.
bban	string , optional	BBAN of the account. This data elements is used for payment accounts which have no IBAN.
iban	string , optional	International Bank Account Number.
name	string , optional	Name of the account
other	object , optional	An alias with a proprietary coding
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of an account.
schemeNameCode	string , optional	An entry provided by an external ISO code list Allowed values: AIIN, BBAN, CUID, UPIC
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
owner	object , optional	A party involved in the transaction.
name	string , optional	Name of the party.
postaladdress	object , optional	Postal Address of the party.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
proxy	object , optional	A proxy that identifies the account, such as a phone number or email.
typeCode	string , optional	Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
identification	string , required
typeProprietary	string , optional
msisdn	string , optional	An alias to access a payment account via a registered mobile phone number.
currency	string , optional	ISO 4217 Alpha 3 currency code
servicer	object , optional	Identification of a financial institution.
name	string , optional	Name of the financial institution
bicfi	string , optional	Business Identifier Code (BIC) of a financial institution.
other	object , optional	Unique identification of an organisation, as assigned by an institution, using an identification scheme.
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of a financial insitution.
schemeNameCode	string , optional	An entry provided by an external ISO code list
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
postalAddress	object , optional	Postal Address of the financial institution.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
clearingSystemMemberId	object , optional	Information used to identify a member within a clearing system.
memberId	string , optional	Identification of a member of a clearing system.
clearingSystemIdentificationCode	string , optional	Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK
clearingSystemIdentificationProprietary	string , optional	Identification code for a clearing system, that has not yet been identified in the list of clearing systems.
maskedPan	string , optional	Primary Account Number (PAN) of a card in a masked form.
cardAccounts	array[object] , optional	Account access rights for consentType "detailed". Account reference mandated; rights from detailed allowlist.
rights	array[string] , required	Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName, initiatePayments
account	object , required	Identifies an account. Use iban for payment accounts; currency narrows a multi-currency account.
pan	string , optional	Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements.
bban	string , optional	BBAN of the account. This data elements is used for payment accounts which have no IBAN.
iban	string , optional	International Bank Account Number.
name	string , optional	Name of the account
other	object , optional	An alias with a proprietary coding
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of an account.
schemeNameCode	string , optional	An entry provided by an external ISO code list Allowed values: AIIN, BBAN, CUID, UPIC
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
owner	object , optional	A party involved in the transaction.
name	string , optional	Name of the party.
postaladdress	object , optional	Postal Address of the party.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
proxy	object , optional	A proxy that identifies the account, such as a phone number or email.
typeCode	string , optional	Type of the proxy identification Allowed values: TELE, EMAL, DNAM, CINC, COTX, COID, CUST, DRLC, EIDN, EWAL, PVTX, LEIC, MBNO, NIDN, CCPT, SHID, SOSE, TOKN, UBIL, VIPN, BIID
identification	string , required
typeProprietary	string , optional
msisdn	string , optional	An alias to access a payment account via a registered mobile phone number.
currency	string , optional	ISO 4217 Alpha 3 currency code
servicer	object , optional	Identification of a financial institution.
name	string , optional	Name of the financial institution
bicfi	string , optional	Business Identifier Code (BIC) of a financial institution.
other	object , optional	Unique identification of an organisation, as assigned by an institution, using an identification scheme.
issuer	string , optional	Issuer of the identification
identification	string , required	Unique and unambiguous identification of a financial insitution.
schemeNameCode	string , optional	An entry provided by an external ISO code list
schemeNameProprietary	string , optional	A scheme name defined in a proprietary way.
postalAddress	object , optional	Postal Address of the financial institution.
room	string , optional	Building room number.
floor	string , optional	Floor or storey within a building.
country	string , optional	Nation with its own government. Usage Rule: If address lines are not used, this attribute is mandatrory.
postBox	string , optional	Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for.
postCode	string , optional	Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
townName	string , optional	Name of a built-up area, with defined boundaries, and a local government. Usage Rule: If address lines are not used, this attribute is mandatrory.
department	string , optional	Identification of a division of a large organisation or building.
streetName	string , optional	Name of a street or thoroughfare.
addressLines	array[string] , optional	At most seven entries are permitted. May only be used, if none of the structured address elements "streetName", "buildingNumber", "postcode" or "townName" is used. Remark: For SEPA transactions this is further restricted to a maximum of 1 entry.
buildingName	string , optional	Name of the building or house.
districtName	string , optional	Identifies a subdivision within a country sub-division.
subDepartment	string , optional	Identification of a sub-division of a large organisation or building.
buildingNumber	string , optional	Number that identifies the position of a building on a street.
townLocationName	string , optional	Specific location name within the town.
countrySubDivision	string , optional	Identifies a subdivision of a country such as state, region, county.
clearingSystemMemberId	object , optional	Information used to identify a member within a clearing system.
memberId	string , optional	Identification of a member of a clearing system.
clearingSystemIdentificationCode	string , optional	Identification of a clearing system, in a coded form as published in an external list. Allowed values: ATBLZ, AUBSB, CACPA, CHBCC, CHSIC, CNAPS, DEBLZ, ESNCC, GBDSC, GRBIC, HKNCC, IENCC, INFSC, ITNCC, JPZGN, NZNCC, PLKNR, PTNCC, RUCBC, SESBA, SGIBG, THCBC, TWNCC, USABA, USPID, ZANCC, NZRSA, MZBMO, CNCIP, KRBOK
clearingSystemIdentificationProprietary	string , optional	Identification code for a clearing system, that has not yet been identified in the list of clearing systems.
maskedPan	string , optional	Primary Account Number (PAN) of a card in a masked form.
validTo	string , required	This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date
consentType	string , required	The technical consent type. NOTE: The choice of this type has an effect on attribute conditions in the "access" attribute, see below. Allowed values: global, detailed, aspspManaged, accountList
frequencyPerDay	integer , required	This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4. Example: `4` Value: >= 1 <= 4
recurringIndicator	boolean , required	`true` for recurring access to the account data, `false` for one-off access.

Field	Type	Description
access	oneOf , required	The payment accounts the consent grants access to. See Consent types for how consent types differ.
cards	array[object] , optional	Account access rights for consentType "aspspManaged". No account reference; rights from aspspManaged allowlist; empty rights allowed.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName
payments	array[object] , optional	Account access rights for consentType "aspspManaged". No account reference; rights from aspspManaged allowlist; empty rights allowed.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName
cardAccounts	array[object] , optional	Account access rights for consentType "aspspManaged". No account reference; rights from aspspManaged allowlist; empty rights allowed.
rights	array[string] , required	Access rights requested for the payment accounts. Values are described in Access rights. Allowed values: accountDetails, balances, transactions, trustedBeneficiaries, ownerName, psuName
validTo	string , required	This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date
consentType	string , required	The technical consent type. NOTE: The choice of this type has an effect on attribute conditions in the "access" attribute, see below. Allowed values: global, detailed, aspspManaged, accountList
frequencyPerDay	integer , required	This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4. Example: `4` Value: >= 1 <= 4
recurringIndicator	boolean , required	`true` for recurring access to the account data, `false` for one-off access.

Field	Type	Description
access	oneOf , required	The payment accounts the consent grants access to. See Consent types for how consent types differ.
cards	array[object] , optional	Account access rights for consentType "accountList". No account reference; rights from accountList allowlist.
rights	array[string] , required	Allowed values: accountDetails, ownerName, balances
payments	array[object] , optional	Account access rights for consentType "accountList". No account reference; rights from accountList allowlist.
rights	array[string] , required	Allowed values: accountDetails, ownerName, balances
cardAccounts	array[object] , optional	Account access rights for consentType "accountList". No account reference; rights from accountList allowlist.
rights	array[string] , required	Allowed values: accountDetails, ownerName, balances
validTo	string , required	This parameter is defining a valid until date (including the mentioned date) for the requested consent. The content is the local ASPSP date in ISODate Format, e.g. 2024-10-30. Future dates might get adjusted by ASPSP. If a maximum available date is requested, a date in far future is to be used: "9999-12-31". In both cases, the consent object to be retrieved by the GET Consent Request will contain the adjusted date. The support of this adaption of the maximum available date is mandatory for the ASPSP. Format: date
consentType	string , required	The technical consent type. NOTE: The choice of this type has an effect on attribute conditions in the "access" attribute, see below. Allowed values: global, detailed, aspspManaged, accountList
frequencyPerDay	integer , required	This field indicates the requested maximum frequency for an access without PSU involvement per day. For a one-off access, this attribute is set to "1". The frequency needs to be greater equal to one. If not otherwise agreed bilaterally between TPP and ASPSP, the frequency is less equal to 4. Example: `4` Value: >= 1 <= 4
recurringIndicator	boolean , required	`true` for recurring access to the account data, `false` for one-off access.

Responses

Select a status code to see the structure and an example of the response.

Field	Type	Description
consentId	string , required	Identification of the consent resource as it is used in the API structure
psuMessage	string , optional	Text to be displayed to the PSU.
scaMethods	array[object] , optional	The authentication methods available to the PSU. Returned when SCA is required and the PSU can choose between methods.
name	string , required	This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
explanation	string , optional	detailed information about the SCA method for the PSU
authenticationType	string , required	Type of the authentication method. Allowed values: SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP
authenticationVersion	string , optional	Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP's documentation.
authenticationMethodId	string , required	An identification provided by the ASPSP for the later identification of the authentication method selection.
challengeData	object , optional	It is contained in addition to the data element "chosenScaMethod" if challenge data is needed for SCA. In rare cases this attribute is also used in the context of the "startAuthorisationWithPsuAuthentication" or "startAuthorisactionWithEncryptedPsuAuthentication" link.
data	array[string] , optional	A collection of challenge data
image	string , optional	PNG data (max. 512 kilobyte) to be displayed to the PSU, Base64 encoding, cp. [RFC4648]. This attribute is used only, when PHOTO_OTP or CHIP_OTP is the selected SCA method.
imageLink	string , optional	A link where the ASPSP will provides the challenge image for the TPP.
otpFormat	string , optional	The format type of the OTP to be typed in. The admitted values are "characters" or "integer".
otpMaxLength	integer , optional	The maximal length for the OTP to be typed in by the PSU.
additionalInformation	string , optional	Additional explanation for the PSU to explain e.g. fallback mechanism for the chosen SCA method. The TPP is obliged to show this to the PSU.
consentStatus	string , required	Status of the consent. Statuses are described in Consent statuses. Allowed values: received, rejected, partiallyAuthorised, valid, revokedByPsu, expired, terminatedByTpp, replacedByTpp
chosenScaMethod	object , optional	The authentication method selected for the PSU. Returned when the bank uses the embedded SCA approach with a single method.
name	string , required	This is the name of the authentication method defined by the PSU in the Online Banking frontend of the ASPSP. Alternatively this could be a description provided by the ASPSP like "SMS OTP on phone +49160 xxxxx 28". This name shall be used by the TPP when presenting a list of authentication methods to the PSU, if available.
explanation	string , optional	detailed information about the SCA method for the PSU
authenticationType	string , required	Type of the authentication method. Allowed values: SMS_OTP, CHIP_OTP, PHOTO_OTP, PUSH_OTP, SMTP_OTP
authenticationVersion	string , optional	Depending on the "authenticationType". This version can be used by differentiating authentication tools used within performing OTP generation in the same authentication type. This version can be referred to in the ASPSP's documentation.
authenticationMethodId	string , required	An identification provided by the ASPSP for the later identification of the authentication method selection.
_links	object , required	A list of hyperlinks to be recognised by the API Client. The actual hyperlinks used in the response depend on the dynamical decisions of the ASPSP when processing the request. The potential links for this response message are generically defined in [oFA SMPF] for all Transaction Initiation Response messages. These links will also be contained in the related Open API files. Remark: All links can be relative or full links, to be decided by the ASPSP.
self	object , optional	A hyperlink object containing the target URL.
href	string , required
status	object , optional	A hyperlink object containing the target URL.
href	string , required
scaOAuth	object , optional	A hyperlink object containing the target URL.
href	string , required
scaStatus	object , optional	A hyperlink object containing the target URL.
href	string , required
scaRedirect	object , optional	A hyperlink object containing the target URL.
href	string , required
confirmation	object , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisation	object , optional	A hyperlink object containing the target URL.
href	string , required
encryptionCertificates	array[object] , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisationWithPsuAuthentication	object , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisationWithPsuIdentification	object , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisationWithTransactionAuthorisation	object , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisationWithEncryptedPsuAuthentication	object , optional	A hyperlink object containing the target URL.
href	string , required
startAuthorisationWithAuthenticationMethodSelection	object , optional	A hyperlink object containing the target URL.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 400 (BAD_REQUEST). Allowed values: FORMAT_ERROR, PARAMETER_NOT_CONSISTENT, PARAMETER_NOT_SUPPORTED, SERVICE_INVALID, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED, RESOURCE_BLOCKED, TIMESTAMP_INVALID, PERIOD_INVALID, SCA_METHOD_UNKNOWN, SCA_INVALID, CONSENT_TYPE_NOT_SUPPORTED, SESSIONS_NOT_SUPPORTED Example: `FORMAT_ERROR`
path	string , optional	JSON path to the request field the message relates to, when applicable.
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Whether the message is an error or a warning. Allowed values: ERROR, WARNING
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
orders	object , optional	A link to the resource providing the list of orders of one securitiesAccount.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
download	object , optional	Download link for huge AIS data packages.
href	string , required
previous	object , optional	Navigation link for paginated account reports.
href	string , required
scaOAuth	object , optional	A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach.
href	string , required
ibanCheck	object , optional	A link to the endpoint offering the addressed iban check result.
href	string , required
positions	object , optional	A link to the resource providing the list of positions of one securitiesAccount.
href	string , required
scaStatus	object , optional	A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource.
href	string , required
cardAccount	object , optional	A link to the resource providing the details of one card account.
href	string , required
loanAccount	object , optional	A link to the resource providing the details of a loan account.
href	string , required
onboardings	object , optional	A link to commercially onboard to the related API, see openFinance, Admin Services for more details.
href	string , required
scaRedirect	object , optional	A link to an ASPSP site where SCA is performed within the Redirect SCA approach.
href	string , required
confirmation	object , optional	"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.
href	string , required
orderDetails	object , optional	A link to the resource providing details of one specific order.
href	string , required
subscription	object , optional	A link to the resource providing the details of a subscription for Push AIS Services.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required
aspspContacts	object , optional	A hyperlink object containing the target URL.
href	string , required
relatedOrders	array[object] , optional	An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order).
href	string , required
aspspDowntimes	object , optional	A hyperlink object containing the target URL.
href	string , required
readConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
savingsAccount	object , optional	A link to the resource providing the details of a savings account.
href	string , required
aspspParameters	object , optional	A hyperlink object containing the target URL.
href	string , required
transactionfees	object , optional	The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource.
href	string , required
cardTransactions	object , optional	A link to the resource providing the transaction history of a dedicated card account.
href	string , required
confirmConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
confirmInitiation	object , optional	link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution.
href	string , required
paymentInitiation	object , optional	A link to an initiation related to a payment resource.
href	string , required
securitiesAccount	object , optional	A link to the resource providing the details of one securitiesAccount.
href	string , required
entryStatusRevoked	array[object] , optional	Links to entry endpoints where the entry status is revoked.
href	string , required
startAuthorisation	object , optional	A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.
href	string , required
transactionDetails	object , optional	A link to the resource providing details of a dedicated transaction.
href	string , required
relatedTransactions	array[object] , optional	An array of links to request securities transaction details of transactions that resulted from this order.
href	string , required
authoriseTransaction	object , optional	The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach.
href	string , required
updateProprietaryData	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the proprietary data.
href	string , required
updatePsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet.
href	string , required
updatePsuIdentification	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet.
href	string , required
creditorNameConfirmation	object , optional	A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation.
href	string , required
selectAuthenticationMethod	object , optional	This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods.
href	string , required
updateEncryptedPsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet.
href	string , required
startAuthorisationWithProprietaryData	object , optional	A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink.
href	string , required
updateResourceByDebtorAccountResource	object , optional	A link to a payment related resource which needs to be updated by an account, referenced by a resource identification.
href	string , required
startAuthorisationWithPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithPsuIdentification	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithTransactionAuthorisation	object , optional	A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach.
href	string , required
startAuthorisationWithEncryptedPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithAuthenticationMethodSelection	object , optional	This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 401 (UNAUTHORIZED). Allowed values: CERTIFICATE_INVALID, ROLE_INVALID, CERTIFICATE_EXPIRED, CERTIFICATE_BLOCKED, CERTIFICATE_REVOKED, CERTIFICATE_MISSING, CLIENT_INVALID, CLIENT_INCONSISTENT, API_CONTRACT_ID_INVALID, SIGNATURE_INVALID, SIGNATURE_MISSING, PSU_CREDENTIALS_INVALID, CORPORATE_ID_INVALID, CONSENT_INVALID, CONSENT_EXPIRED, TOKEN_UNKNOWN, TOKEN_INVALID, TOKEN_EXPIRED Example: `CERTIFICATE_INVALID`
path	string , optional	JSON path to the request field the message relates to, when applicable.
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Whether the message is an error or a warning. Allowed values: ERROR, WARNING
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
orders	object , optional	A link to the resource providing the list of orders of one securitiesAccount.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
download	object , optional	Download link for huge AIS data packages.
href	string , required
previous	object , optional	Navigation link for paginated account reports.
href	string , required
scaOAuth	object , optional	A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach.
href	string , required
ibanCheck	object , optional	A link to the endpoint offering the addressed iban check result.
href	string , required
positions	object , optional	A link to the resource providing the list of positions of one securitiesAccount.
href	string , required
scaStatus	object , optional	A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource.
href	string , required
cardAccount	object , optional	A link to the resource providing the details of one card account.
href	string , required
loanAccount	object , optional	A link to the resource providing the details of a loan account.
href	string , required
onboardings	object , optional	A link to commercially onboard to the related API, see openFinance, Admin Services for more details.
href	string , required
scaRedirect	object , optional	A link to an ASPSP site where SCA is performed within the Redirect SCA approach.
href	string , required
confirmation	object , optional	"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.
href	string , required
orderDetails	object , optional	A link to the resource providing details of one specific order.
href	string , required
subscription	object , optional	A link to the resource providing the details of a subscription for Push AIS Services.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required
aspspContacts	object , optional	A hyperlink object containing the target URL.
href	string , required
relatedOrders	array[object] , optional	An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order).
href	string , required
aspspDowntimes	object , optional	A hyperlink object containing the target URL.
href	string , required
readConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
savingsAccount	object , optional	A link to the resource providing the details of a savings account.
href	string , required
aspspParameters	object , optional	A hyperlink object containing the target URL.
href	string , required
transactionfees	object , optional	The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource.
href	string , required
cardTransactions	object , optional	A link to the resource providing the transaction history of a dedicated card account.
href	string , required
confirmConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
confirmInitiation	object , optional	link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution.
href	string , required
paymentInitiation	object , optional	A link to an initiation related to a payment resource.
href	string , required
securitiesAccount	object , optional	A link to the resource providing the details of one securitiesAccount.
href	string , required
entryStatusRevoked	array[object] , optional	Links to entry endpoints where the entry status is revoked.
href	string , required
startAuthorisation	object , optional	A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.
href	string , required
transactionDetails	object , optional	A link to the resource providing details of a dedicated transaction.
href	string , required
relatedTransactions	array[object] , optional	An array of links to request securities transaction details of transactions that resulted from this order.
href	string , required
authoriseTransaction	object , optional	The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach.
href	string , required
updateProprietaryData	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the proprietary data.
href	string , required
updatePsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet.
href	string , required
updatePsuIdentification	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet.
href	string , required
creditorNameConfirmation	object , optional	A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation.
href	string , required
selectAuthenticationMethod	object , optional	This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods.
href	string , required
updateEncryptedPsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet.
href	string , required
startAuthorisationWithProprietaryData	object , optional	A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink.
href	string , required
updateResourceByDebtorAccountResource	object , optional	A link to a payment related resource which needs to be updated by an account, referenced by a resource identification.
href	string , required
startAuthorisationWithPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithPsuIdentification	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithTransactionAuthorisation	object , optional	A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach.
href	string , required
startAuthorisationWithEncryptedPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithAuthenticationMethodSelection	object , optional	This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 403 (FORBIDDEN). Allowed values: SERVICE_BLOCKED, CONSENT_UNKNOWN, RESOURCE_UNKNOWN, RESOURCE_EXPIRED Example: `SERVICE_BLOCKED`
path	string , optional	JSON path to the request field the message relates to, when applicable.
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Whether the message is an error or a warning. Allowed values: ERROR, WARNING
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
orders	object , optional	A link to the resource providing the list of orders of one securitiesAccount.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
download	object , optional	Download link for huge AIS data packages.
href	string , required
previous	object , optional	Navigation link for paginated account reports.
href	string , required
scaOAuth	object , optional	A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach.
href	string , required
ibanCheck	object , optional	A link to the endpoint offering the addressed iban check result.
href	string , required
positions	object , optional	A link to the resource providing the list of positions of one securitiesAccount.
href	string , required
scaStatus	object , optional	A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource.
href	string , required
cardAccount	object , optional	A link to the resource providing the details of one card account.
href	string , required
loanAccount	object , optional	A link to the resource providing the details of a loan account.
href	string , required
onboardings	object , optional	A link to commercially onboard to the related API, see openFinance, Admin Services for more details.
href	string , required
scaRedirect	object , optional	A link to an ASPSP site where SCA is performed within the Redirect SCA approach.
href	string , required
confirmation	object , optional	"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.
href	string , required
orderDetails	object , optional	A link to the resource providing details of one specific order.
href	string , required
subscription	object , optional	A link to the resource providing the details of a subscription for Push AIS Services.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required
aspspContacts	object , optional	A hyperlink object containing the target URL.
href	string , required
relatedOrders	array[object] , optional	An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order).
href	string , required
aspspDowntimes	object , optional	A hyperlink object containing the target URL.
href	string , required
readConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
savingsAccount	object , optional	A link to the resource providing the details of a savings account.
href	string , required
aspspParameters	object , optional	A hyperlink object containing the target URL.
href	string , required
transactionfees	object , optional	The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource.
href	string , required
cardTransactions	object , optional	A link to the resource providing the transaction history of a dedicated card account.
href	string , required
confirmConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
confirmInitiation	object , optional	link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution.
href	string , required
paymentInitiation	object , optional	A link to an initiation related to a payment resource.
href	string , required
securitiesAccount	object , optional	A link to the resource providing the details of one securitiesAccount.
href	string , required
entryStatusRevoked	array[object] , optional	Links to entry endpoints where the entry status is revoked.
href	string , required
startAuthorisation	object , optional	A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.
href	string , required
transactionDetails	object , optional	A link to the resource providing details of a dedicated transaction.
href	string , required
relatedTransactions	array[object] , optional	An array of links to request securities transaction details of transactions that resulted from this order.
href	string , required
authoriseTransaction	object , optional	The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach.
href	string , required
updateProprietaryData	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the proprietary data.
href	string , required
updatePsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet.
href	string , required
updatePsuIdentification	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet.
href	string , required
creditorNameConfirmation	object , optional	A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation.
href	string , required
selectAuthenticationMethod	object , optional	This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods.
href	string , required
updateEncryptedPsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet.
href	string , required
startAuthorisationWithProprietaryData	object , optional	A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink.
href	string , required
updateResourceByDebtorAccountResource	object , optional	A link to a payment related resource which needs to be updated by an account, referenced by a resource identification.
href	string , required
startAuthorisationWithPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithPsuIdentification	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithTransactionAuthorisation	object , optional	A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach.
href	string , required
startAuthorisationWithEncryptedPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithAuthenticationMethodSelection	object , optional	This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call.
href	string , required

Field	Type	Description
apiClientMessages	array[object] , optional	Errors and warnings describing why the request failed. See Errors for the message format.
code	string , required	Message codes defined for AIS for HTTP Error code 405 (METHOD NOT ALLOWED). Allowed values: SERVICE_INVALID Example: `SERVICE_INVALID`
path	string , optional	JSON path to the request field the message relates to, when applicable.
text	string , optional	Example: `Text, maximum of 500 characters.` Allowed length: max: 500
category	string , required	Whether the message is an error or a warning. Allowed values: ERROR, WARNING
_links	object , optional	Hyperlinks to related resources.
last	object , optional	Navigation link for paginated account reports.
href	string , required
next	object , optional	Navigation link for paginated account reports.
href	string , required
self	object , optional	The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation.
href	string , required
first	object , optional	Navigation link for paginated account reports.
href	string , required
orders	object , optional	A link to the resource providing the list of orders of one securitiesAccount.
href	string , required
status	object , optional	A link to retrieve the status of the transaction resource.
href	string , required
account	object , optional	A link to the resource providing the details of one account
href	string , required
balances	object , optional	A link to the resource providing the balance of a dedicated account.
href	string , required
download	object , optional	Download link for huge AIS data packages.
href	string , required
previous	object , optional	Navigation link for paginated account reports.
href	string , required
scaOAuth	object , optional	A link to the bank's OAuth authorisation-server metadata, used with the OAuth-based SCA approach.
href	string , required
ibanCheck	object , optional	A link to the endpoint offering the addressed iban check result.
href	string , required
positions	object , optional	A link to the resource providing the list of positions of one securitiesAccount.
href	string , required
scaStatus	object , optional	A link to retrieve the status of the authorisation or cancellation-authorisation sub-resource.
href	string , required
cardAccount	object , optional	A link to the resource providing the details of one card account.
href	string , required
loanAccount	object , optional	A link to the resource providing the details of a loan account.
href	string , required
onboardings	object , optional	A link to commercially onboard to the related API, see openFinance, Admin Services for more details.
href	string , required
scaRedirect	object , optional	A link to an ASPSP site where SCA is performed within the Redirect SCA approach.
href	string , required
confirmation	object , optional	"confirmation": Might be added by the ASPSP if either the "scaRedirect" or "scaOAuth" hyperlink is returned in the same response message. This hyperlink defines the URL to the resource which needs to be updated with * a confirmation code as retrieved after the plain redirect authentication process with the ASPSP authentication server or * an access token as retrieved by submitting an authorization code after the integrated Oauth based authentication process with the ASPSP authentication server.
href	string , required
orderDetails	object , optional	A link to the resource providing details of one specific order.
href	string , required
subscription	object , optional	A link to the resource providing the details of a subscription for Push AIS Services.
href	string , required
transactions	object , optional	A link to the resource providing the transaction history of a dedicated account.
href	string , required
aspspContacts	object , optional	A hyperlink object containing the target URL.
href	string , required
relatedOrders	array[object] , optional	An array of links to request order details of related orders related to the order that is represented by the data structure containing this element (e.g. other orders that originated from the same order split as this order).
href	string , required
aspspDowntimes	object , optional	A hyperlink object containing the target URL.
href	string , required
readConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
savingsAccount	object , optional	A link to the resource providing the details of a savings account.
href	string , required
aspspParameters	object , optional	A hyperlink object containing the target URL.
href	string , required
transactionfees	object , optional	The link is to the status resource. This link is only added within the authorisation process in case fee information is available via the status resource.
href	string , required
cardTransactions	object , optional	A link to the resource providing the transaction history of a dedicated card account.
href	string , required
confirmConditions	object , optional	A hyperlink object containing the target URL.
href	string , required
confirmInitiation	object , optional	link to a confirmation endpoint, where a payment initiation needs to be confirmed explicitly by the API Client for execution.
href	string , required
paymentInitiation	object , optional	A link to an initiation related to a payment resource.
href	string , required
securitiesAccount	object , optional	A link to the resource providing the details of one securitiesAccount.
href	string , required
entryStatusRevoked	array[object] , optional	Links to entry endpoints where the entry status is revoked.
href	string , required
startAuthorisation	object , optional	A link to an endpoint, where the authorisation of a transaction or the authorisation of a transaction cancellation shall be started with a POST command. No specific data is needed for this process start.
href	string , required
transactionDetails	object , optional	A link to the resource providing details of a dedicated transaction.
href	string , required
relatedTransactions	array[object] , optional	An array of links to request securities transaction details of transactions that resulted from this order.
href	string , required
authoriseTransaction	object , optional	The link to the payment initiation or consent resource, where the "Transaction Authorisation"Request" is sent to. This is the link to the resource which will authorise the payment or the consent by checking the SCA authentication data within the Embedded SCA approach.
href	string , required
updateProprietaryData	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the proprietary data.
href	string , required
updatePsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by a PSU password and eventually the PSU identification if not delivered yet.
href	string , required
updatePsuIdentification	object , optional	The link to the payment initiation or account information resource, which needs to be updated by the PSU identification if not delivered yet.
href	string , required
creditorNameConfirmation	object , optional	A link to an endpoint, where the submitted payment needs to be confirmed explicitly for execution after a verification of payee process has detected a deviation in the creditor account/creditor name pair. If this hyperlink is provided, the addressed payment will not be executed without a related confirmation.
href	string , required
selectAuthenticationMethod	object , optional	This is a link to a resource, where the TPP can select the applicable second factor authentication methods for the PSU, if there were several available authentication methods.
href	string , required
updateEncryptedPsuAuthentication	object , optional	The link to the payment initiation or account information resource, which needs to be updated by an encrypted PSU password and eventually the PSU identification if not delivered yet.
href	string , required
startAuthorisationWithProprietaryData	object , optional	A link to the endpoint, where the authorisation of a transaction or of a transaction cancellation shall be started, and where proprietary data needs to be updated with this call. The TPP can find the scope of missing proprietary data in the ASPSP documentation. The usage of this hyperlink is not further specified in the specification but is used analogously to e.g. the startAuthorisation withPsuIdentification hyperlink.
href	string , required
updateResourceByDebtorAccountResource	object , optional	A link to a payment related resource which needs to be updated by an account, referenced by a resource identification.
href	string , required
startAuthorisationWithPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithPsuIdentification	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where PSU identification shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithTransactionAuthorisation	object , optional	A link to an endpoint, where an authorisation of a transaction or a cancellation can be started, and where the response data for the challenge is uploaded in the same call for the transaction authorisation or transaction cancellation at the same time in the Embedded SCA Approach.
href	string , required
startAuthorisationWithEncryptedPsuAuthentication	object , optional	The link to an endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where encrypted PSU authentication data shall be uploaded with the corresponding call.
href	string , required
startAuthorisationWithAuthenticationMethodSelection	object , optional	This is a link to and endpoint where the authorisation of a transaction or of a transaction cancellation shall be started, where the selected SCA method shall be uploaded with the corresponding call.
href	string , required

curl -X POST \
  "https://openfinance.saltedge.com/test_bank/api/v2/consents/account-access" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721" \
  -H "PSU-IP-Address: 192.168.8.78" \
  -H "Content-Type: application/json" \
  -d '{
  "access": {
    "cards": [
      {
        "rights": [
          "ais"
        ]
      }
    ],
    "payments": [
      {
        "rights": [
          "ais"
        ]
      }
    ],
    "cardAccounts": [
      {
        "rights": [
          "ais"
        ]
      }
    ]
  },
  "validTo": "2026-09-30",
  "consentType": "global",
  "frequencyPerDay": 4,
  "recurringIndicator": true
}'

curl -X POST \
  "https://openfinance.saltedge.com/test_bank/api/v2/consents/account-access" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721" \
  -H "PSU-IP-Address: 192.168.8.78" \
  -H "Content-Type: application/json" \
  -d '{
  "access": {
    "cards": [
      {
        "rights": [
          "accountDetails"
        ],
        "account": {
          "pan": "Text, maximum of 35 characters.",
          "bban": "BARC12345612345678",
          "iban": "LT121000011101001000",
          "name": "Text, maximum of 70 characters.",
          "other": {
            "issuer": "Text, maximum of 35 characters.",
            "identification": "Text, maximum of 35 characters.",
            "schemeNameCode": "AIIN",
            "schemeNameProprietary": "Text, maximum of 35 characters."
          },
          "owner": {
            "name": "Text, maximum of 140 characters.",
            "postaladdress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            }
          },
          "proxy": {
            "typeCode": "EMAL",
            "identification": "Text, maximum of 2048 characters.",
            "typeProprietary": "Text, maximum of 35 characters."
          },
          "msisdn": "Text, maximum of 35 characters.",
          "currency": "EUR",
          "servicer": {
            "name": "Text, maximum of 140 characters.",
            "bicfi": "ECBFDEFFFIM",
            "other": {
              "issuer": "Text, maximum of 35 characters.",
              "identification": "Text, maximum of 35 characters.",
              "schemeNameCode": "string",
              "schemeNameProprietary": "Text, maximum of 35 characters."
            },
            "postalAddress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            },
            "clearingSystemMemberId": {
              "memberId": "Text, maximum of 35 characters.",
              "clearingSystemIdentificationCode": "DEBLZ",
              "clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
            }
          },
          "maskedPan": "Text, maximum of 35 characters."
        }
      }
    ],
    "payments": [
      {
        "rights": [
          "accountDetails"
        ],
        "account": {
          "pan": "Text, maximum of 35 characters.",
          "bban": "BARC12345612345678",
          "iban": "LT121000011101001000",
          "name": "Text, maximum of 70 characters.",
          "other": {
            "issuer": "Text, maximum of 35 characters.",
            "identification": "Text, maximum of 35 characters.",
            "schemeNameCode": "AIIN",
            "schemeNameProprietary": "Text, maximum of 35 characters."
          },
          "owner": {
            "name": "Text, maximum of 140 characters.",
            "postaladdress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            }
          },
          "proxy": {
            "typeCode": "EMAL",
            "identification": "Text, maximum of 2048 characters.",
            "typeProprietary": "Text, maximum of 35 characters."
          },
          "msisdn": "Text, maximum of 35 characters.",
          "currency": "EUR",
          "servicer": {
            "name": "Text, maximum of 140 characters.",
            "bicfi": "ECBFDEFFFIM",
            "other": {
              "issuer": "Text, maximum of 35 characters.",
              "identification": "Text, maximum of 35 characters.",
              "schemeNameCode": "string",
              "schemeNameProprietary": "Text, maximum of 35 characters."
            },
            "postalAddress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            },
            "clearingSystemMemberId": {
              "memberId": "Text, maximum of 35 characters.",
              "clearingSystemIdentificationCode": "DEBLZ",
              "clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
            }
          },
          "maskedPan": "Text, maximum of 35 characters."
        }
      }
    ],
    "cardAccounts": [
      {
        "rights": [
          "accountDetails"
        ],
        "account": {
          "pan": "Text, maximum of 35 characters.",
          "bban": "BARC12345612345678",
          "iban": "LT121000011101001000",
          "name": "Text, maximum of 70 characters.",
          "other": {
            "issuer": "Text, maximum of 35 characters.",
            "identification": "Text, maximum of 35 characters.",
            "schemeNameCode": "AIIN",
            "schemeNameProprietary": "Text, maximum of 35 characters."
          },
          "owner": {
            "name": "Text, maximum of 140 characters.",
            "postaladdress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            }
          },
          "proxy": {
            "typeCode": "EMAL",
            "identification": "Text, maximum of 2048 characters.",
            "typeProprietary": "Text, maximum of 35 characters."
          },
          "msisdn": "Text, maximum of 35 characters.",
          "currency": "EUR",
          "servicer": {
            "name": "Text, maximum of 140 characters.",
            "bicfi": "ECBFDEFFFIM",
            "other": {
              "issuer": "Text, maximum of 35 characters.",
              "identification": "Text, maximum of 35 characters.",
              "schemeNameCode": "string",
              "schemeNameProprietary": "Text, maximum of 35 characters."
            },
            "postalAddress": {
              "room": "Text, maximum of 70 characters.",
              "floor": "Text, maximum of 70 characters.",
              "country": "SE",
              "postBox": "16 Chars at most",
              "postCode": "16 Chars at most",
              "townName": "Text, maximum of 35 characters.",
              "department": "Text, maximum of 70 characters.",
              "streetName": "Text, maximum of 70 characters.",
              "addressLines": [
                "Text, maximum of 140 characters."
              ],
              "buildingName": "Text, maximum of 35 characters.",
              "districtName": "Text, maximum of 35 characters.",
              "subDepartment": "Text, maximum of 70 characters.",
              "buildingNumber": "16 Chars at most",
              "townLocationName": "Text, maximum of 35 characters.",
              "countrySubDivision": "Text, maximum of 35 characters."
            },
            "clearingSystemMemberId": {
              "memberId": "Text, maximum of 35 characters.",
              "clearingSystemIdentificationCode": "DEBLZ",
              "clearingSystemIdentificationProprietary": "Text, maximum of 35 characters."
            }
          },
          "maskedPan": "Text, maximum of 35 characters."
        }
      }
    ]
  },
  "validTo": "2026-09-30",
  "consentType": "detailed",
  "frequencyPerDay": 4,
  "recurringIndicator": true
}'

curl -X POST \
  "https://openfinance.saltedge.com/test_bank/api/v2/consents/account-access" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721" \
  -H "PSU-IP-Address: 192.168.8.78" \
  -H "Content-Type: application/json" \
  -d '{
  "access": {
    "cards": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ],
    "payments": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ],
    "cardAccounts": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ]
  },
  "validTo": "2026-09-30",
  "consentType": "aspspManaged",
  "frequencyPerDay": 4,
  "recurringIndicator": true
}'

curl -X POST \
  "https://openfinance.saltedge.com/test_bank/api/v2/consents/account-access" \
  -H "X-Request-ID: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721" \
  -H "PSU-IP-Address: 192.168.8.78" \
  -H "Content-Type: application/json" \
  -d '{
  "access": {
    "cards": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ],
    "payments": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ],
    "cardAccounts": [
      {
        "rights": [
          "accountDetails"
        ]
      }
    ]
  },
  "validTo": "2026-09-30",
  "consentType": "accountList",
  "frequencyPerDay": 4,
  "recurringIndicator": true
}'

{
  "consentId": "Text, maximum of 70 characters.",
  "psuMessage": "Text, maximum of 500 characters.",
  "scaMethods": [
    {
      "name": "string",
      "explanation": "string",
      "authenticationType": "PUSH_OTP",
      "authenticationVersion": "string",
      "authenticationMethodId": "Text, maximum of 35 characters."
    }
  ],
  "challengeData": {
    "data": [
      "string"
    ],
    "image": "string",
    "imageLink": "string",
    "otpFormat": "string",
    "otpMaxLength": 0,
    "additionalInformation": "string"
  },
  "consentStatus": "received",
  "chosenScaMethod": {
    "name": "string",
    "explanation": "string",
    "authenticationType": "PUSH_OTP",
    "authenticationVersion": "string",
    "authenticationMethodId": "Text, maximum of 35 characters."
  },
  "_links": {
    "self": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "startAuthorisation": {
      "href": "string"
    },
    "encryptionCertificates": [
      {
        "href": "string"
      }
    ],
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "FORMAT_ERROR",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "ERROR"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "CERTIFICATE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "ERROR"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_BLOCKED",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "ERROR"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}

{
  "apiClientMessages": [
    {
      "code": "SERVICE_INVALID",
      "path": "string",
      "text": "Text, maximum of 500 characters.",
      "category": "ERROR"
    }
  ],
  "_links": {
    "last": {
      "href": "string"
    },
    "next": {
      "href": "string"
    },
    "self": {
      "href": "string"
    },
    "first": {
      "href": "string"
    },
    "orders": {
      "href": "string"
    },
    "status": {
      "href": "string"
    },
    "account": {
      "href": "string"
    },
    "balances": {
      "href": "string"
    },
    "download": {
      "href": "string"
    },
    "previous": {
      "href": "string"
    },
    "scaOAuth": {
      "href": "string"
    },
    "ibanCheck": {
      "href": "string"
    },
    "positions": {
      "href": "string"
    },
    "scaStatus": {
      "href": "string"
    },
    "cardAccount": {
      "href": "string"
    },
    "loanAccount": {
      "href": "string"
    },
    "onboardings": {
      "href": "string"
    },
    "scaRedirect": {
      "href": "string"
    },
    "confirmation": {
      "href": "string"
    },
    "orderDetails": {
      "href": "string"
    },
    "subscription": {
      "href": "string"
    },
    "transactions": {
      "href": "string"
    },
    "aspspContacts": {
      "href": "string"
    },
    "relatedOrders": [
      {
        "href": "string"
      }
    ],
    "aspspDowntimes": {
      "href": "string"
    },
    "readConditions": {
      "href": "string"
    },
    "savingsAccount": {
      "href": "string"
    },
    "aspspParameters": {
      "href": "string"
    },
    "transactionfees": {
      "href": "string"
    },
    "cardTransactions": {
      "href": "string"
    },
    "confirmConditions": {
      "href": "string"
    },
    "confirmInitiation": {
      "href": "string"
    },
    "paymentInitiation": {
      "href": "string"
    },
    "securitiesAccount": {
      "href": "string"
    },
    "entryStatusRevoked": [
      {
        "href": "string"
      }
    ],
    "startAuthorisation": {
      "href": "string"
    },
    "transactionDetails": {
      "href": "string"
    },
    "relatedTransactions": [
      {
        "href": "string"
      }
    ],
    "authoriseTransaction": {
      "href": "string"
    },
    "updateProprietaryData": {
      "href": "string"
    },
    "updatePsuAuthentication": {
      "href": "string"
    },
    "updatePsuIdentification": {
      "href": "string"
    },
    "creditorNameConfirmation": {
      "href": "string"
    },
    "selectAuthenticationMethod": {
      "href": "string"
    },
    "updateEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithProprietaryData": {
      "href": "string"
    },
    "updateResourceByDebtorAccountResource": {
      "href": "string"
    },
    "startAuthorisationWithPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithPsuIdentification": {
      "href": "string"
    },
    "startAuthorisationWithTransactionAuthorisation": {
      "href": "string"
    },
    "startAuthorisationWithEncryptedPsuAuthentication": {
      "href": "string"
    },
    "startAuthorisationWithAuthenticationMethodSelection": {
      "href": "string"
    }
  }
}