API Explorer

v2.2.0 (144 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Enable or Disable Consumers

Enable/Disable a Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "enabled":false }
Required Roles:
  • CanEnableConsumers - Please login to request this Role
  • CanDisableConsumers - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by enableDisableConsumers, operation_id: OBPv2.1.0-enableDisableConsumers Tags: Consumer,

Get Consumer

Get the Consumer specified by CONSUMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanGetConsumers - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getConsumer, operation_id: OBPv2.1.0-getConsumer Tags: Consumer,

Get Consumers

Get the all Consumers.

Authentication is Mandatory

JSON response body fields:

Typical Successful Response:

								
									
{ "list":[{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetConsumers - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getConsumers, operation_id: OBPv2.1.0-getConsumers Tags: Consumer,

Post a Consumer

Create a Consumer (Authenticated access).

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "app_name":"Some app name", "app_type":"App type", "description":"Description", "developer_email":"some.email@example.com", "redirect_url":"Some redirect url", "created_by_user_id":"Created by UUID", "enabled":true, "created":"2021-10-10T19:59:37Z", "clientCertificate":"-----BEGIN CERTIFICATE-----\nclient_certificate_content\n-----END CERTIFICATE-----" }
Required Roles:
  • CanCreateConsumer - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.2.0, function_name: by createConsumer, operation_id: OBPv2.2.0-createConsumer Tags: Consumer,

Update Consumer RedirectUrl

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "consumer_id":1213, "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "redirect_url":"www.openbankproject.com", "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "created_by_user":{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith" }, "enabled":true, "created":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanUpdateConsumerRedirectUrl - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by updateConsumerRedirectUrl, operation_id: OBPv2.1.0-updateConsumerRedirectUrl Tags: Consumer,