Consent Management APIs for UK

Consent Management APIs provide the capability to manage consents in a web application, on behalf of an end-user. A banking service consumer/ Account Servicing Payment Service Provider (ASPSP) may need to develop their own web application or use their own mechanism to deploy the consent management capabilities. At this point, a service provider needs a way to directly present consent resources to the end-user. In order to cater to this requirement, those consent capabilities (for example, consent creation/consent deletion) are presented as API resources in the Consent Management APIs.

Basic authentication for Consent Management APIs

By default, the Consent Management APIs are secured with basic authentication. To access the Consent Management APIs, use the default user or create a new user using the WSO2 Open Banking Identity and Access Management Console.

The credentials are set to admin credentials in the deployment.toml files as follows:

<WSO2_OB_IAM_HOME>/repository/conf/deployment.toml
<WSO2_OB_APIM_HOME>/repository/conf/deployment.toml

[open_banking.api_security.global]
username = "$ref{super_admin.username}"
password = "$ref{super_admin.password}"

Versioning for Consent Management APIs

You can define versions for the Consent Management APIs. These versions will be reflected in the self-link for each consent. The default configurations in the deployment.toml files are as follows:

<WSO2_OB_IAM_HOME>/repository/conf/deployment.toml
<WSO2_OB_APIM_HOME>/repository/conf/deployment.toml

[open_banking.uk]
payment_api_url = "https://<WSO2_OB_IAM_HOST>:8243/open-banking/{version}/pisp/"
account_api_url = "https://<WSO2_OB_IAM_HOST>:8243/open-banking/{version}/aisp/"
funds_confirmation_api_url = "https://<WSO2_OB_IAM_HOST>:8243/open-banking/{version}/cbpii/"

For example, if you want to configure the version as v1 , update these configurations as shown below:

payment_api_url = "https://localhost:8243/open-banking/v1/pisp/"
account_api_url = "https://localhost:8243/open-banking/v1/aisp/"
funds_confirmation_api_url = "https://localhost:8243/open-banking/v1/cbpii/"

Enable logs for Consent Management APIs

You can log the Consent Management API calls in JSON format to a separate file. A sample log file is available here.

Open the <WSO2_OB_IAM_HOME>/repository/conf/deployment.toml file.

Add the given configurations to the file:

[open_banking.log_consent_information]
enable = true

Restart the server.
Now the log entries will be saved into the <WSO2_OB_IAM_HOME>/repository/logs/transaction.log file in JSON format.