{"resource_docs":[{"operation_id":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getBankLevelDynamicResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/resource-docs/API_VERSION/obp","summary":"Get Bank Level Dynamic Resource Docs","description":"<p>Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.</p>\n<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>\n<p>This endpoint is used by OBP API Explorer to display and work with the API documentation.</p>\n<p>Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)</p>\n<p>API_VERSION is the version you want documentation about e.g. v3.0.0</p>\n<p>You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank</p>\n<p>You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics</p>\n<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>\n<p>You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic<br />\nif 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>\n<p>You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN</p>\n<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>\n<p>You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123</p>\n<p>See the Resource Doc endpoint for more information.</p>\n<p>Following are more examples:<br />\n<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 />\n<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 />\n<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 />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN</a><br />\n<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 />\n<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><br />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653\">https://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653</a></p>\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n<p>Authentication is Mandatory</p>\n<p><strong>Parámetros URL</strong></p>\n<p><a href=\"/glossary#api_version\">API_VERSION</a>:</p>\n<p><a href=\"/glossary#Bank.bank_id\">BANK_ID</a>: gh.29.uk</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n<p><a href=\"/glossary#\"><strong>connector_methods</strong></a>: connector_methods</p>\n<p><a href=\"/glossary#description\"><strong>description</strong></a>: This an optional field. Maximum length is 2000. It can be any characters here.</p>\n<p><a href=\"/glossary#\"><strong>description_markdown</strong></a>: description_markdown</p>\n<p><a href=\"/glossary#\"><strong>error_response_bodies</strong></a>: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.</p>\n<p><a href=\"/glossary#\"><strong>example_request_body</strong></a>: {&quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#\"><strong>function</strong></a>: function</p>\n<p><a href=\"/glossary#\"><strong>implemented_by</strong></a>: implemented_by</p>\n<p><a href=\"/glossary#\"><strong>is_featured</strong></a>: false</p>\n<p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv4.0.0-getBanks</p>\n<p><a href=\"/glossary#\"><strong>request_url</strong></a>: /my_user/MY_USER_ID</p>\n<p><a href=\"/glossary#\"><strong>request_verb</strong></a>: POST</p>\n<p><a href=\"/glossary#\"><strong>resource_docs</strong></a>: resource_docs</p>\n<p><a href=\"/glossary#\"><strong>special_instructions</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>specified_url</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>success_response_body</strong></a>: {&quot;my_user_id&quot;: &quot;some_id_value&quot;, &quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#summary\"><strong>summary</strong></a>:</p>\n<p><a href=\"/glossary#tags\"><strong>tags</strong></a>: Create-My-User</p>\n<p><a href=\"/glossary#\"><strong>typed_request_body</strong></a>: typed_request_body</p>\n<p><a href=\"/glossary#\"><strong>typed_success_response_body</strong></a>: typed_success_response_body</p>\n<p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>\n<p><a href=\"/glossary#\">created_by_bank_id</a>: created_by_bank_id</p>\n<p><a href=\"/glossary#meta\">meta</a>:</p>\n<p><a href=\"/glossary#roles\">roles</a>: CanCreateMyUser</p>\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis 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.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n 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.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n 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.\n\n You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN\n \n 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. \n\n You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653\n\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n      \n\nAuthentication is Mandatory\n\n\n**Parámetros URL**\n\n[API_VERSION](/glossary#api_version): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n\n[**connector_methods**](/glossary#): connector_methods\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**description_markdown**](/glossary#): description_markdown\n\n\n\n[**error_response_bodies**](/glossary#): OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.\n\n\n\n[**example_request_body**](/glossary#): {\"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**function**](/glossary#): function\n\n\n\n[**implemented_by**](/glossary#): implemented_by\n\n\n\n[**is_featured**](/glossary#): false\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**request_url**](/glossary#): /my_user/MY_USER_ID\n\n\n\n[**request_verb**](/glossary#): POST\n\n\n\n[**resource_docs**](/glossary#): resource_docs\n\n\n\n[**special_instructions**](/glossary#): \n\n\n\n[**specified_url**](/glossary#): \n\n\n\n[**success_response_body**](/glossary#): {\"my_user_id\": \"some_id_value\", \"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**typed_request_body**](/glossary#): typed_request_body\n\n\n\n[**typed_success_response_body**](/glossary#): typed_success_response_body\n\n\n\n[**version**](/glossary#version): \n\n\n\n[created_by_bank_id](/glossary#): created_by_bank_id\n\n\n\n[meta](/glossary#meta): \n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"resource_docs":[{"operation_id":"OBPv1.4.0-testResourceDoc","implemented_by":{"version":"OBPv1.4.0","function":"testResourceDoc"},"request_verb":"GET","request_url":"/dummy","summary":"Test Resource Doc","description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"error_response_bodies":{"type":"array","items":{"type":"string"}},"description_markdown":{"type":"string"},"roles":{"type":"array","items":{"type":"object","properties":{"requires_bank_id":{"type":"boolean"}}}},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"roles":[{"role":"CanReadDynamicResourceDocsAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/resource-docs/API_VERSION/obp","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getBanks","implemented_by":{"version":"OBPv4.0.0","function":"getBanks"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks","summary":"Get Banks","description":"<p>Get banks on this API instance<br />\nReturns a list of banks supported on this server:</p>\n<ul>\n<li>ID used as parameter in URLs</li>\n<li>Short and full name of bank</li>\n<li>Logo URL</li>\n<li>Website</li>\n</ul>\n<p>Authentication is Optional</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n<p><a href=\"/glossary#address\"><strong>address</strong></a>:</p>\n<p><a href=\"/glossary#bank_routings\"><strong>bank_routings</strong></a>: bank routing in form of (scheme, address)</p>\n<p><a href=\"/glossary#banks\"><strong>banks</strong></a>:</p>\n<p><a href=\"/glossary#full_name\"><strong>full_name</strong></a>: full name string</p>\n<p><a href=\"/glossary#id\"><strong>id</strong></a>: d8839721-ad8f-45dd-9f78-2080414b93f9</p>\n<p><a href=\"/glossary#logo\"><strong>logo</strong></a>: logo url</p>\n<p><a href=\"/glossary#name\"><strong>name</strong></a>: ACCOUNT_MANAGEMENT_FEE</p>\n<p><a href=\"/glossary#scheme\"><strong>scheme</strong></a>: scheme value</p>\n<p><a href=\"/glossary#short_name\"><strong>short_name</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>value</strong></a>: 5987953</p>\n<p><a href=\"/glossary#website\"><strong>website</strong></a>: <a href=\"http://www.openbankproject.com\">www.openbankproject.com</a></p>\n<p><a href=\"/glossary#attributes\">attributes</a>: attribute value in form of (name, value)</p>\n","description_markdown":"Get banks on this API instance\nReturns a list of banks supported on this server:\n\n* ID used as parameter in URLs\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Optional\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): scheme value\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routings":[{"scheme":"scheme value","address":""}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"short_name":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"id":{"type":"string"},"full_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks","connector_methods":["obp.getBanks"]},{"operation_id":"OBPv4.0.0-root","implemented_by":{"version":"OBPv4.0.0","function":"root"},"request_verb":"GET","request_url":"/obp/v4.0.0/root","summary":"Get API Info (root)","description":"<p>Returns information about:</p>\n<ul>\n<li>API version</li>\n<li>Hosted by information</li>\n<li>Hosted at information</li>\n<li>Energy source information</li>\n<li>Git Commit</li>\n</ul>\n<p>Authentication is Optional</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n<p><a href=\"/glossary#Connector\"><strong>connector</strong></a>: connector</p>\n<p><a href=\"/glossary#\"><strong>email</strong></a>: <a href=\"&#109;&#97;&#x69;&#x6c;&#x74;&#111;:&#102;&#101;&#108;&#x69;&#120;&#x73;&#109;&#x69;&#116;h&#x40;&#x65;&#120;&#97;&#x6d;pl&#101;.&#x63;o&#109;\">&#102;e&#108;&#105;&#x78;&#115;&#x6d;&#105;&#116;&#104;&#x40;e&#x78;&#x61;&#109;&#x70;&#x6c;&#101;&#x2e;&#99;&#111;&#x6d;</a></p>\n<p><a href=\"/glossary#energy_source\"><strong>energy_source</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>git_commit</strong></a>: 59623811dd8a41f6ffe67be46954eee11913dc28</p>\n<p><a href=\"/glossary#hosted_at\"><strong>hosted_at</strong></a>:</p>\n<p><a href=\"/glossary#hosted_by\"><strong>hosted_by</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>hostname</strong></a>: hostname</p>\n<p><a href=\"/glossary#\"><strong>local_identity_provider</strong></a>: local_identity_provider</p>\n<p><a href=\"/glossary#organisation\"><strong>organisation</strong></a>:</p>\n<p><a href=\"/glossary#organisation_website\"><strong>organisation_website</strong></a>:</p>\n<p><a href=\"/glossary#phone\"><strong>phone</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>resource_docs_requires_role</strong></a>: resource_docs_requires_role</p>\n<p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>\n<p><a href=\"/glossary#version_status\"><strong>version_status</strong></a>:</p>\n","description_markdown":"Returns information about:\n\n* API version\n* Hosted by information\n* Hosted at information\n* Energy source information\n* Git Commit\n\nAuthentication is Optional\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n\n[**connector**](/glossary#Connector): connector\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**energy_source**](/glossary#energy_source): \n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n\n[**hosted_at**](/glossary#hosted_at): \n\n\n\n[**hosted_by**](/glossary#hosted_by): \n\n\n\n[**hostname**](/glossary#): hostname\n\n\n\n[**local_identity_provider**](/glossary#): local_identity_provider\n\n\n\n[**organisation**](/glossary#organisation): \n\n\n\n[**organisation_website**](/glossary#organisation_website): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**resource_docs_requires_role**](/glossary#): resource_docs_requires_role\n\n\n\n[**version**](/glossary#version): \n\n\n\n[**version_status**](/glossary#version_status): \n\n\n","success_response_body":{"version":"String","version_status":"String","git_commit":"String","connector":"String","hostname":"String","local_identity_provider":"String","hosted_by":{"organisation":"String","email":"String","phone":"String","organisation_website":"String"},"hosted_at":{"organisation":"Amazon","organisation_website":"https://aws.amazon.com/"},"energy_source":{"organisation":"Stromio","organisation_website":"https://www.stromio.de/"},"resource_docs_requires_role":false},"error_response_bodies":["OBP-50000: Unknown Error.","no connector set"],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"hosted_at":{"type":"object","properties":{"organisation_website":{"type":"string"},"organisation":{"type":"string"}}},"local_identity_provider":{"type":"string"},"git_commit":{"type":"string"},"hosted_by":{"type":"object","properties":{"organisation":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"organisation_website":{"type":"string"}}},"connector":{"type":"string"},"hostname":{"type":"string"},"resource_docs_requires_role":{"type":"boolean"},"version":{"type":"string"},"energy_source":{"type":"object","properties":{"organisation":{"type":"string"},"organisation_website":{"type":"string"}}},"version_status":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/root","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"<p>Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.</p>\n<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>\n<p>This endpoint is used by OBP API Explorer to display and work with the API documentation.</p>\n<p>Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)</p>\n<p>API_VERSION is the version you want documentation about e.g. v3.0.0</p>\n<p>You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank</p>\n<p>You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics</p>\n<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>\n<p>You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic<br />\nif 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>\n<p>You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN</p>\n<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>\n<p>You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123</p>\n<p>See the Resource Doc endpoint for more information.</p>\n<p>Following are more examples:<br />\n<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 />\n<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 />\n<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 />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN</a><br />\n<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 />\n<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><br />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653</a></p>\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n<p>Authentication is Mandatory</p>\n<p><strong>Parámetros URL</strong></p>\n<p><a href=\"/glossary#api_version\">API_VERSION</a>:</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n<p><a href=\"/glossary#\"><strong>connector_methods</strong></a>: connector_methods</p>\n<p><a href=\"/glossary#description\"><strong>description</strong></a>: This an optional field. Maximum length is 2000. It can be any characters here.</p>\n<p><a href=\"/glossary#\"><strong>description_markdown</strong></a>: description_markdown</p>\n<p><a href=\"/glossary#\"><strong>error_response_bodies</strong></a>: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.</p>\n<p><a href=\"/glossary#\"><strong>example_request_body</strong></a>: {&quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#\"><strong>function</strong></a>: function</p>\n<p><a href=\"/glossary#\"><strong>implemented_by</strong></a>: implemented_by</p>\n<p><a href=\"/glossary#\"><strong>is_featured</strong></a>: false</p>\n<p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv4.0.0-getBanks</p>\n<p><a href=\"/glossary#\"><strong>request_url</strong></a>: /my_user/MY_USER_ID</p>\n<p><a href=\"/glossary#\"><strong>request_verb</strong></a>: POST</p>\n<p><a href=\"/glossary#\"><strong>resource_docs</strong></a>: resource_docs</p>\n<p><a href=\"/glossary#\"><strong>special_instructions</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>specified_url</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>success_response_body</strong></a>: {&quot;my_user_id&quot;: &quot;some_id_value&quot;, &quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#summary\"><strong>summary</strong></a>:</p>\n<p><a href=\"/glossary#tags\"><strong>tags</strong></a>: Create-My-User</p>\n<p><a href=\"/glossary#\"><strong>typed_request_body</strong></a>: typed_request_body</p>\n<p><a href=\"/glossary#\"><strong>typed_success_response_body</strong></a>: typed_success_response_body</p>\n<p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>\n<p><a href=\"/glossary#\">created_by_bank_id</a>: created_by_bank_id</p>\n<p><a href=\"/glossary#meta\">meta</a>:</p>\n<p><a href=\"/glossary#roles\">roles</a>: CanCreateMyUser</p>\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis 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.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n 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.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n 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.\n\n You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN\n \n 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. \n\n You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\n\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n      \n\nAuthentication is Mandatory\n\n\n**Parámetros URL**\n\n[API_VERSION](/glossary#api_version): \n\n\n\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n\n[**connector_methods**](/glossary#): connector_methods\n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**description_markdown**](/glossary#): description_markdown\n\n\n\n[**error_response_bodies**](/glossary#): OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.\n\n\n\n[**example_request_body**](/glossary#): {\"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**function**](/glossary#): function\n\n\n\n[**implemented_by**](/glossary#): implemented_by\n\n\n\n[**is_featured**](/glossary#): false\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**request_url**](/glossary#): /my_user/MY_USER_ID\n\n\n\n[**request_verb**](/glossary#): POST\n\n\n\n[**resource_docs**](/glossary#): resource_docs\n\n\n\n[**special_instructions**](/glossary#): \n\n\n\n[**specified_url**](/glossary#): \n\n\n\n[**success_response_body**](/glossary#): {\"my_user_id\": \"some_id_value\", \"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**typed_request_body**](/glossary#): typed_request_body\n\n\n\n[**typed_success_response_body**](/glossary#): typed_success_response_body\n\n\n\n[**version**](/glossary#version): \n\n\n\n[created_by_bank_id](/glossary#): created_by_bank_id\n\n\n\n[meta](/glossary#meta): \n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"resource_docs":[{"operation_id":"OBPv1.4.0-testResourceDoc","implemented_by":{"version":"OBPv1.4.0","function":"testResourceDoc"},"request_verb":"GET","request_url":"/dummy","summary":"Test Resource Doc","description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"error_response_bodies":{"type":"array","items":{"type":"string"}},"description_markdown":{"type":"string"},"roles":{"type":"array","items":{"type":"object","properties":{"requires_bank_id":{"type":"boolean"}}}},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"roles":[{"role":"CanReadResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/resource-docs/API_VERSION/obp","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.4.0-getResourceDocsSwagger","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsSwagger"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/swagger","summary":"Get Swagger documentation","description":"<p>Returns documentation about the RESTful resources on this server in Swagger format.</p>\n<p>API_VERSION is the version you want documentation about e.g. v3.0.0</p>\n<p>You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank</p>\n<p>(All endpoints are given one or more tags which for used in grouping)</p>\n<p>You may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById</p>\n<p>(Each endpoint is implemented in the OBP Scala code by a 'function')</p>\n<p>See the Resource Doc endpoint for more information.</p>\n<p>Following are more examples:<br />\n<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 />\n<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 />\n<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 />\n<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>\n<p>Authentication is Optional</p>\n<p><strong>Parámetros URL</strong></p>\n<p><a href=\"/glossary#api_version\">API_VERSION</a>:</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n","description_markdown":"Returns documentation about the RESTful resources on this server in Swagger format.\n\nAPI_VERSION is the version you want documentation about e.g. v3.0.0\n\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank\n\n(All endpoints are given one or more tags which for used in grouping)\n\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById\n\n(Each endpoint is implemented in the OBP Scala code by a 'function')\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\nhttps://apisandbox.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById\n\n      \n\nAuthentication is Optional\n\n\n**Parámetros URL**\n\n[API_VERSION](/glossary#api_version): \n\n\n\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsObpV400","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObpV400"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"<p>Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.</p>\n<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>\n<p>This endpoint is used by OBP API Explorer to display and work with the API documentation.</p>\n<p>Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)</p>\n<p>API_VERSION is the version you want documentation about e.g. v3.0.0</p>\n<p>You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank</p>\n<p>You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics</p>\n<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>\n<p>You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic<br />\nif 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>\n<p>You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN</p>\n<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>\n<p>You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123</p>\n<p>See the Resource Doc endpoint for more information.</p>\n<p>Following are more examples:<br />\n<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 />\n<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 />\n<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 />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN</a><br />\n<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 />\n<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><br />\n<a href=\"https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\">https://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653</a></p>\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n<p>Authentication is Mandatory</p>\n<p><strong>Parámetros URL</strong></p>\n<p><a href=\"/glossary#api_version\">API_VERSION</a>:</p>\n<p><strong>Campos del cuerpo de la respuesta JSON</strong></p>\n<p><a href=\"/glossary#\"><strong>connector_methods</strong></a>: connector_methods</p>\n<p><a href=\"/glossary#count\"><strong>count</strong></a>:</p>\n<p><a href=\"/glossary#description\"><strong>description</strong></a>: This an optional field. Maximum length is 2000. It can be any characters here.</p>\n<p><a href=\"/glossary#\"><strong>description_markdown</strong></a>: description_markdown</p>\n<p><a href=\"/glossary#\"><strong>error_response_bodies</strong></a>: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.</p>\n<p><a href=\"/glossary#\"><strong>example_request_body</strong></a>: {&quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#\"><strong>function</strong></a>: function</p>\n<p><a href=\"/glossary#\"><strong>implemented_by</strong></a>: implemented_by</p>\n<p><a href=\"/glossary#\"><strong>is_featured</strong></a>: false</p>\n<p><a href=\"/glossary#\"><strong>operation_id</strong></a>: OBPv4.0.0-getBanks</p>\n<p><a href=\"/glossary#\"><strong>request_url</strong></a>: /my_user/MY_USER_ID</p>\n<p><a href=\"/glossary#\"><strong>request_verb</strong></a>: POST</p>\n<p><a href=\"/glossary#\"><strong>resource_docs</strong></a>: resource_docs</p>\n<p><a href=\"/glossary#\"><strong>response_date</strong></a>: response_date</p>\n<p><a href=\"/glossary#\"><strong>special_instructions</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>specified_url</strong></a>:</p>\n<p><a href=\"/glossary#\"><strong>success_response_body</strong></a>: {&quot;my_user_id&quot;: &quot;some_id_value&quot;, &quot;name&quot;: &quot;Jhon&quot;, &quot;age&quot;: 12, &quot;hobby&quot;: [&quot;coding&quot;],&quot;<em>optional_fields</em>&quot;: [&quot;hobby&quot;]}</p>\n<p><a href=\"/glossary#summary\"><strong>summary</strong></a>:</p>\n<p><a href=\"/glossary#tags\"><strong>tags</strong></a>: Create-My-User</p>\n<p><a href=\"/glossary#\"><strong>typed_request_body</strong></a>: typed_request_body</p>\n<p><a href=\"/glossary#\"><strong>typed_success_response_body</strong></a>: typed_success_response_body</p>\n<p><a href=\"/glossary#version\"><strong>version</strong></a>:</p>\n<p><a href=\"/glossary#\">created_by_bank_id</a>: created_by_bank_id</p>\n<p><a href=\"/glossary#meta\">meta</a>:</p>\n<p><a href=\"/glossary#roles\">roles</a>: CanCreateMyUser</p>\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis 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.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n 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.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n 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.\n\n You may need some other language resource docs, now we support i18n language tag , e.g. ?locale=zh_CN\n \n 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. \n\n You can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://apisandbox.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\n\n<ul>\n<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>\n<li> version references the version that the API call is defined in.</li>\n<li> function is the (scala) partial function that implements this endpoint. It is unique per version of the API.</li>\n<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>\n<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>\n<li> summary is a short description inline with the swagger terminology. </li>\n<li> description may contain html markup (generated from markdown on the server).</li>\n</ul>\n      \n\nAuthentication is Mandatory\n\n\n**Parámetros URL**\n\n[API_VERSION](/glossary#api_version): \n\n\n\n\n\n**Campos del cuerpo de la respuesta JSON**\n\n\n\n[**connector_methods**](/glossary#): connector_methods\n\n\n\n[**count**](/glossary#count): \n\n\n\n[**description**](/glossary#description): This an optional field. Maximum length is 2000. It can be any characters here.\n\n\n\n[**description_markdown**](/glossary#): description_markdown\n\n\n\n[**error_response_bodies**](/glossary#): OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format.\n\n\n\n[**example_request_body**](/glossary#): {\"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**function**](/glossary#): function\n\n\n\n[**implemented_by**](/glossary#): implemented_by\n\n\n\n[**is_featured**](/glossary#): false\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**request_url**](/glossary#): /my_user/MY_USER_ID\n\n\n\n[**request_verb**](/glossary#): POST\n\n\n\n[**resource_docs**](/glossary#): resource_docs\n\n\n\n[**response_date**](/glossary#): response_date\n\n\n\n[**special_instructions**](/glossary#): \n\n\n\n[**specified_url**](/glossary#): \n\n\n\n[**success_response_body**](/glossary#): {\"my_user_id\": \"some_id_value\", \"name\": \"Jhon\", \"age\": 12, \"hobby\": [\"coding\"],\"_optional_fields_\": [\"hobby\"]}\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**typed_request_body**](/glossary#): typed_request_body\n\n\n\n[**typed_success_response_body**](/glossary#): typed_success_response_body\n\n\n\n[**version**](/glossary#version): \n\n\n\n[created_by_bank_id](/glossary#): created_by_bank_id\n\n\n\n[meta](/glossary#meta): \n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"resource_docs":[{"operation_id":"OBPv1.4.0-testResourceDoc","implemented_by":{"version":"OBPv1.4.0","function":"testResourceDoc"},"request_verb":"GET","request_url":"/dummy","summary":"Test Resource Doc","description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n","description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"","connector_methods":[]}],"meta":{"response_date":"2025-11-29T05:01:43Z","count":1}},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"resource_docs":{"type":"array","items":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"request_url":{"type":"string"},"specified_url":{"type":"string"},"implemented_by":{"type":"object","properties":{"version":{"type":"string"},"function":{"type":"string"}}},"operation_id":{"type":"string"},"is_featured":{"type":"boolean"},"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"request_verb":{"type":"string"},"connector_methods":{"type":"object","properties":{}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"jsonString":{"type":"object","properties":{"type":{"type":"string"}}}}}}},"special_instructions":{"type":"string"},"error_response_bodies":{"type":"array","items":{"type":"string"}},"description_markdown":{"type":"string"},"roles":{"type":"array","items":{"type":"object","properties":{"requires_bank_id":{"type":"boolean"}}}},"example_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"response_date":{"type":"string","format":"date-time"},"count":{"type":"integer"}}}}},"roles":[{"role":"CanReadResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/resource-docs/API_VERSION/obp","connector_methods":["obp.getBankAccountsForUser"]}]}