This is available only as a WUM update and is effective from July 2, 2019 (07-02-2019). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
Before you begin:
Deploy the Dynamic Client Registration v3.2 API.
According to the OBIE, the Account Servicing Payment Service Providers (ASPSPs) need to make sure that the TPPs can be registered in a seamless and ideally, a fully automated process. In order to avoid any obstacles that may occur, the OBIE requires the ASPSPs to provide the TPP responses real-time once the registration is processed. The Dynamic Client Registration (DCR) endpoint is capable of dynamically registering the clients with the ASPSP when the client sends a registration request with its metadata. This results in a registration response that includes a client identifier and the client metadata values registered for the client.
You can find the REST API documentation for Dynamic Client Registration v3.2 here.
This document explains how to utilize Dynamic Client Registration with WSO2 Open Banking.
Before you begin
Configuring dynamic client registration
Follow the steps below to configure DCR API v3.2 in WSO2 Open Banking.
Uploading certificate to the client trust store
The ASPSP can upload the OB root and issuer certificates found in the below mentioned locations to the client trust store of both WSO2 API Manager
(WSO2 OB APIM) and Key Manager
(WSO2 OB KM).
In sandbox environment, upload certificates from https://openbanking.atlassian.net/wiki/spaces/DZ/pages/252018873/OB+Root+and+Issuing+Certificates+for+Sandbox
In production environment, upload certificates from https://openbanking.atlassian.net/wiki/spaces/DZ/pages/80544075/OB+Root+and+Issuing+Certificates+for+Production
The client trust stores are located in the WSO2 OB APIM and WSO2 OB KM servers in the following locations respectively:
Use the following commands to add the certificate to the client trust store:
<UseSoftwareIdAsApplicationName> property under the
<DCR> tag and set it to true.
Setting this property to true ensures that the
SoftwareId in Software Statement Assertion is used as the application name.
To store any properties retrieved from the SSA, add the server-level configuration to the
<OB_APIM_HOME>/repository/conf/api-manager.xml file as explained here . Ideally, place the following ApplicationConfiguration at the end of the file within the APIManager element.
For example, if you want to store
software_client_id retrieved from the SSA created in the sandbox environment, the property name should look like:
software_client_id_sandbox. Similarly, to store the
software_client_id retrieved from the SSA created in a production environment, the property name should be:
software_client_id_production. Make sure you add these properties as false, as required.
In addition to these, include
software_jwks_endpoint in the SSA. This is required to obtain an access token for the application.
This is available only as a WUM update and is effective from November 13, 2019 (11-13-2019). For more information on updating WSO2 Open Banking, see Updating WSO2 Products.
To enable viewing both softwareClientName and softwareClientID in the API Store when
UseSoftwareIdAsApplicationNameis enabled, add the following configurations to the
<WSO2_OB_APIM_HOME>/repository/conf/api-manager.xmlfile under <
ApplicationConfiguration>within the <
To resolve the string mapping of the new column, add "ID": "ID" key-value pair in the following files:
Once you follow the above instructions, notice the additional column Name under the Applications tab of the API Store, which displays
Configuring application deletion workflow
This feature is available as a product update from September 4, 2019 (09-04-2019) onwards.
- Sign in to the API Manager Management Console at
- On the Main tab, click Resources > Browse.
- Locate the
workflow-extensions.xmlto edit the file.
Under the Content section, click Edit as text.
Update the A
pplicationDeletion executorvalue as follows:
- Click Save Content.
Registering an application
To get the public transport and signing certificates, enrol the TPP in the Open Banking Directory and upload the Certificate Signing Request (CSR).
The API allows the TPP to request the ASPSP to register a new client. The process is as follows:
The TPP sends a registration request,
This is a POST request including an SSA (Software Statement Assertion) as a claim in the payload.
The SSA is sent as a signed JWT, which is obtained from the Open Banking Directory. This contains the client metadata.
The software statement (SSA) should be obtained from the Open Banking Directory by the TPP. The SSA is a signed JWT issued by the Open Banking directory.
The automated DCR process is carried out by calling a synapse API in the gateway. The registration request relies on Mutual TLS authentication for TPP authentication.
An example request sent to the DCR registration endpoint is shown below:
Given below is the format of the payload JWT. To sign it, use the signing certificate issued by the Open Banking Directory. The
kidparameter of the header should match the values in the
kidof the signing certificate provided by the Open Banking Directory.
Include the following claims in the body of the request payload;
Claim Description Source Specification Optional Comments iss Request issuer (the TPP) [RFC7519] NO iat Time of issuance of the request [RFC7519] NO exp Request expiration time [RFC7519] NO aud Request audience (the ASPSP) [RFC7519] NO jti The JWT ID [RFC7519] NO redirect_uris Registered URIs the TPP uses to interact with the ASPSP AS [OIDC-R] NO Must match or be a subset of the software_redirect_uris claim in the SSA. token_endpoint_auth_method Specifies which token endpoint authentication method the TPP wants to use [RFC7591] NO private_key_jwt: If requested, the OP should extract the TPPs JWKS location from the included software statement assertion. grant_types A JSON array specifying what the TPP can request to be supplied to the token endpoint as an exchange for an access token [RFC7591] NO response_types A JSON array specifying what the TPP can request to be returned from the ASPSP authorization endpoint [RFC7591] YES ASPSPs may reject anything other than code. software_id The application name that is mentioned as
software_client_idin the SSA.
[RFC7591] YES If specified, the software_id in the request must match the software_id specified in the SSA. ASPSPs can choose to allow multiple registrations for a given software client name and may take the software_id from either the SSA or the TPP as a hint. scope The scopes requested by the client (if not specified, default scopes are assigned by the AS) [RFC7591] YES
The minimum scope should be openid + whatever scopes are appropriate for the PSD2 role of the software.
The scopes are space delimited values.
software_statement The SSA issued by Open Banking identifier [RFC7519] NO application_type Specifies whether the application type is web or mobile [OIDC-R] NO Must be web, if specified. id_token_signed_response_alg The algorithm with which the TPP expects to sign the id_token if an id_token is returned [OIDC-R] NO Supported values must comply with [FAPI-RW] Section 8.6. request_object_signing_alg The algorithm with which the TPP expects to sign the request object if a request object is part of the authorization request sent to the ASPSP. [OIDC-R] NO Supported values must comply with [FAPI-RW] Section 8.6.
- The ASPSP validates the SSA based on the specifications provided in the Open Banking OpenID Dynamic Client (OIDC) Registration specification.
The ASPSP registers the client application using the metadata sent in the SSA.
If client creation is successful, the ASPSP responds with a JSON payload that describes the client that was created. The TPP can then use the client to access resources on the ASPSP's resource server.
If client creation is unsuccessful, the ASPSP responds with an error payload.
A sample response is given below:
Retrieving an application
The API allows the TPP to retrieve the details for a client that has already been registered. The request relies on Mutual TLS authentication and application access token ( Client Credentials grant type) for TPP authentication.
This consists of one path parameter named
ClientId that the TPP wants to retrieve details for.
- If the request is successful and the identifier (
ClientId) matches the client to whom the Client Credentials grant access token was issued, the ASPSP returns details of the requested client
- If the
ClientIdis unknown, the ASPSP responds with an
Unauthorizedstatus code and immediately revokes the access token
Given below is a sample request sent to the retrieving endpoint:
Updating an application
The API allows the TPP to request the ASPSP to modify one or more attributes related to an existing client. The request relies on Mutual TLS authentication and application access token (Client Credentials grant type) for TPP authentication. The TPP submits
ClientId as a path parameter and a JWS payload that describes the characteristics of the client to be modified. This must include all the claims, including the ones that will not be modified.
- If the client is successfully modified, the ASPSP responds with a JSON payload that describes the client that was created.
ClientIdis unknown, the ASPSP responds with an
Unauthorizedstatus code and immediately revokes the access token.
If client modification is unsuccessful, the ASPSP responds with an error payload.
Deleting an application
The API allows the TPP to request the ASPSP to delete an existing client. The request relies on Mutual TLS authentication and application access token (Client Credentials grant type) for TPP authentication. The request consists of one path parameter namely
ClientId of the TPP which should be deleted.
- If the request is successful and the
ClientIdmatches the client to whom the Client Credentials grant access token was issued, the ASPSP must delete the client and invalidate long lived access tokens that were issued to the client
- If the ClientId is unknown, the ASPSP responds with an Unauthorized status code and immediately revokes the access token
You can find a sample request sent to the retrieving endpoint below.
If the deletion is successful you will get a
204 No Content response.