Authorise UK Consent
POST /obp/v7.0.0/banks/BANK_ID/consents/CONSENT_ID/authorise
OBPv5.1.0-authoriseUKConsent No role required ConsentAccount Information Service (AIS)
Authorise a UK Open Banking account-access consent as the current (PSU) user, after SCA.
The TPP first lodges the intent via POST /account-access-consents; the consent is
created in AWAITINGAUTHORISATION state with no bound user and no bound
accounts. The PSU then starts SCA via POST .../authorise/challenge and submits the
resulting challenge_id plus the OTP answer, together with the account_ids the PSU
is selecting for this consent, here. On a valid answer this binds the consent to the PSU
and to those accounts — every permission the consent declared is granted on each selected
account — and transitions it to AUTHORISED, so subsequent UK data calls
whose access token carries the consent_id claim pass the consent check and are scoped to
exactly the accounts and permissions the PSU approved.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
BANK_ID: gh.29.uk
CONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
JSON request body fields (3)
- account_ids
- account_ids
- answer
- challenge_id
- 123chaneid13-6d02-40e3-a129-0b2bf89de9f0
JSON response body fields (3)
- consent_id
- 9d429899-24f5-42c8-8565-943ffa6a7947
- jwt
- eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
- status
Example request body
{
"challenge_id": "74a8ebda-9e5a-4c3f-9b0b-1a2b3c4d5e6f",
"answer": "123",
"account_ids": [
"8ca8a7e4-6d05-4b21-a165-c02c39d77e55"
]
}Example success response
{
"consent_id": "9d429899-24f5-42c8-8565-943ffa6a7945",
"jwt": "eyJhbGciOiJIUzI1NiJ9.eyJ2aWV3cyI6W119.signature",
"status": "AUTHORISED"
}Possible errors (10)
- OBP-20001: User not logged in. Authentication is required!
- OBP-35001: Consent not found by CONSENT_ID.
- OBP-35005: Consent-Id is not in status
- OBP-35003: Consent-Id is expired.
- OBP-35023: The Consent does not match a valid User.
- OBP-10001: Incorrect json format.
- OBP-40016: Invalid Challenge Answer. Please specify a valid value for answer in Json body. The challenge answer may be expired.Or you've used up your allowed attempts.Or if connector = mapped and transactionRequestType_OTP_INSTRUCTION_TRANSPORT = DUMMY and suggested_default_sca_method=DUMMY, the answer must be `123`. Or if connector = others, the challenge answer can be got by phone message or other security ways.
- OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.