{"resource_docs":[{"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":"
Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\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.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor 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.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\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.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou 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.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following 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=es_ES
\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
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nconnector_methods: connector_methods
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: 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.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\nresource_docs: resource_docs
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\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 en_GB and es_ES at the moment.\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\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\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=es_ES\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\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\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/v1.4.0/resource-docs/API_VERSION/obp","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":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\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.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor 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.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\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.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou 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.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following 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=es_ES
\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
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nconnector_methods: connector_methods
\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: 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.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\nresource_docs: resource_docs
\nresponse_date: response_date
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\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 en_GB and es_ES at the moment.\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\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\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=es_ES\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\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\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":"2024-03-26T11:02:52Z","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":{"meta":{"type":"object","properties":{"count":{"type":"integer"},"response_date":{"type":"string","format":"date-time"}}},"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/v1.4.0/resource-docs/API_VERSION/obp","connector_methods":[]},{"operation_id":"OBPv3.1.0-getMessageDocsSwagger","implemented_by":{"version":"OBPv3.1.0","function":"getMessageDocsSwagger"},"request_verb":"GET","request_url":"/obp/v3.1.0/message-docs/CONNECTOR/swagger2.0","summary":"Get Message Docs Swagger","description":"This endpoint provides example message docs in swagger format.
\nIt is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
\nThat 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.
i.e.:
\nOBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
\nAuthentication is Optional
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nprocess: obp.getBank
\n\n\n\n\n\n\nrequiredFieldInfo: false
\n","description_markdown":"This endpoint provides example message docs in swagger format.\nIt is only relavent for REST Connectors.\n\nThis endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).\nThat 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.\n\ni.e.:\n\nOBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)\n\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[CONNECTOR](/glossary#Connector): CONNECTOR\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**adapter_implementation**](/glossary#adapter_implementation): \n\n\n\n[**dependent_endpoints**](/glossary#dependent_endpoints): \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[**example_inbound_message**](/glossary#example_inbound_message): {}\n\n\n\n[**example_outbound_message**](/glossary#example_outbound_message): {}\n\n\n\n[**group**](/glossary#group): \n\n\n\n[**message_docs**](/glossary#message_docs): \n\n\n\n[**message_format**](/glossary#message_format): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n\n[**suggested_order**](/glossary#suggested_order): \n\n\n\n[**version**](/glossary#version): \n\n\n\n[inboundAvroSchema](/glossary#inboundavroschema): \n\n\n\n[inbound_topic](/glossary#inbound_topic): \n\n\n\n[outboundAvroSchema](/glossary#outboundavroschema): \n\n\n\n[outbound_topic](/glossary#outbound_topic): \n\n\n\n[requiredFieldInfo](/glossary#requiredfieldinfo): false\n\n\n","success_response_body":{"message_docs":[{"process":"getAccounts","message_format":"KafkaV2017","outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts","inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts","description":"get Banks","example_outbound_message":{"jsonString":"{}"},"example_inbound_message":{"jsonString":"{}"},"outboundAvroSchema":{"jsonString":"{}"},"inboundAvroSchema":{"jsonString":"{}"},"adapter_implementation":{"group":"CORE","suggested_order":3},"dependent_endpoints":[{"name":"getAccounts","version":"OBPv3.0.0"},{"name":"getBalances","version":"OBPv2.0.0"}],"requiredFieldInfo":{"data.bankId":["v2.2.0","v3.1.0"]}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_success_response_body":{"type":"object","properties":{"message_docs":{"type":"array","items":{"type":"object","properties":{"dependent_endpoints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}},"inbound_topic":{"type":"string"},"message_format":{"type":"string"},"outbound_topic":{"type":"string"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"adapter_implementation":{"type":"object","properties":{"group":{"type":"string"},"suggested_order":{"type":"integer"}}},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"type":"string"}}}},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}},"process":{"type":"string"},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"description":{"type":"string"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/message-docs/CONNECTOR/swagger2.0","connector_methods":[]},{"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":"Returns documentation about the RESTful resources on this server in Swagger format.
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
\n(All endpoints are given one or more tags which for used in grouping)
\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
\n(Each endpoint is implemented in the OBP Scala code by a 'function')
\nSee the Resource Doc endpoint for more information.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\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
Authentication is Optional
\nURL Parameters:
\n\nJSON response body fields:
\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\n Note: Resource Docs are cached, TTL is 3600 seconds\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**URL Parameters:**\n\n[API_VERSION](/glossary#api_version): \n\n\n\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."],"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/v1.4.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv2.2.0-getMessageDocs","implemented_by":{"version":"OBPv2.2.0","function":"getMessageDocs"},"request_verb":"GET","request_url":"/obp/v2.2.0/message-docs/CONNECTOR","summary":"Get Message Docs","description":"These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
\nIntegrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
\nCONNECTOR
: kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n\n\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\n\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nprocess: obp.getBank
\n\n\n\n\n\n\nrequiredFieldInfo: false
\n","description_markdown":"These message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.\n Integrators can use these messages to build Adapters that provide core banking services to OBP.\n\n Note: API Explorer provides a Message Docs page where these messages are displayed.\n \n `CONNECTOR`: kafka_vSept2018, stored_procedure_vDec2019 ...\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[CONNECTOR](/glossary#Connector): CONNECTOR\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**adapter_implementation**](/glossary#adapter_implementation): \n\n\n\n[**dependent_endpoints**](/glossary#dependent_endpoints): \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[**example_inbound_message**](/glossary#example_inbound_message): {}\n\n\n\n[**example_outbound_message**](/glossary#example_outbound_message): {}\n\n\n\n[**group**](/glossary#group): \n\n\n\n[**message_docs**](/glossary#message_docs): \n\n\n\n[**message_format**](/glossary#message_format): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n\n[**suggested_order**](/glossary#suggested_order): \n\n\n\n[**version**](/glossary#version): \n\n\n\n[inboundAvroSchema](/glossary#inboundavroschema): \n\n\n\n[inbound_topic](/glossary#inbound_topic): \n\n\n\n[outboundAvroSchema](/glossary#outboundavroschema): \n\n\n\n[outbound_topic](/glossary#outbound_topic): \n\n\n\n[requiredFieldInfo](/glossary#requiredfieldinfo): false\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"message_docs":[{"process":"getAccounts","message_format":"KafkaV2017","outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts","inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts","description":"get Banks","example_outbound_message":{"jsonString":"{}"},"example_inbound_message":{"jsonString":"{}"},"outboundAvroSchema":{"jsonString":"{}"},"inboundAvroSchema":{"jsonString":"{}"},"adapter_implementation":{"group":"CORE","suggested_order":3},"dependent_endpoints":[{"name":"getAccounts","version":"OBPv3.0.0"},{"name":"getBalances","version":"OBPv2.0.0"}],"requiredFieldInfo":{"data.bankId":["v2.2.0","v3.1.0"]}}]},"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":{"message_docs":{"type":"array","items":{"type":"object","properties":{"dependent_endpoints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}}}},"inbound_topic":{"type":"string"},"message_format":{"type":"string"},"outbound_topic":{"type":"string"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"adapter_implementation":{"type":"object","properties":{"group":{"type":"string"},"suggested_order":{"type":"integer"}}},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"type":"string"}}}},"example_inbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}},"process":{"type":"string"},"inboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"description":{"type":"string"},"example_outbound_message":{"type":"object","properties":{"jsonString":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/message-docs/CONNECTOR","connector_methods":[]},{"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":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\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.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor 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.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\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.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou 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.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following 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=es_ES
\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
Authentication is Mandatory
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nconnector_methods: connector_methods
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\ndescription_markdown: description_markdown
\nerror_response_bodies: 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.
\nexample_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\nfunction: function
\nimplemented_by: implemented_by
\nis_featured: false
\noperation_id: OBPv4.0.0-getBanks
\nrequest_url: /my_user/MY_USER_ID
\nrequest_verb: POST
\nresource_docs: resource_docs
\n\n\nsuccess_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
\n\ntags: Create-My-User
\ntyped_request_body: typed_request_body
\ntyped_success_response_body: typed_success_response_body
\n\ncreated_by_bank_id: created_by_bank_id
\nmeta:
\nroles: CanCreateMyUser
\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 en_GB and es_ES at the moment.\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\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\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=es_ES\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\n\nI am only a test Resource Doc
\nAuthentication is Mandatory
\nJSON response body fields:
\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/v1.4.0/banks/BANK_ID/resource-docs/API_VERSION/obp","connector_methods":[]},{"operation_id":"OBPv3.0.0-getApiGlossary","implemented_by":{"version":"OBPv3.0.0","function":"getApiGlossary"},"request_verb":"GET","request_url":"/obp/v3.0.0/api/glossary","summary":"Get Glossary of the API","description":"Get API Glossary
\nReturns the glossary of the API
\nAuthentication is Optional
\nJSON response body fields:
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\n\nhtml: html format content
\n\ntitle: Dr.
\n","description_markdown":"Get API Glossary\n\nReturns the glossary of the API\n\n\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\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[**glossary_items**](/glossary#glossary_items): \n\n\n\n[**html**](/glossary#html): html format content\n\n\n\n[**markdown**](/glossary#markdown): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n","success_response_body":{"glossary_items":[{"title":"Dr.","description":{"markdown":"String","html":"String"}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation"],"typed_success_response_body":{"type":"object","properties":{"glossary_items":{"type":"array","items":{"type":"object","properties":{"description":{"type":"object","properties":{"html":{"type":"string"},"markdown":{"type":"string"}}},"title":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/api/glossary","connector_methods":[]},{"operation_id":"OBPv4.0.0-getScannedApiVersions","implemented_by":{"version":"OBPv4.0.0","function":"getScannedApiVersions"},"request_verb":"GET","request_url":"/obp/v4.0.0/api/versions","summary":"Get scanned API Versions","description":"Get all the scanned API Versions.
\nAuthentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get all the scanned API Versions.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"scanned_api_versions":[{"urlPrefix":"obp","apiStandard":"obp","apiShortVersion":"v3.1.0","API_VERSION":"v3.1.0"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_success_response_body":{"type":"object","properties":{"scanned_api_versions":{"type":"array","items":{"type":"object","properties":{"urlPrefix":{"type":"string"},"apiStandard":{"type":"string"},"apiShortVersion":{"type":"string"},"API_VERSION":{"type":"string"}}}}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/api/versions","connector_methods":[]}]}