API Explorer

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

provider: ETHEREUM

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

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":"1100-01-01T00:00:00Z"
}

Request Headers:

Response Headers:

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-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.1.0, function_name: by getConsumer, operation_id: OBPv5.1.0-getConsumer Tags: Consumer,

Get Consumers

Get the all Consumers.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Possible custom url parameters for pagination:

limit=NUMBER ==> default value: 50
offset=NUMBER ==> default value: 0

eg1:?limit=100&offset=0

sort_direction=ASC/DESC ==> default value: DESC.

eg2:?limit=100&offset=0&sort_direction=ASC

from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
to_date=DATE => example value: 2025-01-23T21:41:56.792Z. NOTE! The default value is now (2025-01-23T21:41:56.792Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

JSON response body fields:

app_name: appNameBank

certificate_pem: certificate_pem

company: Tesobe GmbH

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

consumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq

consumers:

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

issuer_domain_name: issuer_domain_name

not_after: not_after

not_before: not_before

provider: ETHEREUM

redirect_url: https://apisandbox.openbankproject.com

subject_domain_name: subject_domain_name

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

certificate_info: certificate_info

logo_url: logo_url

roles: CanCreateMyUser

roles_info: roles_info

Typical Successful Response:

								
									{
  "consumers":[{
    "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq",
    "app_name":"appNameBank",
    "app_type":"Web",
    "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
    "developer_email":"felixsmith@example.com",
    "company":"Tesobe GmbH",
    "redirect_url":"https://apisandbox.openbankproject.com",
    "certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n",
    "certificate_info":{
      "subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE",
      "issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE",
      "not_before":"2022-04-01T10:13:00.000Z",
      "not_after":"2032-04-01T10:13:00.000Z",
      "roles_info":"PEM Encoded Certificate does not contain PSD2 roles."
    },
    "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":"1100-01-01T00:00:00Z",
    "logo_url":"https://apisandbox.openbankproject.com/logo"
  }]
}

Request Headers:

Response Headers:

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: OBPv5.1.0, function_name: by getConsumers, operation_id: OBPv5.1.0-getConsumers Tags: Consumer,

Get Consumers (logged in User)

Get the Consumers for logged in User.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

JSON response body fields:

app_name: appNameBank

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

consumers:

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

provider: ETHEREUM

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

Typical Successful Response:

								
									{
  "consumers":[{
    "consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec",
    "app_name":"SOFI",
    "app_type":"Web",
    "description":"Account Management",
    "developer_email":"felixsmith@example.com",
    "redirect_url":"www.openbankproject.com",
    "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":"1100-01-01T00:00:00Z"
  }]
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by getConsumersForCurrentUser, operation_id: OBPv3.1.0-getConsumersForCurrentUser Tags: Consumer,

Set Rate Limits / Call Limits per Consumer

Set the API rate limits / call limits for a Consumer:

Rate limiting can be set:

Per Second
Per Minute
Per Hour
Per Week
Per Month

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

from_date: 1100-01-01T01:01:01.000Z

per_day_call_limit:

per_hour_call_limit:

per_minute_call_limit:

per_month_call_limit:

per_second_call_limit: 10

per_week_call_limit:

to_date: 1100-01-01T01:01:01.000Z

api_name: api_name

api_version:

bank_id: gh.29.uk

Typical Successful Response:

								
									{
  "from_date":"1100-01-01T00:00:00Z",
  "to_date":"1100-01-01T00:00:00Z",
  "per_second_call_limit":"-1",
  "per_minute_call_limit":"-1",
  "per_hour_call_limit":"-1",
  "per_day_call_limit":"-1",
  "per_week_call_limit":"-1",
  "per_month_call_limit":"-1"
}

Request Headers:

Response Headers:

Required Roles:

CanSetCallLimits - 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-10001: Incorrect json format.
OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.
OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.
OBP-20006: User is missing one or more roles:
OBP-30023: Cannot update Consumer
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by callsLimit, operation_id: OBPv4.0.0-callsLimit Tags: Consumer, Rate-Limits,

Update Consumer LogoURL

Update an existing logoURL for a Consumer specified by CONSUMER_ID.

Please note: Your consumer may be disabled as a result of this action.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

certificate_pem: certificate_pem

company: Tesobe GmbH

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

consumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

issuer_domain_name: issuer_domain_name

not_after: not_after

not_before: not_before

provider: ETHEREUM

redirect_url: https://apisandbox.openbankproject.com

subject_domain_name: subject_domain_name

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

certificate_info: certificate_info

logo_url: logo_url

roles: CanCreateMyUser

roles_info: roles_info

Typical Successful Response:

								
									{
  "consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq",
  "app_name":"appNameBank",
  "app_type":"Web",
  "description":"Description of the object. Maximum length is 2000. It can be any characters here.",
  "developer_email":"felixsmith@example.com",
  "company":"Tesobe GmbH",
  "redirect_url":"https://apisandbox.openbankproject.com",
  "certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n",
  "certificate_info":{
    "subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE",
    "issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE",
    "not_before":"2022-04-01T10:13:00.000Z",
    "not_after":"2032-04-01T10:13:00.000Z",
    "roles_info":"PEM Encoded Certificate does not contain PSD2 roles."
  },
  "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":"1100-01-01T00:00:00Z",
  "logo_url":"https://apisandbox.openbankproject.com/logo"
}

Request Headers:

Response Headers:

Required Roles:

CanUpdateConsumerLogoUrl - 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: OBPv5.1.0, function_name: by updateConsumerLogoURL, operation_id: OBPv5.1.0-updateConsumerLogoURL Tags: Consumer,

Update Consumer RedirectURL

Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.

Please note: Your consumer may be disabled as a result of this action.

CONSUMER_ID can be obtained after you register the application.

Or use the endpoint 'Get Consumers' to get it

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

app_name: appNameBank

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

provider: ETHEREUM

redirect_url: https://apisandbox.openbankproject.com

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

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":"1100-01-01T00:00:00Z"
}

Request Headers:

Response Headers:

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: OBPv5.1.0, function_name: by updateConsumerRedirectUrl, operation_id: OBPv5.1.0-updateConsumerRedirectUrl Tags: Consumer,

Create a Consumer(Dynamic Registration)

Create a Consumer (mTLS access).

JWT payload:
- minimal
{ "description":"Description" }
- full
{
"description": "Description",
"app_name": "Tesobe GmbH",
"app_type": "Sofit",
"developer_email": "marko@tesobe.com",
"redirect_url": "http://localhost:8082"
}
Please note that JWT must be signed with the counterpart private key of the public key used to establish mTLS

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

JSON request body fields:

jwt:

JSON response body fields:

app_name: appNameBank

certificate_pem: certificate_pem

company: Tesobe GmbH

consumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

consumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq

description: Description of the object. Maximum length is 2000. It can be any characters here.

enabled: false

issuer_domain_name: issuer_domain_name

not_after: not_after

not_before: not_before

provider: ETHEREUM