I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

United Kingdom - Dynamic Client Registration PSD2 API Documentation

Dynamic Client Registration PSD2

Summary

The Dynamic Client Registration API allows a TPP to submit a Software Statement Assertion (SSA) to dynamically register with CPB through a secure interface.

The sandbox provides synthetic data to enable a TPP to explore the API and perform preliminary functional testing on a simulated environment. The calls to the API will be validated for correctness and compliance with the API specification to help the TPP uncover issues early when integrating with the API.

Below are some sample test data and unique identifiers that can be used for invoking the APIs and for recreating specific scenarios for validation and testing by the TPP. Some of the characteristics of the sandbox are listed below:

  • The sandbox implements an OAuth 2.0 based Authentication and Authorization flow. In addition to using the API Playground to invoke the APIs, the API keys retrieved while registering an application can be used for calling the APIs from any REST client, such as curl, Postman, SoapUI, or programmatically through REST calls using access tokens retrieved either through a Client Credential or Authorization Code grant types depending on the API being invoked.
  • As the sandbox is open to both TPPs and the general public, the following validations will be deferred to the integration environments: verification of TPP identity, SSA, EIDAS, QSEAL, QWAC certificates, mutual TLS. These validations will be available in the fully functional market integrated interfaces with valid Competent Authority issued certificates.
  • This API returns a pair of mock client_id and client_secret tokens in response to the request. The fully functional market integrated interfaces will return tokens that will be valid for subsequent API invocation.
  • The /register endpoint is protected by an access token that can be obtained by using the Authorize API.

      The Dynamic Client Registration PSD2 API uses the client_credentials grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
post /open-banking/v3.1/register Create a new client
get /open-banking/v3.1/register/{ClientId} Returns the client details for a given Client ID
put /open-banking/v3.1/register/{ClientId} Modify one or more attributes related to an existing TPP client
delete /open-banking/v3.1/register/{ClientId} Delete an existing TPP client

Create a new client

post /open-banking/v3.1/register
Description

Request CPB to create a new client. For this purpose the TPP submits a JWS payload that describes the characteristics of the client to be created. If client creation is successful then CPB responds with a JSON payload that describes the client that was created. The TPP can then use the client credentials to access resources on the CPB resource server. CPB responds with an error payload if the client creation is unsuccessful.

Header Parameters
Accept
string required
application/json
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
client_id
string required
Client Id generated during app registration.
Body Parameters
requestBody
Optional
A request to register a Software Statement Assertion with an CPB
Show schema
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
201

This operation returns no content.
400

This operation returns no content.

Returns the client details for a given Client ID

get /open-banking/v3.1/register/{ClientId}
Description

Used by the TPP to retrieve the details for a client that is already registered. The request consists of one path parameter - the ClientId - that the TPP wants to retrieve details for. If the request is successful then CPB returns an object of type OBClientRegistrationRequest1. If the ClientId is unknown, the CPB responds with an unauthorized status code and immediately revokes the access token.

Header Parameters
Accept
string required
application/json
client_id
string required
Client Id generated during app registration.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Path Parameters
ClientId
string required
The client ID
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.

Modify one or more attributes related to an existing TPP client

put /open-banking/v3.1/register/{ClientId}
Description

Request CPB to modify one or more attributes related to an existing client. For this purpose the TPP submits the ClientId path parameter and a JWS payload that describes the characteristics of the client to be modified that must include all the claims - including ones that will not be modified. CPB may reject the request if it does not support the changes to certain claims. If client modification is successful then CPB responds with a JSON payload that describes the client that was modified else CPB responds with an error payload. If the ClientId is unknown then CPB responds with an unauthorized status code and immediately revokes the access token.

Header Parameters
Accept
string required
application/json
client_id
string required
Client Id generated during app registration.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Body Parameters
requestBody
Optional
A request to register a Software Statement Assertion with an CPB
Show schema
Path Parameters
ClientId
string required
The client ID
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.

Delete an existing TPP client

delete /open-banking/v3.1/register/{ClientId}
Description

Request CPB to delete an existing client.The request consists of one path parameter - the ClientId - that the TPP wants to delete the client. If the request is successful and the clientId matches with the client-credentials grant access token was issued then CPB must delete the client and invalidate long lived access tokens that were issued to the client. If the ClientId is unknown then CPB responds with an unauthorized status code and immediately revokes the access token.

Header Parameters
Accept
string required
application/json
client_id
string required
Client Id generated during app registration.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Path Parameters
ClientId
string required
The client ID
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
204

Client deleted
This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
405

This operation returns no content.