Skip to main content

Start consent authorisation

POST 
/v1/consents/consentId/authorisations

Description​

Initiate the authorisation process for a specific consent.

tip

Trigger the authentication flow and select the appropriate authentication method.

important

It is essential for managing the security and authentication requirements within the PSD2 framework.

Request​

Path Parameters

    consentId stringrequired

    The consentId of the related consent.

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 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.

Responses​

Created
Schema
    scaStatus string

    The status of the SCA method.

    authorisationId string

    The ID of the autorisation.

    scaMethods object[]The methods available for the PSU to authorise the consent.
  • Array [
    • authenticationType int32

    The authentication type:
    Available options:
    0 = "SMSOTP"
    1 = "CHIPOTP"
    2 = "PHOTOOTP"
    3 = "PUSHOTP"

    authenticationVersion string

    The authentication version.

    authenticationMethodId string

    The authentication method ID.

    name string

    The name associated with the consent.

    explanation string

    An explanation for the consent authorisation.

  • ]
    • chosenScaMethod objectThe selected SCA (Strong Customer Authentication) method for the consent authorisation.
    authenticationType int32

    The authentication type.
    Available options:
    0 = "SMSOTP"
    1 = "CHIPOTP",
    2 = "PHOTOOTP",
    3 = "PUSHOTP"

    authenticationVersion string

    The version of the authentication.

    authenticationMethodId string

    The ID of the authentication method.

    name string

    The name associated with the consent.

    explanation string

    An explanation for the consent authorisation.

    challengeData objectThe challenge data for the consent authorisation.
    image byte

    The image associated with the consent authorisation.

    data string[]

    The data associated with the consent authorisation.

    imageLink string

    The link to the image associated with the consent authorisation.

    otpMaxLength int32

    The maximum length of the OTP associated with the consent authorisation.

    otpFormat int32

    The OTP format associated with the consent authorisation.
    Available options:
    0 = "CHARACTERS"
    1 = "INTEGER"

    additionalInformation string

    Additional Information associated with the consent authorisation.

    links objectLinks related to the consent authorisation.
    property name object
    href string
    psuMessage string

    The message for the PSU.

Loading...