Skip to main content
POST /account/consent

Starts a new account consent request. Depending on account information provider additional data will be inquired if needed to gather all needed data to facilitate the account access.

Query Parameters
    locale Locale

    Desired language (if supported). See supported languages for more information.

Request Body required

Initiates a new account consent request

    providerId ProviderId required

    Unique consent provider (bank) id

    otp ConsentOTP required

    OTP (One Time Password) to provided via SMS or email to initiate consent

    msisdn Msisdn

    Mobile phone number

    email Email

    Email address

    data object[]

    Additional internal data to be stored alongside consent. This can be internal customer profile id, or any other information to link consent to an internal process.

  • Array [
  • key string

    unique key of internally stored data. For instance basked_id, customer_id ...

    value string

    value of internally stored data.

  • ]
Responses

Newly initiated account consent


Schema
    inquiryId ConsentInquiryId

    Consent inquiry id

    consentId ConsentId

    Unique consent id

    status ConsentStatus

    Possible values: [initiated, started, received, rejected, partially_authorised, valid, revoked_by_psu, expired, terminated_by_tpp, failed]

    Consent status.

    created date-time

    RFC 3339 date time format (2007-11-06T16:34:41.000Z)

    modified date-time

    RFC 3339 date time format (2007-11-06T16:34:41.000Z)

    scope ConsentScope

    Possible values: [all, accounts, balances, transactions]

    Consent scopes for account information access.

    validUntil date-time

    RFC 3339 date time format (2007-11-06T16:34:41.000Z)

    consentData object[]

    Additional data needed to fulfill the consent request, to be provided by end user

  • Array [
  • name ConsentDataItemName required

    Possible values: [redirect, otp, iban, password, select, username, status]

    label string

    Label to display to the user to enter or select listed data

    additional_data string

    Display additional data to the user

    properties object[]
  • Array [
  • value string

    Value of additional data, as it was entered by the user

    label string

    Label to display to the client in order to enter additional data. This can be IBAN account number, a one-time password or similar.

    description string

    Description of additional data to be entered. Additional context (not necessary provided)

  • ]
  • value string
  • ]
  • providerId ProviderId

    Unique consent provider (bank) id

    name string

    Short info of the account consent intent. Will be visible int the customers consent list.

    description string

    Simple description of why account access is being used.

    owner object
    msisdn Msisdn

    Mobile phone number

    email Email

    Email address

    country CountryCode

    Account information provider country code (ISO 3166 alpha-2 codes)

    data object[]

    Additional internal data to be stored alongside consent. This can be internal customer profile id, or any other information to link consent to an internal process.

  • Array [
  • key string

    unique key of internally stored data. For instance basked_id, customer_id ...

    value string

    value of internally stored data.

  • ]
  • locale Locale

    Two letter ISO 639-1 language/locale code.

Loading...