-
Directory
- Create Regulated Entity
- Create Regulated Entity Attribute
- Create a Consumer(Dynamic Registration)
- Delete Regulated Entity
- Delete Regulated Entity Attribute
- Get All Regulated Entity Attributes
- Get Regulated Entities
- Get Regulated Entity
- Get Regulated Entity Attribute By ID
- Update Regulated Entity Attribute
-
Directory
-
Create Regulated Entity
-
Create Regulated Entity Attribute
-
Create a Consumer(Dynamic Registration)
-
Delete Regulated Entity
-
Delete Regulated Entity Attribute
-
Get All Regulated Entity Attributes
-
Get Regulated Entities
-
Get Regulated Entity
-
Get Regulated Entity Attribute By ID
-
Update Regulated Entity Attribute
-
Create Regulated Entity
v5.1.0 filtered by tag: Directory (10 APIs)
Create Regulated Entity
Create Regulated Entity
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields:
attributeType: attributeType
certificate_authority_ca_owner_id: CY_CBC
entity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
entity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
entity_code: PSD_PICY_CBC!12345
entity_country: CY
entity_name: EXAMPLE COMPANY LTD
entity_post_code: 1060
entity_town_city: SOME CITY
entity_type: PSD_PI
entity_web_site: www.example.com
name: ACCOUNT_MANAGEMENT_FEE
services: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
value: 5987953
attributes: attribute value in form of (name, value)
JSON response body fields:
attributeType: attributeType
certificate_authority_ca_owner_id: CY_CBC
entity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
entity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
entity_code: PSD_PICY_CBC!12345
entity_country: CY
entity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
entity_name: EXAMPLE COMPANY LTD
entity_post_code: 1060
entity_town_city: SOME CITY
entity_type: PSD_PI
entity_web_site: www.example.com
name: ACCOUNT_MANAGEMENT_FEE
services: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
value: 5987953
attributes: attribute value in form of (name, value)
{
"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"certificate_authority_ca_owner_id":"CY_CBC",
"entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==",
"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"]
}],
"attributes":[{
"attributeType":"STRING",
"name":"STATUS",
"value":"closed"
}]
}
-
CanCreateRegulatedEntity
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Create Regulated Entity Attribute
Create a new Regulated Entity Attribute for a given REGULATED_ENTITY_ID.
The type field must be one of "STRING", "INTEGER", "DOUBLE" or "DATE_WITH_DAY".
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON request body fields:
attribute_type: STRING
name: ACCOUNT_MANAGEMENT_FEE
value: 5987953
is_active: false
JSON response body fields:
attribute_type: STRING
name: ACCOUNT_MANAGEMENT_FEE
regulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
regulated_entity_id: regulated_entity_id
value: 5987953
is_active: false
{
"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51",
"name":"ACCOUNT_MANAGEMENT_FEE",
"attribute_type":"",
"value":"5987953",
"is_active":false
}
-
CanCreateRegulatedEntityAttribute
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
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: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
JSON response body fields:
app_name: appNameBank
app_type: Web
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
{
"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"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete Regulated Entity
Delete Regulated Entity specified by REGULATED_ENTITY_ID
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
-
CanDeleteRegulatedEntity
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
Delete Regulated Entity Attribute
Delete a Regulated Entity Attribute specified by REGULATED_ENTITY_ATTRIBUTE_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
-
CanDeleteRegulatedEntityAttribute
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get All Regulated Entity Attributes
Get all attributes for the specified Regulated Entity.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
attribute_type: STRING
attributes: attribute value in form of (name, value)
name: ACCOUNT_MANAGEMENT_FEE
regulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
regulated_entity_id: regulated_entity_id
value: 5987953
is_active: false
{
"attributes":[{
"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51",
"name":"ACCOUNT_MANAGEMENT_FEE",
"attribute_type":"",
"value":"5987953",
"is_active":false
}]
}
-
CanGetRegulatedEntityAttributes
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Regulated Entities
Returns information about:
- Regulated Entities
User Authentication is Optional. The User need not be logged in.
JSON response body fields:
attributeType: attributeType
certificate_authority_ca_owner_id: CY_CBC
entities: entities
entity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
entity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
entity_code: PSD_PICY_CBC!12345
entity_country: CY
entity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
entity_name: EXAMPLE COMPANY LTD
entity_post_code: 1060
entity_town_city: SOME CITY
entity_type: PSD_PI
entity_web_site: www.example.com
name: ACCOUNT_MANAGEMENT_FEE
services: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
value: 5987953
attributes: attribute value in form of (name, value)
{
"entities":[{
"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"certificate_authority_ca_owner_id":"CY_CBC",
"entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==",
"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"]
}],
"attributes":[{
"attributeType":"STRING",
"name":"STATUS",
"value":"closed"
}]
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Regulated Entity
Get Regulated Entity By REGULATED_ENTITY_ID
User Authentication is Optional. The User need not be logged in.
URL Parameters:
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
attributeType: attributeType
certificate_authority_ca_owner_id: CY_CBC
entity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
entity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
entity_code: PSD_PICY_CBC!12345
entity_country: CY
entity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
entity_name: EXAMPLE COMPANY LTD
entity_post_code: 1060
entity_town_city: SOME CITY
entity_type: PSD_PI
entity_web_site: www.example.com
name: ACCOUNT_MANAGEMENT_FEE
services: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
value: 5987953
attributes: attribute value in form of (name, value)
{
"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"certificate_authority_ca_owner_id":"CY_CBC",
"entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==",
"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"]
}],
"attributes":[{
"attributeType":"STRING",
"name":"STATUS",
"value":"closed"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Regulated Entity Attribute By ID
Get a specific Regulated Entity Attribute by its REGULATED_ENTITY_ATTRIBUTE_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
attribute_type: STRING
name: ACCOUNT_MANAGEMENT_FEE
regulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
regulated_entity_id: regulated_entity_id
value: 5987953
is_active: false
{
"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51",
"name":"ACCOUNT_MANAGEMENT_FEE",
"attribute_type":"",
"value":"5987953",
"is_active":false
}
-
CanGetRegulatedEntityAttribute
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update Regulated Entity Attribute
Update an existing Regulated Entity Attribute specified by ATTRIBUTE_ID.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
REGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
REGULATED_ENTITY_ID: REGULATED_ENTITY_ID
JSON response body fields:
attribute_type: STRING
name: ACCOUNT_MANAGEMENT_FEE
regulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
regulated_entity_id: regulated_entity_id
value: 5987953
is_active: false
{
"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca",
"regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51",
"name":"ACCOUNT_MANAGEMENT_FEE",
"attribute_type":"",
"value":"5987953",
"is_active":false
}
-
CanUpdateRegulatedEntityAttribute
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles: