{"swagger":"2.0","info":{"title":"Open Bank Project API","description":"An Open Source API for Banks. (c) TESOBE GmbH. 2011 - 2026. Licensed under the AGPL and commercial licences.","contact":{"name":"TESOBE GmbH. / Open Bank Project","url":"https://openbankproject.com","email":"contact@tesobe.com"},"version":"v5.1.0"},"host":"apisandbox.openbankproject.com","basePath":"/","schemes":["http","https"],"securityDefinitions":{"directLogin":{"type":"apiKey","description":"Direct Login authentication. POST to /obp/v6.0.0/my/logins/direct with header 'DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY' to obtain a token. Then use header 'DirectLogin: token=YOUR_TOKEN' on subsequent requests. See the OpenAPI 3.1 spec for full details.","in":"header","name":"DirectLogin"},"gatewayLogin":{"type":"apiKey","description":"Gateway Login authentication. The gateway sends a JWT in the Authorization header signed with a pre-shared secret. See the OpenAPI 3.1 spec for full details.","in":"header","name":"Authorization"}},"security":[{"directLogin":[],"gatewayLogin":[]}],"paths":{"/obp/v1.3.0/banks/{BANK_ID}/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Bank Level Dynamic Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.</p><p>This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.</p><p>This endpoint is used by OBP API Explorer to display and work with the API documentation.</p><p>Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)</p><p>API_VERSION is the version you want documentation about e.g. v3.0.0</p><p>You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank</p><p>You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics</p><p>For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.</p><p>You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic<br />if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.</p><p>You may need some other language resource docs, now we support en_GB and es_ES at the moment.</p><p>You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.</p><p>See the Resource Doc endpoint for more information.</p><p>Note: Dynamic Resource Docs are cached, TTL is 3600 seconds<br />Static Resource Docs are cached, TTL is 3600 seconds</p><p>Following are more examples:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221</a></p><ul><li> operation_id is concatenation of \"v\", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code) </li><li> version references the version that the API call is defined in.</li><li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li><li> request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource</li><li> specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.</li><li> summary is a short description inline with the swagger terminology. </li><li> description may contain html markup (generated from markdown on the server).</li></ul><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#api_version\">API_VERSION</a>:</p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/obp":{"get":{"tags":["Documentation","API"],"summary":"Get Resource Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.</p><p>This is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.</p><p>This endpoint is used by OBP API Explorer to display and work with the API documentation.</p><p>Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)</p><p>API_VERSION is the version you want documentation about e.g. v3.0.0</p><p>You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank</p><p>You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics</p><p>For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.</p><p>You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic<br />if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.</p><p>You may need some other language resource docs, now we support en_GB and es_ES at the moment.</p><p>You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.</p><p>See the Resource Doc endpoint for more information.</p><p>Note: Dynamic Resource Docs are cached, TTL is 3600 seconds<br />Static Resource Docs are cached, TTL is 3600 seconds</p><p>Following are more examples:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221</a></p><ul><li> operation_id is concatenation of \"v\", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code) </li><li> version references the version that the API call is defined in.</li><li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li><li> request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource</li><li> specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.</li><li> summary is a short description inline with the swagger terminology. </li><li> description may contain html markup (generated from markdown on the server).</li></ul><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#api_version\">API_VERSION</a>:</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv1.4.0-getResourceDocsObpV400","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/openapi":{"get":{"tags":["Documentation","API"],"summary":"Get OpenAPI 3.1 documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns documentation about the RESTful resources on this server in OpenAPI 3.1 format.</p><p>API_VERSION is the version you want documentation about e.g. v6.0.0</p><h2><a href=\"#query-parameters\" id=\"query-parameters\">Query Parameters</a></h2><p>You may filter this endpoint using the following optional query parameters:</p><p><strong>tags</strong> - Filter by endpoint tags (comma-separated list)<br />• Example: ?tags=Account,Bank or ?tags=Account-Firehose<br />• All endpoints are given one or more tags which are used for grouping<br />• Empty values will return error OBP-10053</p><p><strong>functions</strong> - Filter by function names (comma-separated list)<br />• Example: ?functions=getBanks,bankById<br />• Each endpoint is implemented in the OBP Scala code by a 'function'<br />• Empty values will return error OBP-10054</p><p><strong>content</strong> - Filter by endpoint type<br />• Values: static, dynamic, all (case-insensitive)<br />• static: Only show static/core API endpoints<br />• dynamic: Only show dynamic/custom endpoints<br />• all: Show both static and dynamic endpoints (default)<br />• Invalid values will return error OBP-10052</p><p><strong>locale</strong> - Language for localized documentation<br />• Example: ?locale=en_GB or ?locale=es_ES<br />• Supported locales: en_GB, es_ES, ro_RO<br />• Invalid locales will return error OBP-10041</p><p><strong>api-collection-id</strong> - Filter by API collection UUID<br />• Example: ?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221<br />• Returns only endpoints belonging to the specified collection<br />• Empty values will return error OBP-10055</p><p>This endpoint generates OpenAPI 3.1 compliant documentation with modern JSON Schema support.</p><p>For YAML format, use the corresponding endpoint: /resource-docs/API_VERSION/openapi.yaml</p><p>See the Resource Doc endpoint for more information.</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><h2><a href=\"#examples\" id=\"examples\">Examples</a></h2><p>Basic usage:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi</a></p><p>Filter by tags:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account-Firehose</a></p><p>Filter by content type:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=dynamic</a></p><p>Filter by functions:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?functions=getBanks,bankById</a></p><p>Combine multiple parameters:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&amp;tags=Account-Firehose\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&amp;tags=Account-Firehose</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&amp;functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?tags=Account,Bank,PSD2&amp;functions=getBanks,bankById</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&amp;locale=en_GB&amp;tags=Account\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?content=static&amp;locale=en_GB&amp;tags=Account</a></p><p>Filter by API collection:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\">https://apisandbox.openbankproject.com/obp/v6.0.0/resource-docs/v6.0.0/openapi?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221</a></p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#api_version\">API_VERSION</a>:</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv1.4.0-getResourceDocsOpenAPI31","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidApiVersionString"}}}}},"/obp/v1.3.0/resource-docs/{API_VERSION}/swagger":{"get":{"tags":["Documentation","API"],"summary":"Get Swagger documentation","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns documentation about the RESTful resources on this server in Swagger format.</p><p>API_VERSION is the version you want documentation about e.g. v3.0.0</p><p>You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank</p><p>(All endpoints are given one or more tags which for used in grouping)</p><p>You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById</p><p>(Each endpoint is implemented in the OBP Scala code by a 'function')</p><p>See the Resource Doc endpoint for more information.</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><p>Following are more examples:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger\">https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\">https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&amp;functions=getBanks,bankById\">https://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&amp;functions=getBanks,bankById</a></p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#api_version\">API_VERSION</a>:</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv1.4.0-getResourceDocsSwagger","parameters":[{"in":"path","name":"API_VERSION","description":"eg:v2.2.0, v3.0.0","required":true,"type":"string"}],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/adapter":{"get":{"tags":["API"],"summary":"Get Adapter Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get basic information about the Adapter.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>backend_messages</strong></a>: backend_messages</p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#errorCode\"><strong>errorCode</strong></a>: errorCode</p><p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>source</strong></a>:</p><p><a href=\"/glossary#status\"><strong>status</strong></a>:</p><p><a href=\"/glossary#text\"><strong>text</strong></a>:</p><p><a href=\"/glossary#\"><strong>total_duration</strong></a>: total_duration</p><p><a href=\"/glossary#version\"><strong>version</strong></a>:</p><p><a href=\"/glossary#duration\">duration</a>: 5.123</p>","operationId":"OBPv5.0.0-getAdapterInfo","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AdapterInfoJsonV500"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/api/versions":{"get":{"tags":["Documentation","API"],"summary":"Get scanned API Versions","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get all the scanned API Versions.</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv4.0.0-getScannedApiVersions","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["scanned_api_versions"],"properties":{"scanned_api_versions":{"type":"array","items":{"type":"object","properties":{"urlPrefix":{"type":"string","example":"obp"},"apiStandard":{"type":"string","example":"obp"},"apiShortVersion":{"type":"string","example":"v3.1.0"},"API_VERSION":{"type":"string","example":"v3.1.0"}},"required":["urlPrefix","apiStandard","apiShortVersion","API_VERSION"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/banks/{BANK_ID}/adapter":{"get":{"tags":["API"],"summary":"Get Adapter Info for a bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get basic information about the Adapter listening on behalf of this bank.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>","operationId":"OBPv3.0.0-getAdapterInfoForBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AdapterInfoJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/certs":{"get":{"tags":["API","Account Information Service (AIS)","PSD2"],"summary":"Get JSON Web Key (JWK)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the server's public JSON Web Key (JWK) set and certificate chain.<br />It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#e\"><strong>e</strong></a>:</p><p><a href=\"/glossary#kid\"><strong>kid</strong></a>:</p><p><a href=\"/glossary#kty\"><strong>kty</strong></a>:</p><p><a href=\"/glossary#n\"><strong>n</strong></a>:</p><p><a href=\"/glossary#use\"><strong>use</strong></a>:</p>","operationId":"OBPv3.1.0-getServerJWK","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SeverJWK"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/config":{"get":{"tags":["API"],"summary":"Get API Configuration","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns information about:</p><ul><li>The default bank_id</li><li>Akka configuration</li><li>Elastic Search configuration</li><li>Cached functions</li></ul><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#akka\"><strong>akka</strong></a>:</p><p><a href=\"/glossary#cache\"><strong>cache</strong></a>:</p><p><a href=\"/glossary#elastic_search\"><strong>elastic_search</strong></a>:</p><p><a href=\"/glossary#function_name\"><strong>function_name</strong></a>:</p><p><a href=\"/glossary#log_level\"><strong>log_level</strong></a>:</p><p><a href=\"/glossary#metrics\"><strong>metrics</strong></a>:</p><p><a href=\"/glossary#ports\"><strong>ports</strong></a>:</p><p><a href=\"/glossary#property\"><strong>property</strong></a>:</p><p><a href=\"/glossary#require_scopes_for_all_roles\"><strong>require_scopes_for_all_roles</strong></a>:</p><p><a href=\"/glossary#require_scopes_for_listed_roles\"><strong>require_scopes_for_listed_roles</strong></a>: false</p><p><a href=\"/glossary#scopes\"><strong>scopes</strong></a>:</p><p><a href=\"/glossary#ttl_in_seconds\"><strong>ttl_in_seconds</strong></a>:</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#warehouse\"><strong>warehouse</strong></a>:</p><p><a href=\"/glossary#\">remote_data_secret_matched</a>: remote_data_secret_matched</p>","operationId":"OBPv3.1.0-config","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConfigurationJSON"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/connector/loopback":{"get":{"tags":["API","OAuth","OIDC"],"summary":"Get Connector Status (Loopback)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>This endpoint makes a call to the Connector to check the backend transport is reachable. (Deprecated)</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#connector_version\"><strong>connector_version</strong></a>:</p><p><a href=\"/glossary#duration_time\"><strong>duration_time</strong></a>: 60</p><p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p>","operationId":"OBPv3.1.0-getObpConnectorLoopback","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ObpApiLoopbackJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/database/info":{"get":{"tags":["API"],"summary":"Get Mapper Database Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get basic information about the Mapper Database.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>","operationId":"OBPv4.0.0-getMapperDatabaseInfo","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AdapterInfoJsonV300"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/development/call_context":{"get":{"tags":["API"],"summary":"Get the Call Context of a current call","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the Call Context of the current call.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv4.0.0-getCallContext","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/development/echo/jws-verified-request-jws-signed-response":{"get":{"tags":["API"],"summary":"Verify Request and Sign Response of a current call","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Verify Request and Sign Response of a current call.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv4.0.0-verifyRequestSignResponse","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/jwks-uris":{"get":{"tags":["API","OAuth","OIDC"],"summary":"Get JSON Web Key (JWK) URIs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the OAuth2 server's public JSON Web Key (JWK) URIs.<br />It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#jwks_uri\"><strong>jwks_uri</strong></a>:</p><p><a href=\"/glossary#jwks_uris\"><strong>jwks_uris</strong></a>:</p>","operationId":"OBPv3.1.0-getOAuth2ServerJWKsURIs","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuth2ServerJwksUrisJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Bank Level Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get Bank Level Dynamic Endpoints.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getBankLevelDynamicEndpoints","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create dynamic endpoints.</p><p>Create dynamic endpoints with one json format swagger content.</p><p>If the host of swagger is <code>dynamic_entity</code>, then you need link the swagger fields to the dynamic entity fields,<br />please check <code>Endpoint Mapping</code> endpoints.</p><p>If the host of swagger is <code>obp_mock</code>, every dynamic endpoint will return example response of swagger,</p><p>when create MethodRouting for given dynamic endpoint, it will be routed to given url.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-createBankLevelDynamicEndpoint","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteBankLevelDynamicEndpoint","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Bank Level Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get a Bank Level Dynamic Endpoint.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getBankLevelDynamicEndpoint","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Bank Level Dynamic Endpoint Host","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update Bank Level  dynamic endpoint Host.<br />The value can be obp_mock, dynamic_entity, or some service url.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-updateBankLevelDynamicEndpointHost","parameters":[{"in":"body","name":"body","description":"DynamicEndpointHostJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get Bank Level Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get all the bank level Dynamic Entities for one bank.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getBankLevelDynamicEntities","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Create Bank Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create a Bank Level DynamicEntity.</p><p>Note: Once you have created a DynamicEntity to see it in the API Explorer II, find OBPdynamic-entity or similar in the list of API versions.</p><p>FYI Dynamic Entities and Dynamic Endpoints are listed in the Resource Doc endpoints by adding content=dynamic to the path. They are cached differently to static endpoints.</p><p><strong>Discovering the generated endpoints:</strong></p><p>After creating a Dynamic Entity, OBP automatically generates CRUD endpoints. To discover these endpoints programmatically, use:</p><p><code>GET /resource-docs/API_VERSION/obp?content=dynamic</code></p><p>This returns documentation for all dynamic endpoints including paths, schemas, and required roles.</p><p>For more information about Dynamic Entities see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically</p><p>The following field types are as supported:<br />[number, integer, boolean, string, DATE_WITH_DAY, json, reference]</p><p>The DATE_WITH_DAY format is: yyyy-MM-dd</p><p><strong>Important:</strong> Each property MUST include an <code>example</code> field with a valid example value. This is required for API documentation and validation.</p><p>Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity.</p><p>To see the complete list of available reference types and their correct formats, call:<br /><strong>GET /obp/v6.0.0/management/dynamic-entities/reference-types</strong></p><p>This endpoint returns all available reference types (both static OBP entities and dynamic entities) with example values showing the correct format.</p><p><strong>The hasPersonalEntity flag:</strong></p><ul><li>If <code>hasPersonalEntity</code> = <strong>true</strong> (default): OBP generates both regular endpoints AND personal 'my' endpoints. Data is user-scoped - each user only sees their own records via 'my' endpoints.</li><li>If <code>hasPersonalEntity</code> = <strong>false</strong>: OBP generates ONLY regular endpoints (no 'my' endpoints). Data is shared - all authorized users see the same records.</li></ul><p>This flag also affects authorization (role-based vs user-scoped) and whether cascade delete is allowed. See the Dynamic-Entities glossary for full details on data storage differences.</p><p><strong>IMPORTANT: Entity Naming</strong><br />In the examples below, &quot;AgentConversation&quot; and &quot;AgentMessage&quot; are example entity names. You should replace these with your own entity name (e.g., &quot;Event&quot;, &quot;Price&quot;, &quot;Order&quot;, &quot;Invoice&quot;). The entity name you choose will become the API endpoint name and must be a valid identifier.</p><p><strong>Example Request Body 1:</strong></p><pre><code class=\"language-json\">{  &quot;AgentConversation&quot;: {    &quot;description&quot;: &quot;Stores conversation metadata between users and agents&quot;,    &quot;required&quot;: [&quot;conversation_id&quot;, &quot;user_id&quot;],    &quot;properties&quot;: {      &quot;conversation_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;conv_3f8a7b29c91d4a93b0e0f5b1c9a4b2d1&quot;      },      &quot;user_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;user_47b2de93a3b14f3db6f5aa1e1c892a9a&quot;      },      &quot;title&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Stripe price ID error&quot;      },      &quot;created_at&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2025-01-07T14:30:00.000Z&quot;      },      &quot;model&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;gpt-5&quot;      },      &quot;language&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;en&quot;      },      &quot;metadata_platform&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;web&quot;      },      &quot;metadata_browser&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Firefox 144.0&quot;      },      &quot;metadata_os&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Ubuntu 22.04&quot;      },      &quot;tags&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;stripe,api,error&quot;      },      &quot;summary&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;User received 'No such price' error using Stripe API&quot;      },      &quot;custom_metadata&quot;: {        &quot;type&quot;: &quot;json&quot;,        &quot;example&quot;: {          &quot;priority&quot;: &quot;high&quot;,          &quot;tags&quot;: [&quot;support&quot;, &quot;billing&quot;],          &quot;context&quot;: {            &quot;page&quot;: &quot;checkout&quot;,            &quot;step&quot;: 3          }        }      }    }  },  &quot;hasPersonalEntity&quot;: true}</code></pre><p><strong>Example 2: AgentMessage Entity with Reference to the above Entity</strong></p><pre><code class=\"language-json\">{  &quot;hasPersonalEntity&quot;: true,  &quot;AgentMessage&quot;: {    &quot;description&quot;: &quot;Stores individual messages within agent conversations&quot;,    &quot;required&quot;: [      &quot;message_id&quot;,      &quot;conversation_id&quot;,      &quot;role&quot;    ],    &quot;properties&quot;: {      &quot;message_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;msg_8a2f3c6c44514c4ea92d4f7b91b6f002&quot;      },      &quot;conversation_id&quot;: {        &quot;type&quot;: &quot;reference:AgentConversation&quot;,        &quot;example&quot;: &quot;a8770fca-3d1d-47af-b6d0-7a6c3f124388&quot;      },      &quot;role&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;user&quot;      },      &quot;content_text&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;I'm using Stripe for the first time and getting an error...&quot;      },      &quot;timestamp&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2025-01-07T14:30:15.000Z&quot;      },      &quot;token_count&quot;: {        &quot;type&quot;: &quot;integer&quot;,        &quot;example&quot;: 150      },      &quot;model_used&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;gpt-5&quot;      }    }  }}</code></pre><p><strong>Important Notes:</strong><br />- <strong>Entity name is your choice</strong>: &quot;AgentConversation&quot;, &quot;FooBar&quot;, etc. are just examples. Replace with YOUR entity name (e.g., &quot;Event&quot;, &quot;Price&quot;, &quot;Invoice&quot;)<br />- <strong>Entity name becomes the endpoint</strong>: If you create an entity called &quot;Invoice&quot;, OBP will generate endpoints like <code>/obp/dynamic-entity/Invoice</code>, <code>POST /obp/dynamic-entity/Invoice</code>, etc.<br />- The entity name (e.g., &quot;AgentConversation&quot;) MUST be a direct top-level key in the JSON root object<br />- Do NOT wrap the entity in an &quot;entity&quot; field - this is a common mistake<br />- Do NOT include &quot;entityName&quot; as a separate field<br />- The JSON root can contain at most TWO fields: your entity name and optionally &quot;hasPersonalEntity&quot;<br />- The &quot;properties&quot; object contains all field definitions<br />- Each property must have &quot;type&quot; and &quot;example&quot; fields. The &quot;description&quot; field is optional<br />- For boolean fields, the example must be the STRING &quot;true&quot; or &quot;false&quot; (not boolean values)<br />- The &quot;hasPersonalEntity&quot; field is optional (defaults to true) and goes at the root level</p><p><strong>Tags Generated for CRUD Endpoints:</strong><br />When you create a dynamic entity, the resulting CRUD endpoints (GET all, GET one, POST, PUT, DELETE) will automatically be tagged with THREE tags:<br />1. <strong>Entity-specific tag</strong> - Based on your entity name (e.g., &quot;Piano&quot;, &quot;Invoice&quot;, &quot;AgentConversation&quot;)<br />2. <strong>&quot;Dynamic-Entity&quot;</strong> - Groups all dynamic entity endpoints together<br />3. <strong>&quot;Dynamic&quot;</strong> - Groups all dynamic endpoints (both entities and endpoints)</p><p>These tags help organize and filter endpoints in the API Explorer.</p><p><strong>Example 3: Piano Entity Demonstrating Different Field Types</strong></p><pre><code class=\"language-json\">{  &quot;Piano&quot;: {    &quot;description&quot;: &quot;Piano entity with make, year, number of keys, and type&quot;,    &quot;required&quot;: [&quot;make&quot;, &quot;year&quot;, &quot;number_of_keys&quot;, &quot;is_grand&quot;, &quot;date_purchased&quot;, &quot;weight_in_kg&quot;],    &quot;properties&quot;: {      &quot;make&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Steinway&quot;      },      &quot;year&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2023&quot;      },      &quot;number_of_keys&quot;: {        &quot;type&quot;: &quot;integer&quot;,        &quot;example&quot;: 88      },      &quot;is_grand&quot;: {        &quot;type&quot;: &quot;boolean&quot;,        &quot;example&quot;: &quot;true&quot;      },      &quot;date_purchased&quot;: {        &quot;type&quot;: &quot;DATE_WITH_DAY&quot;,        &quot;example&quot;: &quot;2023-06-15&quot;      },      &quot;weight_in_kg&quot;: {        &quot;type&quot;: &quot;number&quot;,        &quot;example&quot;: 480.5      }    }  },  &quot;hasPersonalEntity&quot;: true}</code></pre><p><strong>WRONG (will fail validation):</strong></p><pre><code class=\"language-json\">{  &quot;entity&quot;: {    &quot;AgentConversation&quot;: { ... }  }}</code></pre><p><strong>CORRECT:</strong></p><pre><code class=\"language-json\">{  &quot;AgentConversation&quot;: { ... },  &quot;hasPersonalEntity&quot;: true}</code></pre>","operationId":"OBPv4.0.0-createBankLevelDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/dynamic-entities/{DYNAMIC_ENTITY_ID}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete Bank Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a>/</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteBankLevelDynamicEntity","parameters":[{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}},"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update Bank Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update a Bank Level DynamicEntity.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.</p><p>The following field types are as supported:<br />[number, integer, boolean, string, DATE_WITH_DAY, json, reference]</p><p>The DATE_WITH_DAY format is: yyyy-MM-dd</p><p><strong>Important:</strong> Each property MUST include an <code>example</code> field with a valid example value. This is required for API documentation and validation.</p><p>To see all available reference types and their correct formats, call:<br /><strong>GET /obp/v6.0.0/management/dynamic-entities/reference-types</strong></p>","operationId":"OBPv4.0.0-updateBankLevelDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorBankNotFound"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/endpoints/OPERATION_ID/tags":{"get":{"tags":["API"],"summary":"Get Bank Level Endpoint Tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get Bank Level Endpoint Tags.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-getBankLevelEndpointTags","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/NotSupportedYet"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["API"],"summary":"Create Bank Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create Bank Level Endpoint Tag</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON request body fields:</strong></p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-createBankLevelEndpointTag","parameters":[{"in":"body","name":"body","description":"EndpointTagJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EndpointTagJson400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BankLevelEndpointTagResponseJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/banks/{BANK_ID}/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID":{"delete":{"tags":["API"],"summary":"Delete Bank Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete Bank Level Endpoint Tag.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><a href=\"/glossary#\">ENDPOINT_TAG_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv4.0.0-deleteBankLevelEndpointTag","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/Full"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["API"],"summary":"Update Bank Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><a href=\"/glossary#\">ENDPOINT_TAG_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-updateBankLevelEndpointTag","parameters":[{"in":"body","name":"body","description":"EndpointTagJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EndpointTagJson400"}},{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BankLevelEndpointTagResponseJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/connector/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Connector Metrics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the all metrics</p><p>require CanGetConnectorMetrics role</p><p>Filters Part 1.<em>filtering</em> (no wilde cards etc.) parameters to GET /management/connector/metrics</p><p>Should be able to filter on the following metrics fields</p><p>eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:01.000Z&amp;limit=50&amp;offset=2</p><p>1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z</p><p>2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z</p><p>3 limit (for pagination: defaults to 1000)  eg:limit=2000</p><p>4 offset (for pagination: zero index, defaults to 0) eg: offset=10</p><p>eg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:01.000Z&amp;limit=100&amp;offset=300</p><p>Other filters:</p><p>5 connector_name  (if null ignore)</p><p>6 function_name (if null ignore)</p><p>7 correlation_id (if null ignore)</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#connector_name\"><strong>connector_name</strong></a>:</p><p><a href=\"/glossary#\"><strong>correlation_id</strong></a>: 1flssoftxq0cr1nssr68u0mioj</p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#duration\"><strong>duration</strong></a>: 5.123</p><p><a href=\"/glossary#function_name\"><strong>function_name</strong></a>:</p><p><a href=\"/glossary#metrics\"><strong>metrics</strong></a>:</p>","operationId":"OBPv2.2.0-getConnectorMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ConnectorMetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidDateFormat"}}}}},"/obp/v5.1.0/management/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Get Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get Dynamic Endpoints.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getDynamicEndpoints","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Create Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create dynamic endpoints.</p><p>Create dynamic endpoints with one json format swagger content.</p><p>If the host of swagger is <code>dynamic_entity</code>, then you need link the swagger fields to the dynamic entity fields,<br />please check <code>Endpoint Mapping</code> endpoints.</p><p>If the host of swagger is <code>obp_mock</code>, every dynamic endpoint will return example response of swagger,</p><p>when create MethodRouting for given dynamic endpoint, it will be routed to given url.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-createDynamicEndpoint","parameters":[{"in":"body","name":"body","description":"JObject object that needs to be added.","required":true,"schema":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}}],"responses":{"201":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Delete Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get a Dynamic Endpoint.</p><p>Get one DynamicEndpoint,</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getDynamicEndpoint","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host":{"put":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":" Update Dynamic Endpoint Host","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update dynamic endpoint Host.<br />The value can be obp_mock, dynamic_entity, or some service url.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-updateDynamicEndpointHost","parameters":[{"in":"body","name":"body","description":"DynamicEndpointHostJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEndpointHostJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags":{"get":{"tags":["API"],"summary":"Get System Level Endpoint Tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get System Level Endpoint Tags.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-getSystemLevelEndpointTags","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/NotSupportedYet"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["API"],"summary":"Create System Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create System Level Endpoint Tag</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON request body fields:</strong></p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-createSystemLevelEndpointTag","parameters":[{"in":"body","name":"body","description":"EndpointTagJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EndpointTagJson400"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/BankLevelEndpointTagResponseJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID":{"delete":{"tags":["API"],"summary":"Delete System Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete System Level Endpoint Tag.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">ENDPOINT_TAG_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv4.0.0-deleteSystemLevelEndpointTag","parameters":[],"responses":{"204":{"description":"Success","schema":{"$ref":"#/definitions/Full"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["API"],"summary":"Update System Level Endpoint Tag","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.</p><p>Note: Resource Docs are cached, TTL is 3600 seconds</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">ENDPOINT_TAG_ID</a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\">OPERATION_ID</a>: OBPv6.0.0-getBanks</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>endpoint_tag_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv6.0.0-getBanks</p><p><a href=\"/glossary#\"><strong>tag_name</strong></a>: BankAccountTag1</p>","operationId":"OBPv4.0.0-updateSystemLevelEndpointTag","parameters":[{"in":"body","name":"body","description":"EndpointTagJson400 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/EndpointTagJson400"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/BankLevelEndpointTagResponseJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/method_routings":{"get":{"tags":["Method-Routing","API"],"summary":"Get MethodRoutings","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the all MethodRoutings.</p><p>Query url parameters:</p><ul><li>method_name: filter with method_name</li><li>active: if active = true, it will show all the webui_ props. Even if they are set yet, we will return all the default webui_ props</li></ul><p>eg:<br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?active=true\">https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?active=true</a><br /><a href=\"https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank\">https://apisandbox.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>key</strong></a>: CustomerNumber</p><p><a href=\"/glossary#parameters\"><strong>parameters</strong></a>:</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p>","operationId":"OBPv3.1.0-getMethodRoutings","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["method_routings"],"properties":{"method_routings":{"type":"array","items":{"$ref":"#/definitions/MethodRoutingCommons"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Method-Routing","API"],"summary":"Create MethodRouting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create a MethodRouting.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Explanation of Fields:</p><ul><li>method_name is required String value, current supported value: [mapped]</li><li>connector_name is required String value</li><li>is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false</li><li>bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex</li><li>parameters is optional array of key value pairs. You can set some parameters for this method</li></ul><p>note and CAVEAT!:</p><ul><li>bank_id_pattern has to be empty for methods that do not take bank_id as a function parameter, otherwise might get empty result</li><li>methods that aggregate bank objects (e.g. getBankAccountsForUser) have to take any  existing method routings for these objects into consideration</li><li>so if you create e.g. a bank specific method routing for getting an account, make sure that it is also served by endpoints getting ALL accounts for ALL banks</li><li>if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = &quot;some-id_pattern_\\d+&quot;</li></ul><p>If the connector name starts with rest, parameters can contain &quot;outBoundMapping&quot; and &quot;inBoundMapping&quot;, convert OutBound and InBound json structure.<br />for example:<br />outBoundMapping example, convert json from source to target:<br /><img src=\"https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png\" alt=\"Snipaste_outBoundMapping\" /><br />Build OutBound json value rules:<br />1 set cId value with: outboundAdapterCallContext.correlationId value<br />2 set bankId value with: concat bankId.value value with  string helloworld<br />3 set originalJson value with: whole source json, note: the field value expression is $root</p><p>inBoundMapping example, convert json from source to target:<br /><img src=\"https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png\" alt=\"inBoundMapping\" /><br />Build InBound json value rules:<br />1 and 2 set inboundAdapterCallContext and status value: because field name ends with &quot;$default&quot;, remove &quot;$default&quot; from field name, not change the value<br />3 set fullName value with: concat string full: with result.name value<br />4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].</p><p><strong>JSON request body fields:</strong></p><p><a href=\"/glossary#\"><strong>key</strong></a>: CustomerNumber</p><p><a href=\"/glossary#parameters\"><strong>parameters</strong></a>:</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>key</strong></a>: CustomerNumber</p><p><a href=\"/glossary#parameters\"><strong>parameters</strong></a>:</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p>","operationId":"OBPv3.1.0-createMethodRouting","parameters":[{"in":"body","name":"body","description":"MethodRoutingCommons object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MethodRoutingCommons"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/MethodRoutingCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/method_routings/{METHOD_ROUTING_ID}":{"delete":{"tags":["Method-Routing","API"],"summary":"Delete MethodRouting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a MethodRouting specified by METHOD_ROUTING_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#method_routing_id\">METHOD_ROUTING_ID</a>:</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv3.1.0-deleteMethodRouting","parameters":[{"in":"path","name":"METHOD_ROUTING_ID","description":"the method routing id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Method-Routing","API"],"summary":"Update MethodRouting","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update a MethodRouting.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Explaination of Fields:</p><ul><li>method_name is required String value, current supported value: [mapped]</li><li>connector_name is required String value</li><li>is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false</li><li>bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex</li><li>parameters is optional array of key value pairs. You can set some paremeters for this method<br />note:</li><li><p>if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = &quot;some-id_pattern_\\d+&quot;</p></li></ul><p>If connector name start with rest, parameters can contain &quot;outBoundMapping&quot; and &quot;inBoundMapping&quot;, to convert OutBound and InBound json structure.<br />for example:<br />outBoundMapping example, convert json from source to target:<br /><img src=\"https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png\" alt=\"Snipaste_outBoundMapping\" /><br />Build OutBound json value rules:<br />1 set cId value with: outboundAdapterCallContext.correlationId value<br />2 set bankId value with: concat bankId.value value with  string helloworld<br />3 set originalJson value with: whole source json, note: the field value expression is $root</p><p>inBoundMapping example, convert json from source to target:<br /><img src=\"https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png\" alt=\"inBoundMapping\" /><br />Build InBound json value rules:<br />1 and 2 set inboundAdapterCallContext and status value: because field name ends with &quot;$default&quot;, remove &quot;$default&quot; from field name, not change the value<br />3 set fullName value with: concat string full: with result.name value<br />4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#method_routing_id\">METHOD_ROUTING_ID</a>:</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>key</strong></a>: CustomerNumber</p><p><a href=\"/glossary#parameters\"><strong>parameters</strong></a>:</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p>","operationId":"OBPv3.1.0-updateMethodRouting","parameters":[{"in":"body","name":"body","description":"MethodRoutingCommons object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/MethodRoutingCommons"}},{"in":"path","name":"METHOD_ROUTING_ID","description":"the method routing id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MethodRoutingCommons"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/metrics":{"get":{"tags":["Metric","API"],"summary":"Get Metrics","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get API metrics rows. These are records of each REST API call.</p><p>require CanReadMetrics role</p><p><strong>IMPORTANT: Smart Caching &amp; Performance</strong></p><p>This endpoint uses intelligent two-tier caching to optimize performance:</p><p><strong>Stable Data Cache (Long TTL):</strong><br />- Metrics older than 600 seconds (10 minutes) are considered immutable/stable<br />- These are cached for 86400 seconds (24 hours)<br />- Used when your query's from_date is older than the stable boundary</p><p><strong>Recent Data Cache (Short TTL):</strong><br />- Recent metrics (within the stable boundary) are cached for 7 seconds<br />- Used when your query includes recent data or has no from_date</p><p><strong>STRONGLY RECOMMENDED: Always specify from_date in your queries!</strong></p><p><strong>Why from_date matters:</strong><br />- Queries WITH from_date older than 10 mins → cached for 24 hours (fast!)<br />- Queries WITHOUT from_date → cached for only 7 seconds (slower)</p><p><strong>Examples:</strong><br />- <code>from_date=2025-01-01T00:00:00.000Z</code> → Uses 24 hours cache (historical data)<br />- <code>from_date=1100-01-01T01:01:01.000Z</code> (recent date) → Uses 7 seconds cache (recent data)<br />- No from_date (e.g., <code>?limit=50</code>) → Uses 7 seconds cache (assumes recent data)</p><p>For best performance on historical/reporting queries, always include a from_date parameter!</p><p>Filters Part 1.<em>filtering</em> (no wilde cards etc.) parameters to GET /management/metrics</p><p>You can filter by the following fields by applying url parameters</p><p>eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:01.000Z&amp;limit=50&amp;offset=2</p><p>1 from_date e.g.:from_date=1100-01-01T01:01:01.000Z Defaults to the Unix Epoch i.e. Thu Jan 01 00:00:00 UTC 1970<br /><strong>IMPORTANT</strong>: Including from_date enables long-term caching for historical data queries!</p><p>2 to_date e.g.:to_date=1100-01-01T01:01:01.000Z Defaults to a far future date i.e. Sat Jan 01 00:00:00 UTC 4000</p><p>3 limit (for pagination: defaults to 50)  eg:limit=200</p><p>4 offset (for pagination: zero index, defaults to 0) eg: offset=10</p><p>5 sort_by (defaults to date field) eg: sort_by=date<br />possible values:<br />&quot;url&quot;,<br />&quot;date&quot;,<br />&quot;username&quot; (or &quot;user_name&quot; for backward compatibility),<br />&quot;app_name&quot;,<br />&quot;developer_email&quot;,<br />&quot;implemented_by_partial_function&quot;,<br />&quot;implemented_in_version&quot;,<br />&quot;consumer_id&quot;,<br />&quot;verb&quot;,<br />&quot;http_status_code&quot;</p><p>6 direction (defaults to date desc) eg: direction=desc</p><p>eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:<a href=\"&#109;&#x61;&#105;&#108;&#x74;&#111;&#x3a;&#48;1&#46;&#48;&#48;0Z&#38;&#x6c;&#x69;&#109;&#105;t&#x3d;&#49;&#48;00&#48;&#x26;&#x6f;f&#x66;&#x73;et&#x3d;&#x30;&#x26;&#97;&#110;&#x6f;&#110;&#x3d;&#x66;&#97;&#108;&#x73;&#x65;&#x26;&#97;&#x70;&#112;&#95;&#110;&#97;&#109;&#x65;&#61;&#84;e&#x61;&#x74;&#65;&#112;&#x70;&#x26;&#x69;&#109;&#x70;&#x6c;&#101;&#x6d;&#x65;n&#x74;&#101;&#x64;&#x5f;&#x69;&#110;&#95;&#x76;&#x65;rs&#105;&#111;&#x6e;=&#x76;&#x32;&#46;1&#x2e;&#48;&#x26;&#x76;&#101;rb&#61;&#80;&#x4f;S&#84;&#x26;&#117;&#x73;e&#114;&#x5f;&#x69;&#x64;&#61;&#99;&#x37;&#x62;&#54;&#99;&#98;4&#55;&#45;&#x63;&#x62;9&#x36;&#45;&#x34;&#52;4&#49;-&#56;8&#x30;1&#x2d;&#x33;&#x35;&#98;&#x35;&#55;&#x34;&#x35;&#54;&#55;&#x35;&#51;&#97;&amp;u&#115;&#101;&#114;na&#109;&#101;=&#115;&#117;&#115;&#x61;n.&#x75;k.&#50;&#x39;@&#x65;&#x78;&#x61;&#x6d;pl&#x65;&#x2e;c&#111;m\">&#x30;&#49;.&#48;&#x30;&#x30;Z&amp;l&#105;&#109;i&#x74;=&#49;&#48;&#x30;&#48;&#48;&#38;&#x6f;&#102;&#x66;&#115;&#x65;&#x74;&#x3d;&#48;&#x26;&#97;&#110;&#x6f;n=&#x66;a&#x6c;&#x73;&#x65;&amp;&#x61;&#x70;&#x70;_&#110;&#97;&#x6d;&#x65;&#x3d;&#x54;&#101;&#x61;t&#x41;p&#112;&#x26;&#x69;mp&#108;&#101;&#x6d;&#x65;&#110;&#x74;&#101;&#100;_&#105;n&#x5f;&#118;&#101;&#x72;&#115;&#105;&#x6f;&#x6e;=&#118;&#50;&#x2e;&#x31;&#x2e;&#x30;&#38;&#118;&#101;&#114;&#x62;&#x3d;&#80;O&#83;&#84;&#38;&#117;&#x73;e&#x72;&#95;i&#x64;&#61;&#99;&#55;&#98;&#54;&#99;b4&#x37;&#45;&#99;&#98;&#57;&#54;&#45;44&#x34;1&#x2d;8&#x38;&#x30;&#x31;&#x2d;35&#x62;&#x35;&#55;4&#x35;&#54;&#55;&#x35;3&#x61;&amp;&#x75;&#115;&#101;&#114;&#x6e;&#97;&#x6d;&#101;&#61;&#115;&#x75;&#x73;&#x61;&#110;&#46;&#x75;&#107;&#x2e;&#x32;&#57;@&#x65;&#x78;a&#x6d;&#x70;l&#x65;&#46;&#99;&#x6f;&#109;</a>&amp;consumer_id=78</p><p>Other filters:</p><p>7 consumer_id  (if null ignore)</p><p>8 user_id (if null ignore)</p><p>9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)</p><p>10 url (if null ignore), note: can not contain '&amp;'.</p><p>11 app_name (if null ignore)</p><p>12 implemented_by_partial_function (if null ignore),</p><p>13 implemented_in_version (if null ignore)</p><p>14 verb (if null ignore)</p><p>15 correlation_id (if null ignore)</p><p>16 duration (if null ignore) - Returns calls where duration &gt; specified value (in milliseconds). Use this to find slow API calls. eg: duration=5000 returns calls taking more than 5 seconds</p><p>17 http_status_code (if null ignore) - Returns calls with specific HTTP status code. eg: http_status_code=200 returns only successful calls, http_status_code=500 returns server errors</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#app_name\"><strong>app_name</strong></a>: appNameBank</p><p><a href=\"/glossary#\"><strong>consumer_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>correlation_id</strong></a>: 1flssoftxq0cr1nssr68u0mioj</p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#developer_email\"><strong>developer_email</strong></a>:</p><p><a href=\"/glossary#duration\"><strong>duration</strong></a>: 5.123</p><p><a href=\"/glossary#implemented_by_partial_function\"><strong>implemented_by_partial_function</strong></a>:</p><p><a href=\"/glossary#implemented_in_version\"><strong>implemented_in_version</strong></a>:</p><p><a href=\"/glossary#metrics\"><strong>metrics</strong></a>:</p><p><a href=\"/glossary#\"><strong>response_body</strong></a>: response_body</p><p><a href=\"/glossary#\"><strong>source_ip</strong></a>: source_ip</p><p><a href=\"/glossary#\"><strong>target_ip</strong></a>: target_ip</p><p><a href=\"/glossary#\"><strong>url</strong></a>: <a href=\"http://www.example.com/id-docs/123/image.png\">http://www.example.com/id-docs/123/image.png</a></p><p><a href=\"/glossary#\"><strong>user_id</strong></a>: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1</p><p><a href=\"/glossary#\"><strong>user_name</strong></a>: felixsmith</p><p><a href=\"/glossary#verb\"><strong>verb</strong></a>:</p>","operationId":"OBPv5.1.0-getMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MetricsJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/metrics/banks/{BANK_ID}":{"get":{"tags":["Metric","API"],"summary":"Get Metrics at Bank","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the all metrics at the Bank specified by BANK_ID</p><p>require CanReadMetrics role</p><p>Filters Part 1.<em>filtering</em> (no wilde cards etc.) parameters to GET /management/metrics</p><p>Should be able to filter on the following metrics fields</p><p>eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:01.000Z&amp;limit=50&amp;offset=2</p><p>1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z</p><p>2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z</p><p>3 limit (for pagination: defaults to 50)  eg:limit=200</p><p>4 offset (for pagination: zero index, defaults to 0) eg: offset=10</p><p>5 sort_by (defaults to date field) eg: sort_by=date<br />possible values:<br />&quot;url&quot;,<br />&quot;date&quot;,<br />&quot;username&quot; (or &quot;user_name&quot; for backward compatibility),<br />&quot;app_name&quot;,<br />&quot;developer_email&quot;,<br />&quot;implemented_by_partial_function&quot;,<br />&quot;implemented_in_version&quot;,<br />&quot;consumer_id&quot;,<br />&quot;verb&quot;</p><p>6 direction (defaults to date desc) eg: direction=desc</p><p>eg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&amp;to_date=1100-01-01T01:01:<a href=\"&#109;&#x61;&#x69;&#108;to&#x3a;&#48;&#x31;.&#48;&#48;&#x30;Z&#38;&#108;im&#105;&#116;&#61;1&#x30;&#48;&#x30;&#x30;&#38;&#x6f;&#x66;&#x66;&#115;e&#116;&#x3d;&#x30;&#38;&#97;&#110;&#111;&#x6e;&#61;fa&#x6c;&#x73;&#101;&amp;&#97;&#x70;&#112;&#95;&#110;&#x61;&#x6d;e&#x3d;&#x54;&#101;a&#116;A&#112;&#x70;&#x26;&#105;&#x6d;&#x70;le&#109;e&#110;&#x74;&#101;&#100;&#95;&#105;&#110;&#x5f;&#118;e&#114;&#115;i&#111;&#x6e;&#61;v&#x32;&#x2e;&#x31;.0&amp;&#118;&#x65;&#114;&#98;&#x3d;P&#79;&#83;T&#x26;&#117;s&#x65;&#114;&#x5f;&#105;d&#61;&#99;&#55;&#98;&#54;cb4&#x37;&#x2d;c&#98;9&#54;&#x2d;4&#52;&#52;&#x31;&#45;&#56;&#56;&#x30;&#49;&#45;35b&#x35;&#55;&#x34;&#x35;6&#55;&#53;&#51;a&#x26;&#x75;&#115;&#101;&#x72;&#110;&#x61;&#x6d;&#x65;&#61;&#x73;&#x75;&#x73;&#97;&#110;.&#117;&#x6b;&#46;&#50;&#x39;&#x40;&#x65;x&#x61;&#109;&#x70;le&#x2e;&#99;&#111;&#x6d;\">&#48;&#x31;.&#48;00&#x5a;&amp;l&#x69;&#x6d;&#x69;&#116;&#x3d;&#x31;&#x30;&#48;0&#48;&#38;&#111;&#x66;&#x66;&#x73;&#101;t&#61;&#x30;&#38;&#97;&#110;&#111;&#110;&#x3d;&#102;&#97;&#108;se&#x26;&#97;&#112;&#112;&#95;&#110;&#97;&#x6d;e=T&#101;&#97;t&#65;&#112;&#x70;&#38;i&#109;&#x70;&#x6c;&#101;&#109;e&#110;&#116;&#101;&#100;&#95;&#105;&#110;&#x5f;&#x76;&#x65;&#114;&#x73;&#x69;o&#110;&#x3d;&#x76;2&#x2e;&#49;&#46;&#x30;&#38;&#x76;&#x65;&#x72;b&#61;&#x50;&#x4f;&#x53;&#x54;&#x26;u&#115;&#x65;r&#95;&#x69;d&#x3d;&#x63;7&#98;&#54;&#99;&#x62;4&#x37;-&#99;&#x62;&#x39;&#54;&#45;&#x34;&#x34;4&#49;&#45;&#56;80&#49;-&#51;&#x35;b5&#55;&#x34;&#53;&#54;&#x37;&#53;&#51;a&#x26;&#x75;&#115;&#x65;r&#110;&#97;me&#x3d;&#x73;&#x75;s&#97;&#x6e;&#46;&#117;&#x6b;&#x2e;&#50;9@&#x65;&#x78;a&#x6d;&#112;&#x6c;&#101;&#x2e;&#99;o&#109;</a>&amp;consumer_id=78</p><p>Other filters:</p><p>7 consumer_id  (if null ignore)</p><p>8 user_id (if null ignore)</p><p>9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)</p><p>10 url (if null ignore), note: can not contain '&amp;'.</p><p>11 app_name (if null ignore)</p><p>12 implemented_by_partial_function (if null ignore),</p><p>13 implemented_in_version (if null ignore)</p><p>14 verb (if null ignore)</p><p>15 correlation_id (if null ignore)</p><p>16 duration (if null ignore) non digit chars will be silently omitted</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#app_name\"><strong>app_name</strong></a>: appNameBank</p><p><a href=\"/glossary#\"><strong>consumer_id</strong></a>: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh</p><p><a href=\"/glossary#\"><strong>correlation_id</strong></a>: 1flssoftxq0cr1nssr68u0mioj</p><p><a href=\"/glossary#\"><strong>date</strong></a>: 2020-01-27</p><p><a href=\"/glossary#developer_email\"><strong>developer_email</strong></a>:</p><p><a href=\"/glossary#duration\"><strong>duration</strong></a>: 5.123</p><p><a href=\"/glossary#implemented_by_partial_function\"><strong>implemented_by_partial_function</strong></a>:</p><p><a href=\"/glossary#implemented_in_version\"><strong>implemented_in_version</strong></a>:</p><p><a href=\"/glossary#metrics\"><strong>metrics</strong></a>:</p><p><a href=\"/glossary#\"><strong>url</strong></a>: <a href=\"http://www.example.com/id-docs/123/image.png\">http://www.example.com/id-docs/123/image.png</a></p><p><a href=\"/glossary#\"><strong>user_id</strong></a>: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1</p><p><a href=\"/glossary#\"><strong>user_name</strong></a>: felixsmith</p><p><a href=\"/glossary#verb\"><strong>verb</strong></a>:</p>","operationId":"OBPv5.0.0-getMetricsAtBank","parameters":[{"in":"path","name":"BANK_ID","description":"The bank id","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MetricsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/system-dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get System Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get all System Dynamic Entities.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getSystemDynamicEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Create System Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create a system level Dynamic Entity.</p><p>Note: To see DynamicEntity in API Explorer II, find OBPdynamic-entity or similar in the list of API versions.</p><p>FYI Dynamic Entities and Dynamic Endpoints are listed in the Resource Doc endpoints by adding content=dynamic to the path. They are cached differently to static endpoints.</p><p><strong>Discovering the generated endpoints:</strong></p><p>After creating a Dynamic Entity, OBP automatically generates CRUD endpoints. To discover these endpoints programmatically, use:</p><p><code>GET /resource-docs/API_VERSION/obp?content=dynamic</code></p><p>This returns documentation for all dynamic endpoints including paths, schemas, and required roles.</p><p>For more information about Dynamic Entities see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically</p><p>The following field types are as supported:<br />[number, integer, boolean, string, DATE_WITH_DAY, json, reference]</p><p>The DATE_WITH_DAY format is: yyyy-MM-dd</p><p><strong>Important:</strong> Each property MUST include an <code>example</code> field with a valid example value. This is required for API documentation and validation.</p><p>Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity.</p><p>To see the complete list of available reference types and their correct formats, call:<br /><strong>GET /obp/v6.0.0/management/dynamic-entities/reference-types</strong></p><p>This endpoint returns all available reference types (both static OBP entities and dynamic entities) with example values showing the correct format.</p><p><strong>The hasPersonalEntity flag:</strong></p><ul><li>If <code>hasPersonalEntity</code> = <strong>true</strong> (default): OBP generates both regular endpoints AND personal 'my' endpoints. Data is user-scoped - each user only sees their own records via 'my' endpoints.</li><li>If <code>hasPersonalEntity</code> = <strong>false</strong>: OBP generates ONLY regular endpoints (no 'my' endpoints). Data is shared - all authorized users see the same records.</li></ul><p>This flag also affects authorization (role-based vs user-scoped) and whether cascade delete is allowed. See the Dynamic-Entities glossary for full details on data storage differences.</p><p><strong>IMPORTANT: Entity Naming</strong><br />In the examples below, &quot;AgentConversation&quot; and &quot;AgentMessage&quot; are example entity names. You should replace these with your own entity name (e.g., &quot;Event&quot;, &quot;Price&quot;, &quot;Order&quot;, &quot;Invoice&quot;). The entity name you choose will become the API endpoint name and must be a valid identifier.</p><p><strong>Example Request Body 1:</strong></p><pre><code class=\"language-json\">{  &quot;AgentConversation&quot;: {    &quot;description&quot;: &quot;Stores conversation metadata between users and agents&quot;,    &quot;required&quot;: [&quot;conversation_id&quot;, &quot;user_id&quot;],    &quot;properties&quot;: {      &quot;conversation_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;conv_3f8a7b29c91d4a93b0e0f5b1c9a4b2d1&quot;      },      &quot;user_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;user_47b2de93a3b14f3db6f5aa1e1c892a9a&quot;      },      &quot;title&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Stripe price ID error&quot;      },      &quot;created_at&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2025-01-07T14:30:00.000Z&quot;      },      &quot;model&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;gpt-5&quot;      },      &quot;language&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;en&quot;      },      &quot;metadata_platform&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;web&quot;      },      &quot;metadata_browser&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Firefox 144.0&quot;      },      &quot;metadata_os&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Ubuntu 22.04&quot;      },      &quot;tags&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;stripe,api,error&quot;      },      &quot;summary&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;User received 'No such price' error using Stripe API&quot;      },      &quot;custom_metadata&quot;: {        &quot;type&quot;: &quot;json&quot;,        &quot;example&quot;: {          &quot;priority&quot;: &quot;high&quot;,          &quot;tags&quot;: [&quot;support&quot;, &quot;billing&quot;],          &quot;context&quot;: {            &quot;page&quot;: &quot;checkout&quot;,            &quot;step&quot;: 3          }        }      }    }  },  &quot;hasPersonalEntity&quot;: true}</code></pre><p><strong>Example 2: AgentMessage Entity with Reference to the above Entity</strong></p><pre><code class=\"language-json\">{  &quot;hasPersonalEntity&quot;: true,  &quot;AgentMessage&quot;: {    &quot;description&quot;: &quot;Stores individual messages within agent conversations&quot;,    &quot;required&quot;: [      &quot;message_id&quot;,      &quot;conversation_id&quot;,      &quot;role&quot;    ],    &quot;properties&quot;: {      &quot;message_id&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;msg_8a2f3c6c44514c4ea92d4f7b91b6f002&quot;      },      &quot;conversation_id&quot;: {        &quot;type&quot;: &quot;reference:AgentConversation&quot;,        &quot;example&quot;: &quot;a8770fca-3d1d-47af-b6d0-7a6c3f124388&quot;      },      &quot;role&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;user&quot;      },      &quot;content_text&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;I'm using Stripe for the first time and getting an error...&quot;      },      &quot;timestamp&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2025-01-07T14:30:15.000Z&quot;      },      &quot;token_count&quot;: {        &quot;type&quot;: &quot;integer&quot;,        &quot;example&quot;: 150      },      &quot;model_used&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;gpt-5&quot;      }    }  }}</code></pre><p><strong>Important Notes:</strong><br />- <strong>Entity name is your choice</strong>: &quot;AgentConversation&quot;, &quot;FooBar&quot;, etc. are just examples. Replace with YOUR entity name (e.g., &quot;Event&quot;, &quot;Price&quot;, &quot;Invoice&quot;)<br />- <strong>Entity name becomes the endpoint</strong>: If you create an entity called &quot;Invoice&quot;, OBP will generate endpoints like <code>/obp/dynamic-entity/Invoice</code>, <code>POST /obp/dynamic-entity/Invoice</code>, etc.<br />- The entity name (e.g., &quot;AgentConversation&quot;) MUST be a direct top-level key in the JSON root object<br />- Do NOT wrap the entity in an &quot;entity&quot; field - this is a common mistake<br />- Do NOT include &quot;entityName&quot; as a separate field<br />- The JSON root can contain at most TWO fields: your entity name and optionally &quot;hasPersonalEntity&quot;<br />- The &quot;properties&quot; object contains all field definitions<br />- Each property must have &quot;type&quot; and &quot;example&quot; fields. The &quot;description&quot; field is optional<br />- For boolean fields, the example must be the STRING &quot;true&quot; or &quot;false&quot; (not boolean values)<br />- The &quot;hasPersonalEntity&quot; field is optional (defaults to true) and goes at the root level</p><p><strong>Tags Generated for CRUD Endpoints:</strong><br />When you create a dynamic entity, the resulting CRUD endpoints (GET all, GET one, POST, PUT, DELETE) will automatically be tagged with THREE tags:<br />1. <strong>Entity-specific tag</strong> - Based on your entity name (e.g., &quot;Piano&quot;, &quot;Invoice&quot;, &quot;AgentConversation&quot;)<br />2. <strong>&quot;Dynamic-Entity&quot;</strong> - Groups all dynamic entity endpoints together<br />3. <strong>&quot;Dynamic&quot;</strong> - Groups all dynamic endpoints (both entities and endpoints)</p><p>These tags help organize and filter endpoints in the API Explorer.</p><p><strong>Example 3: Piano Entity Demonstrating Different Field Types</strong></p><pre><code class=\"language-json\">{  &quot;Piano&quot;: {    &quot;description&quot;: &quot;Piano entity with make, year, number of keys, and type&quot;,    &quot;required&quot;: [&quot;make&quot;, &quot;year&quot;, &quot;number_of_keys&quot;, &quot;is_grand&quot;, &quot;date_purchased&quot;, &quot;weight_in_kg&quot;],    &quot;properties&quot;: {      &quot;make&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;Steinway&quot;      },      &quot;year&quot;: {        &quot;type&quot;: &quot;string&quot;,        &quot;example&quot;: &quot;2023&quot;      },      &quot;number_of_keys&quot;: {        &quot;type&quot;: &quot;integer&quot;,        &quot;example&quot;: 88      },      &quot;is_grand&quot;: {        &quot;type&quot;: &quot;boolean&quot;,        &quot;example&quot;: &quot;true&quot;      },      &quot;date_purchased&quot;: {        &quot;type&quot;: &quot;DATE_WITH_DAY&quot;,        &quot;example&quot;: &quot;2023-06-15&quot;      },      &quot;weight_in_kg&quot;: {        &quot;type&quot;: &quot;number&quot;,        &quot;example&quot;: 480.5      }    }  },  &quot;hasPersonalEntity&quot;: true}</code></pre><p><strong>WRONG (will fail validation):</strong></p><pre><code class=\"language-json\">{  &quot;entity&quot;: {    &quot;AgentConversation&quot;: { ... }  }}</code></pre><p><strong>CORRECT:</strong></p><pre><code class=\"language-json\">{  &quot;AgentConversation&quot;: { ... },  &quot;hasPersonalEntity&quot;: true}</code></pre>","operationId":"OBPv4.0.0-createSystemDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/management/system-dynamic-entities/{DYNAMIC_ENTITY_ID}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete System Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a>/</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteSystemDynamicEntity","parameters":[{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update System Level Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update a System Level Dynamic Entity.</p><p>For more information see <a href=\"/glossary#Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Update one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.</p><p>The following field types are as supported:<br />[number, integer, boolean, string, DATE_WITH_DAY, json, reference]</p><p>The DATE_WITH_DAY format is: yyyy-MM-dd</p><p><strong>Important:</strong> Each property MUST include an <code>example</code> field with a valid example value. This is required for API documentation and validation.</p><p>To see all available reference types and their correct formats, call:<br /><strong>GET /obp/v6.0.0/management/dynamic-entities/reference-types</strong></p>","operationId":"OBPv4.0.0-updateSystemDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/message-docs/CONNECTOR":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>These message docs provide example messages sent by OBP to the (RabbitMq) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.<br />Integrators can use these messages to build Adapters that provide core banking services to OBP.</p><p>Note: API Explorer provides a Message Docs page where these messages are displayed.</p><p><code>CONNECTOR</code>: rest_vMar2019, stored_procedure_vDec2019 ...</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Connector\">CONNECTOR</a>: CONNECTOR</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#adapter_implementation\"><strong>adapter_implementation</strong></a>:</p><p><a href=\"/glossary#dependent_endpoints\"><strong>dependent_endpoints</strong></a>:</p><p><a href=\"/glossary#description\"><strong>description</strong></a>: Description of the object. Maximum length is 2000. It can be any characters here.</p><p><a href=\"/glossary#example_inbound_message\"><strong>example_inbound_message</strong></a>: {}</p><p><a href=\"/glossary#example_outbound_message\"><strong>example_outbound_message</strong></a>: {}</p><p><a href=\"/glossary#group\"><strong>group</strong></a>:</p><p><a href=\"/glossary#message_docs\"><strong>message_docs</strong></a>:</p><p><a href=\"/glossary#message_format\"><strong>message_format</strong></a>:</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#process\"><strong>process</strong></a>: obp.getBank</p><p><a href=\"/glossary#suggested_order\"><strong>suggested_order</strong></a>:</p><p><a href=\"/glossary#version\"><strong>version</strong></a>:</p><p><a href=\"/glossary#inboundavroschema\">inboundAvroSchema</a>:</p><p><a href=\"/glossary#inbound_topic\">inbound_topic</a>:</p><p><a href=\"/glossary#outboundavroschema\">outboundAvroSchema</a>:</p><p><a href=\"/glossary#outbound_topic\">outbound_topic</a>:</p><p><a href=\"/glossary#requiredfieldinfo\">requiredFieldInfo</a>: false</p>","operationId":"OBPv2.2.0-getMessageDocs","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/MessageDocsJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorInvalidConnector"}}}}},"/obp/v5.1.0/message-docs/CONNECTOR/swagger2.0":{"get":{"tags":["Message-Doc","Documentation","API"],"summary":"Get Message Docs Swagger","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>This endpoint provides example message docs in swagger format.<br />It is only relavent for REST Connectors.</p><p>This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).<br />That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.</p><p>i.e.:</p><p>OBP API (Core OBP API code) -&gt; OBP REST Connector (OBP REST Connector code) -&gt; OBP REST Adapter (Adapter developer code) -&gt; CBS (Main Frame)</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#Connector\">CONNECTOR</a>: CONNECTOR</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv3.1.0-getMessageDocsSwagger","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/my/dynamic-endpoints":{"get":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Get My Dynamic Endpoints","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get My Dynamic Endpoints.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getMyDynamicEndpoints","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_endpoints"],"properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"dynamic_endpoint_id":{"type":"string","example":"dynamic-endpoint-id"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string","example":"2.0"}},"required":["swagger"]}},"required":["user_id","dynamic_endpoint_id","swagger_string"]}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/my/dynamic-endpoints/DYNAMIC_ENDPOINT_ID":{"delete":{"tags":["Dynamic-Endpoint-Manage","API"],"summary":"Delete My Dynamic Endpoint","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteMyDynamicEndpoint","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/my/dynamic-entities":{"get":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Get My Dynamic Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get all my Dynamic Entities (definitions I created).</p><p>For more information see <a href=\"/glossary#My-Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-getMyDynamicEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"type":"object","required":["dynamic_entities"],"properties":{"dynamic_entities":{"type":"array","items":{"$ref":"#/definitions/DynamicEntityFooBar"}}}}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/my/dynamic-entities/{DYNAMIC_ENTITY_ID}":{"delete":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Delete My Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.</p><p>For more information see <a href=\"/glossary#My-Dynamic-Entities\">here</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>","operationId":"OBPv4.0.0-deleteMyDynamicEntity","parameters":[{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Dynamic-Entity-Manage","API"],"summary":"Update My Dynamic Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update my DynamicEntity.</p><p>For more information see <a href=\"/glossary#My-Dynamic-Entities\">here</a>/</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p>Update one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.</p><p>Current support filed types as follow:<br />[number, integer, boolean, string, DATE_WITH_DAY, json, reference]</p><p>The DATE_WITH_DAY format is: yyyy-MM-dd</p><p><strong>Important:</strong> Each property MUST include an <code>example</code> field with a valid example value. This is required for API documentation and validation.</p><p>To see all available reference types and their correct formats, call:<br /><strong>GET /obp/v6.0.0/management/dynamic-entities/reference-types</strong></p>","operationId":"OBPv4.0.0-updateMyDynamicEntity","parameters":[{"in":"body","name":"body","description":"DynamicEntityFooBar object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},{"in":"path","name":"DYNAMIC_ENTITY_ID","description":"the dynamic entity id ","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/DynamicEntityFooBar"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/rate-limiting":{"get":{"tags":["API","Rate-Limits"],"summary":"Get Rate Limiting Info","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get information about the Rate Limiting setup on this OBP Instance such as:</p><p>Is rate limiting enabled and active?<br />What backend is used to keep track of the API calls (e.g. REDIS).</p><p>Note: Rate limiting can be set at the Consumer level and also for anonymous calls.</p><p>See the consumer rate limits / call limits endpoints.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#enabled\"><strong>enabled</strong></a>: false</p><p><a href=\"/glossary#is_active\"><strong>is_active</strong></a>: false</p><p><a href=\"/glossary#service_available\"><strong>service_available</strong></a>:</p><p><a href=\"/glossary#technology\"><strong>technology</strong></a>: technology1</p>","operationId":"OBPv3.1.0-getRateLimitingInfo","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RateLimitingInfoV310"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/regulated-entities":{"get":{"tags":["Directory","API"],"summary":"Get Regulated Entities","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns information about:</p><ul><li>Regulated Entities</li></ul><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attributeType</strong></a>: attributeType</p><p><a href=\"/glossary#certificate_authority_ca_owner_id\"><strong>certificate_authority_ca_owner_id</strong></a>: CY_CBC</p><p><a href=\"/glossary#\"><strong>entities</strong></a>: entities</p><p><a href=\"/glossary#entity_address\"><strong>entity_address</strong></a>: EXAMPLE COMPANY LTD, 5 SOME STREET</p><p><a href=\"/glossary#entity_certificate_public_key\"><strong>entity_certificate_public_key</strong></a>: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==</p><p><a href=\"/glossary#entity_code\"><strong>entity_code</strong></a>: PSD_PICY_CBC!12345</p><p><a href=\"/glossary#entity_country\"><strong>entity_country</strong></a>: CY</p><p><a href=\"/glossary#entity_id\"><strong>entity_id</strong></a>: 0af807d7-3c39-43ef-9712-82bcfde1b9ca</p><p><a href=\"/glossary#entity_name\"><strong>entity_name</strong></a>: EXAMPLE COMPANY LTD</p><p><a href=\"/glossary#entity_post_code\"><strong>entity_post_code</strong></a>: 1060</p><p><a href=\"/glossary#entity_town_city\"><strong>entity_town_city</strong></a>: SOME CITY</p><p><a href=\"/glossary#entity_type\"><strong>entity_type</strong></a>: PSD_PI</p><p><a href=\"/glossary#entity_web_site\"><strong>entity_web_site</strong></a>: <a href=\"http://www.example.com\">www.example.com</a></p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#services\"><strong>services</strong></a>: [{&quot;CY&quot;:[&quot;PS_010&quot;,&quot;PS_020&quot;,&quot;PS_03C&quot;,&quot;PS_04C&quot;]}]</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#attributes\">attributes</a>: attribute value in form of (name, value)</p>","operationId":"OBPv5.1.0-regulatedEntities","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntitiesJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}},"post":{"tags":["Directory","API"],"summary":"Create Regulated Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create Regulated Entity</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON request body fields:</strong></p><p><a href=\"/glossary#\"><strong>attributeType</strong></a>: attributeType</p><p><a href=\"/glossary#certificate_authority_ca_owner_id\"><strong>certificate_authority_ca_owner_id</strong></a>: CY_CBC</p><p><a href=\"/glossary#entity_address\"><strong>entity_address</strong></a>: EXAMPLE COMPANY LTD, 5 SOME STREET</p><p><a href=\"/glossary#entity_certificate_public_key\"><strong>entity_certificate_public_key</strong></a>: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==</p><p><a href=\"/glossary#entity_code\"><strong>entity_code</strong></a>: PSD_PICY_CBC!12345</p><p><a href=\"/glossary#entity_country\"><strong>entity_country</strong></a>: CY</p><p><a href=\"/glossary#entity_name\"><strong>entity_name</strong></a>: EXAMPLE COMPANY LTD</p><p><a href=\"/glossary#entity_post_code\"><strong>entity_post_code</strong></a>: 1060</p><p><a href=\"/glossary#entity_town_city\"><strong>entity_town_city</strong></a>: SOME CITY</p><p><a href=\"/glossary#entity_type\"><strong>entity_type</strong></a>: PSD_PI</p><p><a href=\"/glossary#entity_web_site\"><strong>entity_web_site</strong></a>: <a href=\"http://www.example.com\">www.example.com</a></p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#services\"><strong>services</strong></a>: [{&quot;CY&quot;:[&quot;PS_010&quot;,&quot;PS_020&quot;,&quot;PS_03C&quot;,&quot;PS_04C&quot;]}]</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#attributes\">attributes</a>: attribute value in form of (name, value)</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attributeType</strong></a>: attributeType</p><p><a href=\"/glossary#certificate_authority_ca_owner_id\"><strong>certificate_authority_ca_owner_id</strong></a>: CY_CBC</p><p><a href=\"/glossary#entity_address\"><strong>entity_address</strong></a>: EXAMPLE COMPANY LTD, 5 SOME STREET</p><p><a href=\"/glossary#entity_certificate_public_key\"><strong>entity_certificate_public_key</strong></a>: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==</p><p><a href=\"/glossary#entity_code\"><strong>entity_code</strong></a>: PSD_PICY_CBC!12345</p><p><a href=\"/glossary#entity_country\"><strong>entity_country</strong></a>: CY</p><p><a href=\"/glossary#entity_id\"><strong>entity_id</strong></a>: 0af807d7-3c39-43ef-9712-82bcfde1b9ca</p><p><a href=\"/glossary#entity_name\"><strong>entity_name</strong></a>: EXAMPLE COMPANY LTD</p><p><a href=\"/glossary#entity_post_code\"><strong>entity_post_code</strong></a>: 1060</p><p><a href=\"/glossary#entity_town_city\"><strong>entity_town_city</strong></a>: SOME CITY</p><p><a href=\"/glossary#entity_type\"><strong>entity_type</strong></a>: PSD_PI</p><p><a href=\"/glossary#entity_web_site\"><strong>entity_web_site</strong></a>: <a href=\"http://www.example.com\">www.example.com</a></p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#services\"><strong>services</strong></a>: [{&quot;CY&quot;:[&quot;PS_010&quot;,&quot;PS_020&quot;,&quot;PS_03C&quot;,&quot;PS_04C&quot;]}]</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#attributes\">attributes</a>: attribute value in form of (name, value)</p>","operationId":"OBPv5.1.0-createRegulatedEntity","parameters":[{"in":"body","name":"body","description":"RegulatedEntityPostJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RegulatedEntityPostJsonV510"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID":{"delete":{"tags":["Directory","API"],"summary":"Delete Regulated Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete Regulated Entity specified by REGULATED_ENTITY_ID</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-deleteRegulatedEntity","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Directory","API"],"summary":"Get Regulated Entity","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get Regulated Entity By REGULATED_ENTITY_ID</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attributeType</strong></a>: attributeType</p><p><a href=\"/glossary#certificate_authority_ca_owner_id\"><strong>certificate_authority_ca_owner_id</strong></a>: CY_CBC</p><p><a href=\"/glossary#entity_address\"><strong>entity_address</strong></a>: EXAMPLE COMPANY LTD, 5 SOME STREET</p><p><a href=\"/glossary#entity_certificate_public_key\"><strong>entity_certificate_public_key</strong></a>: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==</p><p><a href=\"/glossary#entity_code\"><strong>entity_code</strong></a>: PSD_PICY_CBC!12345</p><p><a href=\"/glossary#entity_country\"><strong>entity_country</strong></a>: CY</p><p><a href=\"/glossary#entity_id\"><strong>entity_id</strong></a>: 0af807d7-3c39-43ef-9712-82bcfde1b9ca</p><p><a href=\"/glossary#entity_name\"><strong>entity_name</strong></a>: EXAMPLE COMPANY LTD</p><p><a href=\"/glossary#entity_post_code\"><strong>entity_post_code</strong></a>: 1060</p><p><a href=\"/glossary#entity_town_city\"><strong>entity_town_city</strong></a>: SOME CITY</p><p><a href=\"/glossary#entity_type\"><strong>entity_type</strong></a>: PSD_PI</p><p><a href=\"/glossary#entity_web_site\"><strong>entity_web_site</strong></a>: <a href=\"http://www.example.com\">www.example.com</a></p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#services\"><strong>services</strong></a>: [{&quot;CY&quot;:[&quot;PS_010&quot;,&quot;PS_020&quot;,&quot;PS_03C&quot;,&quot;PS_04C&quot;]}]</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#attributes\">attributes</a>: attribute value in form of (name, value)</p>","operationId":"OBPv5.1.0-getRegulatedEntityById","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes":{"get":{"tags":["Directory","API"],"summary":"Get All Regulated Entity Attributes","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get all attributes for the specified Regulated Entity.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attribute_type</strong></a>: STRING</p><p><a href=\"/glossary#attributes\"><strong>attributes</strong></a>: attribute value in form of (name, value)</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>regulated_entity_attribute_id</strong></a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\"><strong>regulated_entity_id</strong></a>: regulated_entity_id</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#is_active\">is_active</a>: false</p>","operationId":"OBPv5.1.0-getAllRegulatedEntityAttributes","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityAttributesJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"post":{"tags":["Directory","API"],"summary":"Create Regulated Entity Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Create a new Regulated Entity Attribute for a given REGULATED_ENTITY_ID.</p><p>The type field must be one of &quot;STRING&quot;, &quot;INTEGER&quot;, &quot;DOUBLE&quot; or &quot;DATE_WITH_DAY&quot;.<br />User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON request body fields:</strong></p><p><a href=\"/glossary#\"><strong>attribute_type</strong></a>: STRING</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#is_active\">is_active</a>: false</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attribute_type</strong></a>: STRING</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>regulated_entity_attribute_id</strong></a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\"><strong>regulated_entity_id</strong></a>: regulated_entity_id</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#is_active\">is_active</a>: false</p>","operationId":"OBPv5.1.0-createRegulatedEntityAttribute","parameters":[{"in":"body","name":"body","description":"RegulatedEntityAttributeRequestJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RegulatedEntityAttributeRequestJsonV510"}}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityAttributeResponseJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID":{"delete":{"tags":["Directory","API"],"summary":"Delete Regulated Entity Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Delete a Regulated Entity Attribute specified by REGULATED_ENTITY_ATTRIBUTE_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ATTRIBUTE_ID</a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-deleteRegulatedEntityAttribute","parameters":[],"responses":{"204":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"get":{"tags":["Directory","API"],"summary":"Get Regulated Entity Attribute By ID","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get a specific Regulated Entity Attribute by its REGULATED_ENTITY_ATTRIBUTE_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ATTRIBUTE_ID</a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attribute_type</strong></a>: STRING</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>regulated_entity_attribute_id</strong></a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\"><strong>regulated_entity_id</strong></a>: regulated_entity_id</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#is_active\">is_active</a>: false</p>","operationId":"OBPv5.1.0-getRegulatedEntityAttributeById","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityAttributeResponseJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}},"put":{"tags":["Directory","API"],"summary":"Update Regulated Entity Attribute","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Update an existing Regulated Entity Attribute specified by ATTRIBUTE_ID.</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>URL Parameters:</strong></p><p><a href=\"/glossary#\">REGULATED_ENTITY_ATTRIBUTE_ID</a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\">REGULATED_ENTITY_ID</a>: REGULATED_ENTITY_ID</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>attribute_type</strong></a>: STRING</p><p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p><p><a href=\"/glossary#\"><strong>regulated_entity_attribute_id</strong></a>: attrafa-9a0f-4bfa-b30b-9003aa467f51</p><p><a href=\"/glossary#\"><strong>regulated_entity_id</strong></a>: regulated_entity_id</p><p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p><p><a href=\"/glossary#is_active\">is_active</a>: false</p>","operationId":"OBPv5.1.0-updateRegulatedEntityAttribute","parameters":[{"in":"body","name":"body","description":"RegulatedEntityAttributeRequestJsonV510 object that needs to be added.","required":true,"schema":{"$ref":"#/definitions/RegulatedEntityAttributeRequestJsonV510"}}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/RegulatedEntityAttributeResponseJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/root":{"get":{"tags":["API"],"summary":"Get API Info (root)","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns information about:</p><ul><li>API version</li><li>Hosted by information</li><li>Hosted at information</li><li>Energy source information</li><li>Git Commit</li></ul><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#Connector\"><strong>connector</strong></a>: connector</p><p><a href=\"/glossary#\"><strong>email</strong></a>: <a href=\"&#x6d;&#x61;i&#x6c;t&#111;&#x3a;&#102;&#101;&#x6c;&#x69;&#120;&#x73;&#x6d;i&#116;h&#x40;&#101;&#120;am&#x70;&#x6c;&#101;&#46;&#x63;&#x6f;&#109;\">&#102;&#x65;&#x6c;&#x69;&#x78;s&#x6d;&#x69;t&#104;&#x40;e&#x78;&#x61;&#109;&#x70;&#108;&#x65;&#x2e;&#x63;&#111;m</a></p><p><a href=\"/glossary#energy_source\"><strong>energy_source</strong></a>:</p><p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p><p><a href=\"/glossary#hosted_at\"><strong>hosted_at</strong></a>:</p><p><a href=\"/glossary#hosted_by\"><strong>hosted_by</strong></a>:</p><p><a href=\"/glossary#\"><strong>hostname</strong></a>: hostname</p><p><a href=\"/glossary#\"><strong>local_identity_provider</strong></a>: local_identity_provider</p><p><a href=\"/glossary#organisation\"><strong>organisation</strong></a>:</p><p><a href=\"/glossary#organisation_website\"><strong>organisation_website</strong></a>:</p><p><a href=\"/glossary#phone\"><strong>phone</strong></a>:</p><p><a href=\"/glossary#\"><strong>resource_docs_requires_role</strong></a>: resource_docs_requires_role</p><p><a href=\"/glossary#version\"><strong>version</strong></a>:</p><p><a href=\"/glossary#version_status\"><strong>version_status</strong></a>:</p>","operationId":"OBPv5.1.0-root","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/APIInfoJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/search/metrics":{"get":{"tags":["Metric","API","Old-Style"],"summary":"Search API Metrics via Elasticsearch","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Search the API calls made to this API instance via Elastic Search.</p><p>Login is required.</p><p>CanSearchMetrics entitlement is required to search metrics data.</p><p>parameters:</p><p>esType  - elasticsearch type</p><p>simple query:</p><p>q       - plain_text_query</p><p>df      - default field to search</p><p>sort    - field to sort on</p><p>size    - number of hits returned, default 10</p><p>from    - show hits starting from</p><p>json query:</p><p>source  - JSON_query_(URL-escaped)</p><p>example usage:</p><p>/search/metrics/q=findThis</p><p>or:</p><p>/search/metrics/source={&quot;query&quot;:{&quot;query_string&quot;:{&quot;query&quot;:&quot;findThis&quot;}}}</p><p>Note!!</p><p>The whole JSON query string MUST be URL-encoded:</p><ul><li>For {  use %7B</li><li>For }  use %7D</li><li>For : use %3A</li><li>For &quot; use %22</li></ul><p>etc..</p><p>Only q, source and esType are passed to Elastic</p><p>Elastic simple query: <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html\">https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html</a></p><p>Elastic JSON query: <a href=\"https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html\">https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html</a></p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#none\">none</a>:</p>","operationId":"OBPv2.0.0-elasticSearchMetrics","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/EmptyElasticSearch"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/all":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get All Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns logs of all levels from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/all?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheAllEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/debug":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Debug Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns DEBUG level logs from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/debug?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheDebugEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/error":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Error Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns ERROR level logs from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/error?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheErrorEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/info":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Info Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns INFO level logs from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/info?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheInfoEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/trace":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Trace Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns TRACE level logs from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/trace?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheTraceEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/system/log-cache/warning":{"get":{"tags":["System","API","Log-Cache"],"summary":"Get Warning Level Log Cache","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns WARNING level logs from the system log cache.</p><p>This endpoint supports pagination via the following optional query parameters:<br />* limit - Maximum number of log entries to return<br />* offset - Number of log entries to skip (for pagination)</p><p>Example: GET /system/log-cache/warning?limit=50&amp;offset=100</p><p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p><p><strong>JSON response body fields:</strong></p>","operationId":"OBPv5.1.0-logCacheWarningEndpoint","parameters":[],"responses":{"200":{"description":"Success"},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorAuthenticatedUserIsRequired"}}}}},"/obp/v5.1.0/tags":{"get":{"tags":["API"],"summary":"Get API Tags","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get API TagsGet API Tags</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>account_id</strong></a>: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0</p><p><a href=\"/glossary#accounts\"><strong>accounts</strong></a>:</p><p><a href=\"/glossary#\"><strong>bank_id</strong></a>: gh.29.uk</p><p><a href=\"/glossary#\"><strong>view_id</strong></a>: owner</p>","operationId":"OBPv5.1.0-getApiTags","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/AccountsMinimalJson400"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/ui/suggested-session-timeout":{"get":{"tags":["API"],"summary":"Get Suggested Session Timeout","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Returns information about:</p><ul><li>Suggested session timeout in case of a user inactivity</li></ul><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>timeout_in_seconds</strong></a>: timeout_in_seconds</p>","operationId":"OBPv5.1.0-suggestedSessionTimeout","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/SuggestedSessionTimeoutV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/waiting-for-godot":{"get":{"tags":["API"],"summary":"Waiting For Godot","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Waiting For Godot</p><p>Uses query parameter &quot;sleep&quot; in milliseconds.<br />For instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#\"><strong>sleep_in_milliseconds</strong></a>: sleep_in_milliseconds</p>","operationId":"OBPv5.1.0-waitingForGodot","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/WaitingForGodotJsonV510"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}},"/obp/v5.1.0/well-known":{"get":{"tags":["API"],"summary":"Get Well Known URIs","security":[{"directLogin":[],"gatewayLogin":[]}],"description":"<p>Get the OAuth2 server's public Well Known URIs.</p><p>User Authentication is Optional. The User need not be logged in.</p><p><strong>JSON response body fields:</strong></p><p><a href=\"/glossary#jwks_uri\"><strong>jwks_uri</strong></a>:</p><p><a href=\"/glossary#jwks_uris\"><strong>jwks_uris</strong></a>:</p>","operationId":"OBPv5.1.0-getOAuth2ServerWellKnown","parameters":[],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/OAuth2ServerJwksUrisJson"}},"400":{"description":"Error","schema":{"$ref":"#/definitions/ErrorUnknownError"}}}}}},"definitions":{"ErrorInvalidDateFormat":{"properties":{"message":{"type":"string","example":"OBP-10005: Invalid Date Format. Could not convert value to a Date."}}},"ErrorInvalidApiVersionString":{"properties":{"message":{"type":"string","example":"OBP-00027: Invalid API Version string. We could not find the version specified."}}},"ErrorAuthenticatedUserIsRequired":{"properties":{"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}}},"ErrorBankNotFound":{"properties":{"message":{"type":"string","example":"OBP-30001: Bank not found. Please specify a valid value for BANK_ID."}}},"ErrorInvalidConnector":{"properties":{"message":{"type":"string","example":"OBP-30211: Invalid Connector. Please specify a valid value for CONNECTOR."}}},"ErrorUnknownError":{"properties":{"message":{"type":"string","example":"OBP-50000: Unknown Error."}}},"NotSupportedYet":{"properties":{}},"EndpointTagJson400":{"required":["tag_name"],"properties":{"tag_name":{"type":"string","example":"BankAccountTag1"}}},"DynamicEntityFooBar":{"required":["hasPersonalEntity","FooBar"],"properties":{"dynamicEntityId":{"type":"string"},"hasPersonalEntity":{"type":"boolean","example":"true"},"FooBar":{"$ref":"#/definitions/DynamicEntityDefinition"},"userId":{"type":"string"},"bankId":{"type":"string"}}},"DynamicEndpointHostJson400":{"required":["host"],"properties":{"host":{"type":"string","example":"dynamic_entity"}}},"MethodRoutingCommons":{"required":["is_bank_id_exact_match","method_name","connector_name","parameters"],"properties":{"is_bank_id_exact_match":{"type":"boolean","example":"true"},"method_name":{"type":"string","example":"getBank"},"connector_name":{"type":"string","example":"rest_vMar2019"},"method_routing_id":{"type":"string"},"bank_id_pattern":{"type":"string","example":"some_bankId"},"parameters":{"type":"array","items":{"$ref":"#/definitions/MethodRoutingParam"}}}},"RegulatedEntityAttributeRequestJsonV510":{"required":["name","attribute_type","value"],"properties":{"name":{"type":"string","example":"Attribute Name"},"attribute_type":{"type":"string","example":"STRING"},"value":{"type":"string","example":"1234"},"is_active":{"type":"boolean","example":"false"}}},"RegulatedEntityPostJsonV510":{"required":["services","entity_code","entity_web_site","entity_country","entity_certificate_public_key","entity_type","entity_post_code","entity_name","entity_town_city","entity_address","certificate_authority_ca_owner_id"],"properties":{"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"string","example":"PS_010"}}},"required":["CY"]}},"entity_code":{"type":"string","example":"PSD_PICY_CBC!12345"},"entity_web_site":{"type":"string","example":"www.example.com"},"entity_country":{"type":"string","example":"CY"},"entity_certificate_public_key":{"type":"string","example":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ=="},"entity_type":{"type":"string","example":"PSD_PI"},"attributes":{"type":"array","items":{"$ref":"#/definitions/RegulatedEntityAttributeSimple"}},"entity_post_code":{"type":"string","example":"1060"},"entity_name":{"type":"string","example":"EXAMPLE COMPANY LTD"},"entity_town_city":{"type":"string","example":"SOME CITY"},"entity_address":{"type":"string","example":"EXAMPLE COMPANY LTD, 5 SOME STREET"},"certificate_authority_ca_owner_id":{"type":"string","example":"CY_CBC"}}},"RegulatedEntityAttributeResponseJsonV510":{"required":["name","attribute_type","regulated_entity_id","value","regulated_entity_attribute_id"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"is_active":{"type":"boolean","example":"false"},"attribute_type":{"type":"string","example":""},"regulated_entity_id":{"type":"string","example":"0af807d7-3c39-43ef-9712-82bcfde1b9ca"},"value":{"type":"string","example":"5987953"},"regulated_entity_attribute_id":{"type":"string","example":"attrafa-9a0f-4bfa-b30b-9003aa467f51"}}},"BankLevelEndpointTagResponseJson400":{"required":["bank_id","endpoint_tag_id","operation_id","tag_name"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"endpoint_tag_id":{"type":"string","example":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"operation_id":{"type":"string","example":"OBPv6.0.0-getBanks"},"tag_name":{"type":"string","example":"BankAccountTag1"}}},"AdapterInfoJsonV500":{"required":["name","backend_messages","total_duration","version","date","git_commit"],"properties":{"name":{"type":"string","example":"ACCOUNT_MANAGEMENT_FEE"},"backend_messages":{"type":"array","items":{"$ref":"#/definitions/InboundStatusMessage"}},"total_duration":{"type":"string","format":"double","example":"5.123"},"version":{"type":"string","example":""},"date":{"type":"string","example":"2020-01-27"},"git_commit":{"type":"string","example":"59623811dd8a41f6ffe67be46954eee11913dc28"}}},"AdapterInfoJsonV300":{"required":["name","version","git_commit","date"],"properties":{"name":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"git_commit":{"type":"string","example":"String"},"date":{"type":"string","example":"2013-01-21T23:08:00Z"}}},"SeverJWK":{"required":["e","n","kty","use","kid"],"properties":{"e":{"type":"string","example":"AQAB"},"n":{"type":"string","example":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"},"kty":{"type":"string","example":"RSA"},"use":{"type":"string","example":"sig"},"kid":{"type":"string","example":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s"}}},"Full":{"required":["value"],"properties":{"value":{"type":"boolean","example":"true"}}},"RateLimitingInfoV310":{"required":["enabled","technology","service_available","is_active"],"properties":{"enabled":{"type":"boolean","example":"true"},"technology":{"type":"string","example":"REDIS"},"service_available":{"type":"boolean","example":"true"},"is_active":{"type":"boolean","example":"true"}}},"OAuth2ServerJwksUrisJson":{"required":["jwks_uris"],"properties":{"jwks_uris":{"type":"array","items":{"$ref":"#/definitions/OAuth2ServerJWKURIJson"}}}},"MetricsJsonV510":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricJsonV510"}}}},"WaitingForGodotJsonV510":{"required":["sleep_in_milliseconds"],"properties":{"sleep_in_milliseconds":{"type":"integer","format":"int64","example":"50"}}},"MessageDocsJson":{"required":["message_docs"],"properties":{"message_docs":{"type":"array","items":{"$ref":"#/definitions/MessageDocJson"}}}},"ObpApiLoopbackJson":{"required":["connector_version","git_commit","duration_time"],"properties":{"connector_version":{"type":"string","example":"rest_vMar2019"},"git_commit":{"type":"string","example":"f0acd4be14cdcb94be3433ec95c1ad65228812a0"},"duration_time":{"type":"string","example":"10 ms"}}},"AccountsMinimalJson400":{"required":["accounts"],"properties":{"accounts":{"type":"array","items":{"$ref":"#/definitions/AccountMinimalJson400"}}}},"ConnectorMetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/ConnectorMetricJson"}}}},"ConfigurationJSON":{"required":["akka","elastic_search","cache","scopes"],"properties":{"akka":{"$ref":"#/definitions/AkkaJSON"},"elastic_search":{"$ref":"#/definitions/ElasticSearchJSON"},"cache":{"type":"array","items":{"$ref":"#/definitions/CachedFunctionJSON"}},"scopes":{"$ref":"#/definitions/ScopesJSON"}}},"EmptyElasticSearch":{"properties":{"none":{"type":"string"}}},"MetricsJson":{"required":["metrics"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricJson"}}}},"RegulatedEntityAttributesJsonV510":{"required":["attributes"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/RegulatedEntityAttributeResponseJsonV510"}}}},"RegulatedEntitiesJsonV510":{"required":["entities"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RegulatedEntityJsonV510"}}}},"APIInfoJson400":{"required":["local_identity_provider","resource_docs_requires_role","hostname","version_status","version","hosted_at","connector","energy_source","hosted_by","git_commit"],"properties":{"local_identity_provider":{"type":"string","example":"String"},"resource_docs_requires_role":{"type":"boolean","example":"false"},"hostname":{"type":"string","example":"String"},"version_status":{"type":"string","example":"String"},"version":{"type":"string","example":"String"},"hosted_at":{"$ref":"#/definitions/HostedAt400"},"connector":{"type":"string","example":"String"},"energy_source":{"$ref":"#/definitions/EnergySource400"},"hosted_by":{"$ref":"#/definitions/HostedBy400"},"git_commit":{"type":"string","example":"String"}}},"SuggestedSessionTimeoutV510":{"required":["timeout_in_seconds"],"properties":{"timeout_in_seconds":{"type":"string","example":"300"}}},"RegulatedEntityJsonV510":{"required":["services","entity_code","entity_web_site","entity_country","entity_certificate_public_key","entity_type","entity_post_code","entity_name","entity_town_city","entity_address","entity_id","certificate_authority_ca_owner_id"],"properties":{"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"string","example":"PS_010"}}},"required":["CY"]}},"entity_code":{"type":"string","example":"PSD_PICY_CBC!12345"},"entity_web_site":{"type":"string","example":"www.example.com"},"entity_country":{"type":"string","example":"CY"},"entity_certificate_public_key":{"type":"string","example":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ=="},"entity_type":{"type":"string","example":"PSD_PI"},"attributes":{"type":"array","items":{"$ref":"#/definitions/RegulatedEntityAttributeSimple"}},"entity_post_code":{"type":"string","example":"1060"},"entity_name":{"type":"string","example":"EXAMPLE COMPANY LTD"},"entity_town_city":{"type":"string","example":"SOME CITY"},"entity_address":{"type":"string","example":"EXAMPLE COMPANY LTD, 5 SOME STREET"},"entity_id":{"type":"string","example":"0af807d7-3c39-43ef-9712-82bcfde1b9ca"},"certificate_authority_ca_owner_id":{"type":"string","example":"CY_CBC"}}},"DynamicEntityStringTypeExample":{"required":["description","minLength","type","example","maxLength"],"properties":{"description":{"type":"string","example":"description of **name** field, can be markdown text."},"minLength":{"type":"integer","format":"int32","example":"3"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY","json"]},"example":{"type":"string","example":"James Brown"},"maxLength":{"type":"integer","format":"int32","example":"20"}}},"DynamicEntityIntTypeExample":{"required":["type","example","description"],"properties":{"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY","json"]},"example":{"type":"integer","format":"int32","example":"698761728"},"description":{"type":"string","example":"description of **number** field, can be markdown text."}}},"DynamicEntityFullBarFields":{"required":["name","number"],"properties":{"name":{"$ref":"#/definitions/DynamicEntityStringTypeExample"},"number":{"$ref":"#/definitions/DynamicEntityIntTypeExample"}}},"DynamicEntityDefinition":{"required":["description","required","properties"],"properties":{"description":{"type":"string","example":"description of this entity, can be markdown text."},"required":{"type":"array","items":{"type":"string"}},"properties":{"$ref":"#/definitions/DynamicEntityFullBarFields"}}},"MethodRoutingParam":{"required":["key","value"],"properties":{"key":{"type":"string","example":"url"},"value":{"type":"string","example":"http://mydomain.com/xxx"}}},"RegulatedEntityAttributeSimple":{"required":["attributeType","name","value"],"properties":{"attributeType":{"type":"string","example":"STRING"},"name":{"type":"string","example":"STATUS"},"value":{"type":"string","example":"closed"}}},"InboundStatusMessage":{"required":["source","text","errorCode","status"],"properties":{"duration":{"type":"string","format":"double","example":"5.123"},"source":{"type":"string","example":""},"text":{"type":"string","example":""},"errorCode":{"type":"string","example":""},"status":{"type":"string","example":""}}},"OAuth2ServerJWKURIJson":{"required":["jwks_uri"],"properties":{"jwks_uri":{"type":"string","example":"https://www.googleapis.com/oauth2/v3/certs"}}},"MetricJsonV510":{"required":["duration","response_body","implemented_in_version","target_ip","url","correlation_id","implemented_by_partial_function","user_id","developer_email","date","consumer_id","verb","app_name","source_ip","user_name"],"properties":{"duration":{"type":"integer","format":"int64","example":"39"},"response_body":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":"401"},"message":{"type":"string","example":"OBP-20001: User not logged in. Authentication is required!"}},"required":["code","message"]},"implemented_in_version":{"type":"string","example":"v210"},"target_ip":{"type":"string","example":"2001:db8:1234:5678::1"},"url":{"type":"string","example":"www.openbankproject.com"},"correlation_id":{"type":"string","example":"v8ho6h5ivel3uq7a5zcnv0w1"},"implemented_by_partial_function":{"type":"string","example":"getBanks"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"consumer_id":{"type":"string","example":"123"},"verb":{"type":"string","example":"get"},"app_name":{"type":"string","example":"SOFI"},"source_ip":{"type":"string","example":"2001:db8:1234:5678::1"},"user_name":{"type":"string","example":"OBP"}}},"AdapterImplementationJson":{"required":["group","suggested_order"],"properties":{"group":{"type":"string","example":"CORE"},"suggested_order":{"type":"integer","format":"int32","example":"3"}}},"EndpointInfo":{"required":["name","version"],"properties":{"name":{"type":"string","example":"getAccounts"},"version":{"type":"string","example":"OBPv3.0.0"}}},"FieldNameApiVersions":{"properties":{}},"MessageDocJson":{"required":["adapter_implementation","example_inbound_message","description","process","message_format","example_outbound_message","dependent_endpoints"],"properties":{"adapter_implementation":{"$ref":"#/definitions/AdapterImplementationJson"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"requiredFieldInfo":{"$ref":"#/definitions/FieldNameApiVersions"},"description":{"type":"string","example":"get Banks"},"process":{"type":"string","example":"getAccounts"},"message_format":{"type":"string","example":"rest_vMar2019"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string","example":"{}"}},"required":["jsonString"]},"dependent_endpoints":{"type":"array","items":{"$ref":"#/definitions/EndpointInfo"}},"outbound_topic":{"type":"string","example":"to.obp.api.1.caseclass.OutboundGetAccounts"},"inbound_topic":{"type":"string","example":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts"}}},"AccountMinimalJson400":{"required":["bank_id","account_id","view_id"],"properties":{"bank_id":{"type":"string","example":"gh.29.uk"},"account_id":{"type":"string","example":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"view_id":{"type":"string","example":"owner"}}},"ConnectorMetricJson":{"required":["connector_name","duration","function_name","correlation_id","date"],"properties":{"connector_name":{"type":"string","example":"mapper"},"duration":{"type":"integer","format":"int64","example":"1000"},"function_name":{"type":"string","example":"getBanks"},"correlation_id":{"type":"string","example":"12345"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"}}},"PortJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"default"},"value":{"type":"string","example":"8080"}}},"AkkaJSON":{"required":["ports","log_level"],"properties":{"ports":{"type":"array","items":{"$ref":"#/definitions/PortJSON"}},"log_level":{"type":"string","example":"Debug"},"remote_data_secret_matched":{"type":"boolean","example":"true"}}},"MetricsJsonV220":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"Mapper"}}},"WarehouseJSON":{"required":["property","value"],"properties":{"property":{"type":"string","example":"String"},"value":{"type":"string","example":"ElasticSearch"}}},"ElasticSearchJSON":{"required":["metrics","warehouse"],"properties":{"metrics":{"type":"array","items":{"$ref":"#/definitions/MetricsJsonV220"}},"warehouse":{"type":"array","items":{"$ref":"#/definitions/WarehouseJSON"}}}},"CachedFunctionJSON":{"required":["function_name","ttl_in_seconds"],"properties":{"function_name":{"type":"string","example":"getBanks"},"ttl_in_seconds":{"type":"integer","format":"int32","example":"5"}}},"ScopesJSON":{"required":["require_scopes_for_all_roles","require_scopes_for_listed_roles"],"properties":{"require_scopes_for_all_roles":{"type":"boolean","example":"true"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"MetricJson":{"required":["duration","implemented_in_version","url","correlation_id","implemented_by_partial_function","user_id","developer_email","date","consumer_id","verb","app_name","user_name"],"properties":{"duration":{"type":"integer","format":"int64","example":"39"},"implemented_in_version":{"type":"string","example":"v210"},"url":{"type":"string","example":"www.openbankproject.com"},"correlation_id":{"type":"string","example":"v8ho6h5ivel3uq7a5zcnv0w1"},"implemented_by_partial_function":{"type":"string","example":"getBanks"},"user_id":{"type":"string","example":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"developer_email":{"type":"string","example":"felixsmith@example.com"},"date":{"type":"string","format":"date","example":"1100-01-01T00:00:00Z"},"consumer_id":{"type":"string","example":"123"},"verb":{"type":"string","example":"get"},"app_name":{"type":"string","example":"SOFI"},"user_name":{"type":"string","example":"OBP"}}},"HostedBy400":{"required":["organisation","email","phone","organisation_website"],"properties":{"organisation":{"type":"string","example":"String"},"email":{"type":"string","example":"String"},"phone":{"type":"string","example":"String"},"organisation_website":{"type":"string","example":"String"}}},"HostedAt400":{"required":["organisation","organisation_website"],"properties":{"organisation":{"type":"string","example":"Amazon"},"organisation_website":{"type":"string","example":"https://aws.amazon.com/"}}},"EnergySource400":{"required":["organisation","organisation_website"],"properties":{"organisation":{"type":"string","example":"Stromio"},"organisation_website":{"type":"string","example":"https://www.stromio.de/"}}}}}