ConsentsResponse201 Data Type

Body of the JSON response for a successful consent request.

Properties
name data type constraints description
consentStatus ConsentStatus required Get consentStatus
consentId string required ID of the corresponding consent object as returned by an account information consent request.
scaMethods array of AuthenticationObject   This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods. Depending on the risk management of the ASPSP this choice might be offered before or after the PSU has been identified with the first relevant factor, or if an access token is transported. If this data element is contained, then there is also a hyperlink of type 'startAuthorisationWithAuthenticationMethodSelection' contained in the response body. These methods shall be presented towards the PSU for selection by the TPP.
chosenScaMethod AuthenticationObject   Get chosenScaMethod
challengeData ChallengeData   Get challengeData
_links map of object required Get links
psuMessage string max size: 500, min size: 0 Text to be displayed to the PSU.

Example

{
  "consentStatus" : "TERMINATEDBYTPP",
  "consentId" : "...",
  "scaMethods" : [ {
    "authenticationType" : "PHOTO_OTP",
    "authenticationVersion" : "...",
    "authenticationMethodId" : "...",
    "name" : "...",
    "explanation" : "..."
  }, {
    "authenticationType" : "PUSH_OTP",
    "authenticationVersion" : "...",
    "authenticationMethodId" : "...",
    "name" : "...",
    "explanation" : "..."
  } ],
  "chosenScaMethod" : {
    "authenticationType" : "SMS_OTP",
    "authenticationVersion" : "...",
    "authenticationMethodId" : "...",
    "name" : "...",
    "explanation" : "..."
  },
  "challengeData" : {
    "image" : "...",
    "data" : [ "...", "..." ],
    "imageLink" : "...",
    "otpMaxLength" : 12345,
    "otpFormat" : "...",
    "additionalInformation" : "..."
  },
  "_links" : {
    "property1" : { },
    "property2" : { }
  },
  "psuMessage" : "..."
}