Skip to main content

Create consent

POST 
/v1/consents

Description​

Create a consent that defines access rights to dedicated accounts. Create a new consent request and automatically expire any existing consent for recurring access on account information for the addressed PSU.

tip

This is the first step in the process where the Third-Party Provider (TPP) requests access to a user account.

Request​

Header Parameters

    X-Request-ID uuidrequired

    ID of the request sent to the server, unique to the call, as determined by the initiating party.

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    PSU_ID stringrequired

    The Personalized Security User Identification linked to the consent. The PSU's ID, as determined by the PSU. This ID is the identification of the PSU within the ASPSP and contains the username that requests the consent.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Body parameters

    access objectrequiredThe access information granted with the consent.
    accounts object[]The accounts linked to the consent.
  • Array [
    • iban stringrequiredThe International Bank Account Number (IBAN) provided in the request body.
    bban stringrequiredThe Basic Bank Account Number (BBAN) provided in the request body.
    pan stringrequiredThe Primary Bank Account Number (PAN) provided in the request body.
    maskedPan stringrequiredThe masked PAN provided in the request body.
    msisdn stringrequiredThe Mobile Subscriber Integrated Services Digital Network (MSISDN) provided in the request body.
    currency stringrequiredThe currency of the account.
  • ]
    • balances object[]The balances of the accounts that the consent is granted for.
  • Array [
    • iban stringrequiredThe International Bank Account Number (IBAN) of the account.
    bban stringrequiredThe Basic Bank Account Number (BBAN) of the account.
    pan stringrequiredThe Primary Account Number (PAN) of the account.
    maskedPan stringrequiredThe masked Primary Account Number of the account.
    msisdn stringrequiredThe Mobile Station International Subscriber Directory Number of the account.
    currency stringrequiredThe currency of the account.
  • ]
    • transactions object[]The transactions associated with the consent.
  • Array [
    • iban stringrequiredThe International Bank Account Number (IBAN) associated with the consent.
    bban stringrequiredThe Basic Bank Account Number (BBAN) associated with the consent.
    pan stringrequiredThe Primary Account Number (PAN) associated with the consent.
    maskedPan stringrequiredThe International Bank Account Number (IBAN) associated with the consent.
    msisdn stringrequiredThe Mobile Station International Subscriber Directory Number associated with the consent.
    currency stringrequiredThe currency in which the consent is created.
  • ]
    • availableAccounts stringrequiredIndicates if the consent is for all available accounts.
    availableAccountsWithBalance stringrequiredIndicates if the consent is for all available accounts with balances.
    allPsd2 stringrequiredIndicates if the consent is for all Payment Services Directive 2 (PSD2) services.
    recurringIndicator booleanrequiredAn indicator that specifies whether the consent is for recurring payments.
    validUntil daterequiredThe date and time until the consent is valid.
    frequencyPerDay int32requiredThe maximum frequency of payments per day allowed by the consent.
    combinedServiceIndicator booleanrequiredAn indicator that specifies whether a combined service is requested.

Responses​

Created
Schema
    consentStatus int32

    The status of the consent.
    Available options: 0 = "received", 1 = "rejected", 2 = "valid", 3 = "revokedByPsu", 4 = "expired", 5 = "terminatedByTpp".

    consentId stringThe consent ID, a unique identifier for the consent.
    scaMethods object[]The list of available SCA methods.
  • Array [
    • authenticationType int32

    The type of the authentication method.
    Description: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion string
    authenticationMethodId string

    Possible values: non-empty

    name string
    explanation string
  • ]
    • chosenScaMethod object
    authenticationType int32

    Possible values: [0, 1, 2, 3]


    Description: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP"

    authenticationVersion string
    authenticationMethodId string

    Possible values: non-empty

    name string
    explanation string
    challengeData object
    image byte
    data string[]
    imageLink string
    otpMaxLength int32
    otpFormat int32

    Possible values: [0, 1]


    Description: 0 = "CHARACTERS", 1 = "INTEGER"

    additionalInformation string
    links objectLinks or other resources related to the consent.
    message stringThe message related to the consent.
Loading...