API Explorer 936 endpoints

Get Consent Request

GET /obp/v7.0.0/consumer/consent-requests/CONSENT_REQUEST_ID

OBPv5.0.0-getConsentRequest No role required ConsentAccount Information Service (AIS)PSD2

Return the full payload of a previously-created Consent Request — the JSON the TPP submitted to Create Consent Request, plus the consent_request_id and the creating consumer_id.

Use this endpoint to verify the contents of a Consent Request before the User answers it.

Authentication: Application access (any registered consumer/application can read any Consent Request by ID).

Note: this endpoint will be restricted to the creating consumer in v6.0.0. Until then, treat CONSENT_REQUEST_IDs as sensitive — they reveal entitlements, account routings, and contact details (email/phone) submitted at creation.

User Authentication is Optional. The User need not be logged in.

URL Parameters:

CONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

JSON response body fields (3)
consent_request_id
8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
consumer_id
7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
payload
payload
Example success response
{
  "consent_request_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "payload": {
    "everything": false,
    "account_access": [
      {
        "account_routing": {
          "scheme": "OBP",
          "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
        },
        "view_id": "owner"
      }
    ],
    "phone_number": "+44 07972 444 876",
    "valid_from": "2022-06-14T12:42:00Z",
    "time_to_live": 3600
  },
  "consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
}
Possible errors (6)
  • OBP-10001: Incorrect json format.
  • OBP-35020: You exceeded max value of time to live of consents.
  • OBP-20306: PEM Encoded Certificate cannot be found at request header.
  • OBP-20300: PEM Encoded Certificate issue.
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Implemented by OBPv5.0.0 getConsentRequest Originally /obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID