API Explorer

v5.1.0 (578 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Regulated Entity

Create Regulated Entity

Authentication is Mandatory

JSON request body fields:

certificate_authority_ca_owner_id: certificate_authority_ca_owner_id

entity_address: entity_address

entity_certificate_public_key: entity_certificate_public_key

entity_code: entity_code

entity_country: entity_country

entity_name: entity_name

entity_post_code: entity_post_code

entity_town_city: entity_town_city

entity_type: entity_type

entity_web_site: entity_web_site

services: services

JSON response body fields:

certificate_authority_ca_owner_id: certificate_authority_ca_owner_id

entities: entities

entity_address: entity_address

entity_certificate_public_key: entity_certificate_public_key

entity_code: entity_code

entity_country: entity_country

entity_id: entity_id

entity_name: entity_name

entity_post_code: entity_post_code

entity_town_city: entity_town_city

entity_type: entity_type

entity_web_site: entity_web_site

services: services

Typical Successful Response:

								
									
{ "entities":[{ "entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca", "certificate_authority_ca_owner_id":"CY_CBC", "entity_certificate_public_key":"-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----", "entity_name":"EXAMPLE COMPANY LTD", "entity_code":"PSD_PICY_CBC!12345", "entity_type":"PSD_PI", "entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET", "entity_town_city":"SOME CITY", "entity_post_code":"1060", "entity_country":"CY", "entity_web_site":"www.example.com", "services":[{ "CY":["PS_010","PS_020","PS_03C","PS_04C"] }] }] }
Required Roles:
  • CanCreateRegulatedEntity - 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: OBPv5.1.0, function_name: by createRegulatedEntity, operation_id: OBPv5.1.0-createRegulatedEntity Tags: Directory, API,

Create a Consumer

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 kew of the public key used to establish mTLS

Authentication is Optional

JSON request body fields:

jwt:

JSON response body fields:

app_name:

app_type:

certificate_pem: certificate_pem

company: Tesobe GmbH

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

consumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq

consumer_secret: xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic

created:

created_by_user:

description: This an optional field. Maximum length is 2000. It can be any characters here.

developer_email:

email: felixsmith@example.com

enabled: true

issuer_domain_name: issuer_domain_name

not_after: not_after

not_before: not_before

provider: ETHEREUM

provider_id:

redirect_url:

subject_domain_name: subject_domain_name

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

username: felixsmith

certificate_info: certificate_info

roles: CanCreateMyUser

roles_info: roles_info

Typical Successful Response:

								
									
{ "consumer_id":"d0d7b08c-f0ec-4e57-ac99-7d9eafe99225", "consumer_key":"d0d7b08c-f0ec-4e57-ac99-7d9eafe99225", "consumer_secret":"d0d7b08c-f0ec-4e57-ac99-7d9eafe99225", "app_name":"SOFI", "app_type":"Web", "description":"Account Management", "developer_email":"felixsmith@example.com", "company":"Tesobe GmbH", "redirect_url":"www.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" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by createConsumer, operation_id: OBPv5.1.0-createConsumer Tags: Directory, Consumer,

Delete Regulated Entity

Delete Regulated Entity specified by REGULATED_ENTITY_ID

Authentication is Mandatory

URL Parameters:

REGULATED_ENTITY_ID: REGULATED_ENTITY_ID

JSON response body fields:

Typical Successful Response:

								
									
Required Roles:
  • CanDeleteRegulatedEntity - 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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by deleteRegulatedEntity, operation_id: OBPv5.1.0-deleteRegulatedEntity Tags: Directory, API,

Get Regulated Entities

Returns information about:

  • Regulated Entities

Authentication is Optional

JSON response body fields:

certificate_authority_ca_owner_id: certificate_authority_ca_owner_id

entities: entities

entity_address: entity_address

entity_certificate_public_key: entity_certificate_public_key

entity_code: entity_code

entity_country: entity_country

entity_id: entity_id

entity_name: entity_name

entity_post_code: entity_post_code

entity_town_city: entity_town_city

entity_type: entity_type

entity_web_site: entity_web_site

services: services

Typical Successful Response:

								
									
{ "entities":[{ "entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca", "certificate_authority_ca_owner_id":"CY_CBC", "entity_certificate_public_key":"-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----", "entity_name":"EXAMPLE COMPANY LTD", "entity_code":"PSD_PICY_CBC!12345", "entity_type":"PSD_PI", "entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET", "entity_town_city":"SOME CITY", "entity_post_code":"1060", "entity_country":"CY", "entity_web_site":"www.example.com", "services":[{ "CY":["PS_010","PS_020","PS_03C","PS_04C"] }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by regulatedEntities, operation_id: OBPv5.1.0-regulatedEntities Tags: Directory, API,

Get Regulated Entity

Get Regulated Entity By REGULATED_ENTITY_ID

Authentication is Optional

URL Parameters:

REGULATED_ENTITY_ID: REGULATED_ENTITY_ID

JSON response body fields:

certificate_authority_ca_owner_id: certificate_authority_ca_owner_id

entities: entities

entity_address: entity_address

entity_certificate_public_key: entity_certificate_public_key

entity_code: entity_code

entity_country: entity_country

entity_id: entity_id

entity_name: entity_name

entity_post_code: entity_post_code

entity_town_city: entity_town_city

entity_type: entity_type

entity_web_site: entity_web_site

services: services

Typical Successful Response:

								
									
{ "entities":[{ "entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca", "certificate_authority_ca_owner_id":"CY_CBC", "entity_certificate_public_key":"-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----", "entity_name":"EXAMPLE COMPANY LTD", "entity_code":"PSD_PICY_CBC!12345", "entity_type":"PSD_PI", "entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET", "entity_town_city":"SOME CITY", "entity_post_code":"1060", "entity_country":"CY", "entity_web_site":"www.example.com", "services":[{ "CY":["PS_010","PS_020","PS_03C","PS_04C"] }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getRegulatedEntityById, operation_id: OBPv5.1.0-getRegulatedEntityById Tags: Directory, API,