consent

Authorize front-door

Begin the process of creating a consent.

post/consent/authorise

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/consent/authorise
  • Auth: none required

Request body

auth_session_idstring

The ID of the auth session

cancel_uristring
cdr_arrangement_idstring

An existing CDR Arrangement ID to update

client_idstring required

Client ID

consent_period_string'20 minutes' | '1 day' | '1 week' | '1 month' | '3 months' | '6 months' | '9 months' | '12 months' | 'Once-off' required

The consent period in string format

end_user_idstring required

The end user ID.

institution_idstring required

The institutions ID.

redirect_uristring
scopestring[]

The scopes to use

Example request

{
  "auth_session_id": "Qui soluta blanditiis recusandae qui et.",
  "cancel_uri": "https://www.powerpal.net/",
  "cdr_arrangement_id": "Dolorem quia ut magni suscipit.",
  "client_id": "Tempora quis fuga perferendis est qui quae.",
  "consent_period_string": "3 months",
  "end_user_id": "eu_2yRHN2ag2y4p8kCtm5DOeccZEXB",
  "institution_id": "85",
  "redirect_uri": "https://www.powerpal.net/cancel",
  "scope": [
    "Veniam mollitia beatae ut.",
    "Odit quia."
  ]
}

Response

OK response.

locationstring required

A link to the institutions site where the consent process and be continued

session_idstring required

The session ID of the authorisation request

Example response

{
  "location": "Velit fuga maxime quo beatae.",
  "session_id": "Amet commodi aspernatur."
}

Changes

No recorded changes to this operation across all 1 revision of this API.