{"resource_docs":[{"operation_id":"OBPv4.0.0-deleteMyDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyDynamicEntity"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Delete My Dynamic Entity","description":"
Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":["obp.dynamicEntityProcess"]},{"operation_id":"OBPv4.0.0-createBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelDynamicEntity"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities","summary":"Create Bank Level Dynamic Entity","description":"Create a Bank Level DynamicEntity.
\nAuthentication is Mandatory
\nCreate a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
The DATE_WITH_DAY format is: yyyy-MM-dd
\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.
"someField0": {\n "type": "reference:Bank",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&branchId=266ab8c0-e2a2-474b-8024-be4a70a04bc4"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&atmId=266ab8c0-e2a2-474b-8024-be4a70a04bc4"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&accountId=266ab8c0-e2a2-474b-8024-be4a70a04bc4"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&productCode=266ab8c0-e2a2-474b-8024-be4a70a04bc4"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&cardId=266ab8c0-e2a2-474b-8024-be4a70a04bc4"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&accountId=266ab8c0-e2a2-474b-8024-be4a70a04bc4&transactionId=b58cf5d2-627e-4e19-bd5e-5cc707c01381"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=5aff7bd4-d18b-42c5-ad2e-d3a2965c3dcf&accountId=266ab8c0-e2a2-474b-8024-be4a70a04bc4&counterpartyId=b58cf5d2-627e-4e19-bd5e-5cc707c01381"\n}\n\n
\nNote: if you set hasPersonalEntity
= false, then OBP will not generate the CRUD my FooBar endpoints.
Get all JSON Schema Validations - public.
\nAuthentication is Optional
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv4.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","description_markdown":"Get all JSON Schema Validations - public.\n\n\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**json_schema**](/glossary#): json_schema\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n","success_response_body":{"json_schema_validations":[{"operation_id":"OBPv4.0.0-createXxx","json_schema":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true}}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["JSON-Schema-Validation"],"typed_success_response_body":{"type":"object","properties":{"json_schema_validations":{"type":"array","items":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/endpoints/json-schema-validations","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDynamicEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getDynamicEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-endpoints","summary":" Get Dynamic Endpoints","description":"Get Dynamic Endpoints.
\nAuthentication is Mandatory
\n","description_markdown":"Get Dynamic Endpoints.\n\n\n\nAuthentication is Mandatory","success_response_body":{"dynamic_endpoints":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetDynamicEndpoints","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-endpoints","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateMethodRouting","implemented_by":{"version":"OBPv3.1.0","function":"updateMethodRouting"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","summary":"Update MethodRouting","description":"Update a MethodRouting.
\nAuthentication is Mandatory
\nExplaination of Fields:
\nif bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\\d+"
\nIf connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
URL Parameters:
\n\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","description_markdown":"Update a MethodRouting.\n\n\nAuthentication is Mandatory\n\nExplaination of Fields:\n\n* method_name is required String value, current supported value: [mapped]\n* connector_name is required String value\n* is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false\n* bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex\n* parameters is optional array of key value pairs. You can set some paremeters for this method\nnote:\n\n* if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = \"some\\-id_pattern_\\d+\"\n\nIf connector name start with rest, parameters can contain \"outBoundMapping\" and \"inBoundMapping\", to convert OutBound and InBound json structure.\nfor example:\n outBoundMapping example, convert json from source to target:\n![Snipaste_outBoundMapping](https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png)\nBuild OutBound json value rules:\n1 set cId value with: outboundAdapterCallContext.correlationId value\n2 set bankId value with: concat bankId.value value with string helloworld\n3 set originalJson value with: whole source json, note: the field value expression is $root\n\n\n inBoundMapping example, convert json from source to target:\n![inBoundMapping](https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png)\nBuild InBound json value rules:\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with \"$default\", remove \"$default\" from field name, not change the value\n3 set fullName value with: concat string full: with result.name value\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].\n\n\n**URL Parameters:**\n\n[METHOD_ROUTING_ID](/glossary#method_routing_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**parameters**](/glossary#parameters): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"is_bank_id_exact_match":true,"method_name":"getBank","connector_name":"rest_vMar2019","bank_id_pattern":"some_bankId","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"success_response_body":{"is_bank_id_exact_match":true,"method_name":"getBank","connector_name":"rest_vMar2019","method_routing_id":"this-method-routing-Id","bank_id_pattern":"some_bankId","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-10021: Incorrect Connector name.","OBP-10022: Incorrect Connector method name.","OBP-50000: Unknown Error."],"tags":["Method-Routing","API"],"typed_request_body":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"connector_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}},"roles":[{"role":"CanUpdateMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-updateJsonSchemaValidation","implemented_by":{"version":"OBPv4.0.0","function":"updateJsonSchemaValidation"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/json-schema-validations/OPERATION_ID","summary":"Update a JSON Schema Validation","description":"Update a JSON Schema Validation.
\nPlease supply a json-schema as request body
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv4.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","description_markdown":"Update a JSON Schema Validation.\n\nPlease supply a json-schema as request body\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**json_schema**](/glossary#): json_schema\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n","example_request_body":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true},"success_response_body":{"operation_id":"OBPv4.0.0-createXxx","json_schema":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["JSON-Schema-Validation"],"typed_request_body":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}},"roles":[{"role":"CanUpdateJsonSchemaValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/json-schema-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"getDynamicEndpoint"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","summary":"Get Dynamic Endpoint","description":"Get a Dynamic Endpoint.
\nGet one DynamicEndpoint,
\nAuthentication is Mandatory
\n","description_markdown":"Get a Dynamic Endpoint.\n\n\nGet one DynamicEndpoint,\n\n\n\nAuthentication is Mandatory","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"roles":[{"role":"CanGetDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getApiCollectionEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getApiCollectionEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints","summary":"Get Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nAuthentication is Optional
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_ID.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/api-collections/API_COLLECTION_ID/api-collection-endpoints","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 i18n language tag , e.g. ?locale=zh_CN
\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.
\nYou can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123
\nSee the Resource Doc endpoint for more information.
\nFollowing are more examples:
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653
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 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://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://api3.openbankproject.com/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?cache-modifier=3141592653\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/v5.1.0/banks/BANK_ID/resource-docs/API_VERSION/obp","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getMyApiCollectionById","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionById"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","summary":"Get My Api Collection By Id","description":"Get Api Collection By API_COLLECTION_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collection By API_COLLECTION_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-createMethodRouting","implemented_by":{"version":"OBPv3.1.0","function":"createMethodRouting"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/method_routings","summary":"Create MethodRouting","description":"Create a MethodRouting.
\nAuthentication is Mandatory
\nExplanation of Fields:
\nnote and CAVEAT!:
\nIf the connector name starts with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
JSON request body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","description_markdown":"Create a MethodRouting.\n\n\nAuthentication is Mandatory\n\nExplanation of Fields:\n\n* method_name is required String value, current supported value: [mapped]\n* connector_name is required String value\n* is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false\n* bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex\n* parameters is optional array of key value pairs. You can set some parameters for this method\n\nnote and CAVEAT!:\n\n* bank_id_pattern has to be empty for methods that do not take bank_id as a function parameter, otherwise might get empty result\n* methods that aggregate bank objects (e.g. getBankAccountsForUser) have to take any existing method routings for these objects into consideration\n* so if you create e.g. a bank specific method routing for getting an account, make sure that it is also served by endpoints getting ALL accounts for ALL banks\n* if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = \"some\\-id_pattern_\\d+\"\n\nIf the connector name starts with rest, parameters can contain \"outBoundMapping\" and \"inBoundMapping\", convert OutBound and InBound json structure.\nfor example:\n outBoundMapping example, convert json from source to target:\n![Snipaste_outBoundMapping](https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png)\nBuild OutBound json value rules:\n1 set cId value with: outboundAdapterCallContext.correlationId value\n2 set bankId value with: concat bankId.value value with string helloworld\n3 set originalJson value with: whole source json, note: the field value expression is $root\n\n\n inBoundMapping example, convert json from source to target:\n![inBoundMapping](https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png)\nBuild InBound json value rules:\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with \"$default\", remove \"$default\" from field name, not change the value\n3 set fullName value with: concat string full: with result.name value\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].\n\n\n**JSON request body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**parameters**](/glossary#parameters): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**parameters**](/glossary#parameters): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"is_bank_id_exact_match":false,"method_name":"getBank","connector_name":"rest_vMar2019","bank_id_pattern":"some_bankId_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"success_response_body":{"is_bank_id_exact_match":false,"method_name":"getBank","connector_name":"rest_vMar2019","method_routing_id":"this-method-routing-Id","bank_id_pattern":"some_bankId_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-10021: Incorrect Connector name.","OBP-10022: Incorrect Connector method name.","OBP-50000: Unknown Error."],"tags":["Method-Routing","API"],"typed_request_body":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"connector_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}},"roles":[{"role":"CanCreateMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/method_routings","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getAllConnectorMethods","implemented_by":{"version":"OBPv4.0.0","function":"getAllConnectorMethods"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/connector-methods","summary":"Get all Connector Methods","description":"Get all Connector Methods.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Get all Connector Methods.\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"connectors_methods":[{"connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51","method_name":"getBank","method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Connector-Method"],"typed_success_response_body":{"type":"object","properties":{"connectors_methods":{"type":"array","items":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllConnectorMethods","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/connector-methods","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateSystemDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"updateSystemDynamicEntity"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Update System Level Dynamic Entity","description":"Update a System Level Dynamic Entity.
\nAuthentication is Mandatory
\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.
"someField0": {\n "type": "reference:Bank",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "0564135c-ec42-4d83-ae31-73433547e7ab"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&branchId=36f0442d-da5e-4e7d-91c2-e31d810d01d7"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&atmId=36f0442d-da5e-4e7d-91c2-e31d810d01d7"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&productCode=36f0442d-da5e-4e7d-91c2-e31d810d01d7"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&cardId=36f0442d-da5e-4e7d-91c2-e31d810d01d7"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7&transactionId=240e90d0-b866-4d18-9abe-12628b3024d3"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7&counterpartyId=240e90d0-b866-4d18-9abe-12628b3024d3"\n}\n\n
\n","description_markdown":"Update a System Level Dynamic Entity.\n\n\nAuthentication is Mandatory\n\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nThe following field types are as supported:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.\n```\n\"someField0\": {\n \"type\": \"reference:Bank\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField1\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField2\": {\n \"type\": \"reference:Customer\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField3\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField4\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField5\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField6\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField7\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField8\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField9\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField10\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField11\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField12\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"0564135c-ec42-4d83-ae31-73433547e7ab\"\n}\n\n\"someField13\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&branchId=36f0442d-da5e-4e7d-91c2-e31d810d01d7\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&atmId=36f0442d-da5e-4e7d-91c2-e31d810d01d7\"\n}\n\n\"someField15\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&productCode=36f0442d-da5e-4e7d-91c2-e31d810d01d7\"\n}\n\n\"someField17\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&cardId=36f0442d-da5e-4e7d-91c2-e31d810d01d7\"\n}\n\n\"someField18\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7&transactionId=240e90d0-b866-4d18-9abe-12628b3024d3\"\n}\n\n\"someField19\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=0564135c-ec42-4d83-ae31-73433547e7ab&accountId=36f0442d-da5e-4e7d-91c2-e31d810d01d7&counterpartyId=240e90d0-b866-4d18-9abe-12628b3024d3\"\n}\n\n```","example_request_body":{"FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"hasPersonalEntity":true},"success_response_body":{"FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"roles":[{"role":"CanUpdateSystemLevelDynamicEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-getAdapterInfoForBank","implemented_by":{"version":"OBPv3.0.0","function":"getAdapterInfoForBank"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/adapter","summary":"Get Adapter Info for a bank","description":"Get basic information about the Adapter listening on behalf of this bank.
\nAuthentication is Optional
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","description_markdown":"Get basic information about the Adapter listening on behalf of this bank.\n\nAuthentication is Optional\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**version**](/glossary#version): \n\n\n","success_response_body":{"name":"String","version":"String","git_commit":"String","date":"2013-01-21T23:08:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"git_commit":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}},"roles":[{"role":"CanGetAdapterInfoAtOneBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/adapter","connector_methods":["obp.getAdapterInfo","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteSystemLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"deleteSystemLevelEndpointTag"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","summary":"Delete System Level Endpoint Tag","description":"Delete System Level Endpoint Tag.
\nAuthentication is Mandatory
\nURL Parameters:
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete System Level Endpoint Tag.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ENDPOINT_TAG_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"roles":[{"role":"CanDeleteSystemLevelEndpointTag","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","connector_methods":["obp.deleteEndpointTag","obp.getEndpointTagById"]},{"operation_id":"OBPv2.2.0-getConnectorMetrics","implemented_by":{"version":"OBPv2.2.0","function":"getConnectorMetrics"},"request_verb":"GET","request_url":"/obp/v2.2.0/management/connector/metrics","summary":"Get Connector Metrics","description":"Get the all metrics
\nrequire CanGetConnectorMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 1000) eg:limit=2000
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300
\nOther filters:
\n5 connector_name (if null ignore)
\n6 function_name (if null ignore)
\n7 correlation_id (if null ignore)
\nAuthentication is Mandatory
\nJSON response body fields:
\n\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nduration: 5.123
\n\n\n","description_markdown":"Get the all metrics\n\nrequire CanGetConnectorMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/connector/metrics\n\nShould be able to filter on the following metrics fields\n\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2\n\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 limit (for pagination: defaults to 1000) eg:limit=2000\n\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\neg: /management/connector/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=100&offset=300\n\nOther filters:\n\n5 connector_name (if null ignore)\n\n6 function_name (if null ignore)\n\n7 correlation_id (if null ignore)\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**connector_name**](/glossary#connector_name): \n\n\n\n[**correlation_id**](/glossary#): 1flssoftxq0cr1nssr68u0mioj\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**duration**](/glossary#duration): 5.123\n\n\n\n[**function_name**](/glossary#function_name): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"metrics":[{"connector_name":"mapper","function_name":"getBanks","correlation_id":"12345","date":"1100-01-01T00:00:00Z","duration":1000}]},"error_response_bodies":["OBP-10005: Invalid Date Format. Could not convert value to a Date.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"connector_name":{"type":"string"},"duration":{"type":"integer"},"date":{"type":"string","format":"date-time"},"correlation_id":{"type":"string"},"function_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetConnectorMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/connector/metrics","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-updateBankLevelDynamicEndpointHost","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelDynamicEndpointHost"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host","summary":" Update Bank Level Dynamic Endpoint Host","description":"Update Bank Level dynamic endpoint Host.
\nThe value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
\n","description_markdown":"Update Bank Level dynamic endpoint Host.\nThe value can be obp_mock, dynamic_entity, or some service url.\n\n\nAuthentication is Mandatory","example_request_body":{"host":"dynamic_entity"},"success_response_body":{"host":"dynamic_entity"},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_request_body":{"type":"object","properties":{"host":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"host":{"type":"string"}}},"roles":[{"role":"CanUpdateBankLevelDynamicEndpoint","requires_bank_id":true},{"role":"CanUpdateDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSystemLevelEndpointTags","implemented_by":{"version":"OBPv4.0.0","function":"getSystemLevelEndpointTags"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/endpoints/OPERATION_ID/tags","summary":"Get System Level Endpoint Tags","description":"Get System Level Endpoint Tags.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Get System Level Endpoint Tags.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","success_response_body":[{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"}],"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"tl":{"type":"object","properties":{}},"head":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}},"roles":[{"role":"CanGetSystemLevelEndpointTag","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags","connector_methods":["obp.getSystemLevelEndpointTags"]},{"operation_id":"OBPv4.0.0-getMapperDatabaseInfo","implemented_by":{"version":"OBPv4.0.0","function":"getMapperDatabaseInfo"},"request_verb":"GET","request_url":"/obp/v4.0.0/database/info","summary":"Get Mapper Database Info","description":"Get basic information about the Mapper Database.
\nAuthentication is Mandatory
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n","description_markdown":"Get basic information about the Mapper Database.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**version**](/glossary#version): \n\n\n","success_response_body":{"name":"String","version":"String","git_commit":"String","date":"2013-01-21T23:08:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"git_commit":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}}},"roles":[{"role":"CanGetDatabaseInfo","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/database/info","connector_methods":[]},{"operation_id":"OBPv3.1.0-getMetricsTopConsumers","implemented_by":{"version":"OBPv3.1.0","function":"getMetricsTopConsumers"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/metrics/top-consumers","summary":"Get Top Consumers","description":"Get metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.
\nShould be able to filter on the following fields
\ne.g.: /management/metrics/top-consumers?from_date=1970-01-01T00:00:00.000Z&to_date=2024-03-29T00:00:40.426Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n&limit=100
1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z
\n2 to_date (defaults to the current date) eg:to_date=2024-03-29T00:00:40.426Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\n16 limit (for pagination: defaults to 50) eg:limit=200
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\n","description_markdown":"Get metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.\n\nShould be able to filter on the following fields\n\ne.g.: /management/metrics/top-consumers?from_date=1970-01-01T00:00:00.000Z&to_date=2024-03-29T00:00:40.426Z&consumer_id=5\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions\n&verb=GET&anon=false&app_name=MapperPostman\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n&limit=100\n\n1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z\n\n2 to_date (defaults to the current date) eg:to_date=2024-03-29T00:00:40.426Z\n\n3 consumer_id (if null ignore)\n\n4 user_id (if null ignore)\n\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n6 url (if null ignore), note: can not contain '&'.\n\n7 app_name (if null ignore)\n\n8 implemented_by_partial_function (if null ignore),\n\n9 implemented_in_version (if null ignore)\n\n10 verb (if null ignore)\n\n11 correlation_id (if null ignore)\n\n12 duration (if null ignore) non digit chars will be silently omitted\n\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%\n\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics\n\n16 limit (for pagination: defaults to 50) eg:limit=200\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**count**](/glossary#count): \n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**top_consumers**](/glossary#top_consumers): \n\n\n","success_response_body":{"top_consumers":[{"count":7076,"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","app_name":"Api Explorer","developer_email":"felixsmith@example.com"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10016: Incorrect filter Parameters in URL. ","OBP-30045: Could not get the top consumers from database. ","OBP-50000: Unknown Error."],"tags":["Metric"],"typed_success_response_body":{"type":"object","properties":{"top_consumers":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"app_name":{"type":"string"}}}}}},"roles":[{"role":"CanReadMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/metrics/top-consumers","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-createMyApiCollectionEndpointById","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollectionEndpointById"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","summary":"Create My Api Collection Endpoint By Id","description":"Create Api Collection Endpoint By Id.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\noperation_id: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Create Api Collection Endpoint By Id.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-getBanks"},"success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAuthenticationTypeValidation","implemented_by":{"version":"OBPv4.0.0","function":"getAuthenticationTypeValidation"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/authentication-type-validations/OPERATION_ID","summary":"Get an Authentication Type Validation","description":"Get an Authentication Type Validation by operation_id.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"Get an Authentication Type Validation by operation_id.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"operation_id":"OBPv4.0.0-updateXxx","allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Authentication-Type-Validation"],"typed_success_response_body":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}},"roles":[{"role":"CanGetAuthenticationTypeValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/authentication-type-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpointByOperationId","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpointByOperationId"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints/OPERATION_ID","summary":"Delete My Api Collection Endpoint By Id","description":"Delete Api Collection Endpoint By OPERATION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete Api Collection Endpoint By OPERATION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-root","implemented_by":{"version":"OBPv5.1.0","function":"root"},"request_verb":"GET","request_url":"/obp/v5.1.0/root","summary":"Get API Info (root)","description":"Returns information about:
\nAuthentication is Optional
\nJSON response body fields:
\nconnector: connector
\n\n\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\n\n\nhostname: hostname
\nlocal_identity_provider: local_identity_provider
\n\n\n\nresource_docs_requires_role: resource_docs_requires_role
\n\n\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**JSON response body fields:**\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.1.0/root","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"},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"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"}}},"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/v5.1.0/message-docs/CONNECTOR/swagger2.0","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-endpoints","summary":"Get Bank Level Dynamic Endpoints","description":"Get Bank Level Dynamic Endpoints.
\nAuthentication is Mandatory
\n","description_markdown":"Get Bank Level Dynamic Endpoints.\n\n\n\nAuthentication is Mandatory","success_response_body":{"dynamic_endpoints":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetBankLevelDynamicEndpoints","requires_bank_id":true},{"role":"CanGetDynamicEndpoints","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicEndpoint"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","summary":" Get Bank Level Dynamic Endpoint","description":"Get a Bank Level Dynamic Endpoint.
\nAuthentication is Mandatory
\n","description_markdown":"Get a Bank Level Dynamic Endpoint.\n\n\nAuthentication is Mandatory","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"roles":[{"role":"CanGetBankLevelDynamicEndpoint","requires_bank_id":true},{"role":"CanGetDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateSystemLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"updateSystemLevelEndpointTag"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","summary":"Update System Level Endpoint Tag","description":"Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
\nAuthentication is Mandatory
\nURL Parameters:
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Update System Level Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[ENDPOINT_TAG_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","example_request_body":{"tag_name":"BankAccountTag1"},"success_response_body":{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["API"],"typed_request_body":{"type":"object","properties":{"tag_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"roles":[{"role":"CanUpdateSystemLevelEndpointTag","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","connector_methods":["obp.updateSystemLevelEndpointTag","obp.getSystemLevelEndpointTag","obp.getEndpointTagById"]},{"operation_id":"OBPv4.0.0-deleteBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelDynamicEntity"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Delete Bank Level Dynamic Entity","description":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"roles":[{"role":"CanDeleteBankLevelDynamicEntity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getMyDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/dynamic-entities","summary":"Get My Dynamic Entities","description":"Get all my Dynamic Entities.
\nAuthentication is Mandatory
\n","description_markdown":"Get all my Dynamic Entities.\n\nAuthentication is Mandatory","success_response_body":{"dynamic_entities":[{"bankId":"gh.29.uk","FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities","connector_methods":[]},{"operation_id":"OBPv5.0.0-getMetricsAtBank","implemented_by":{"version":"OBPv5.0.0","function":"getMetricsAtBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/management/metrics/banks/BANK_ID","summary":"Get Metrics at Bank","description":"Get the all metrics at the Bank specified by BANK_ID
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) non digit chars will be silently omitted
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nverb:
\n","description_markdown":"Get the all metrics at the Bank specified by BANK_ID\n\nrequire CanReadMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics\n\nShould be able to filter on the following metrics fields\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2\n\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 limit (for pagination: defaults to 50) eg:limit=200\n\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\n5 sort_by (defaults to date field) eg: sort_by=date\n possible values:\n \"url\",\n \"date\",\n \"user_name\",\n \"app_name\",\n \"developer_email\",\n \"implemented_by_partial_function\",\n \"implemented_in_version\",\n \"consumer_id\",\n \"verb\"\n\n6 direction (defaults to date desc) eg: direction=desc\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78\n\nOther filters:\n\n7 consumer_id (if null ignore)\n\n8 user_id (if null ignore)\n\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n10 url (if null ignore), note: can not contain '&'.\n\n11 app_name (if null ignore)\n\n12 implemented_by_partial_function (if null ignore),\n\n13 implemented_in_version (if null ignore)\n\n14 verb (if null ignore)\n\n15 correlation_id (if null ignore)\n\n16 duration (if null ignore) non digit chars will be silently omitted\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**correlation_id**](/glossary#): 1flssoftxq0cr1nssr68u0mioj\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**duration**](/glossary#duration): 5.123\n\n\n\n[**implemented_by_partial_function**](/glossary#implemented_by_partial_function): \n\n\n\n[**implemented_in_version**](/glossary#implemented_in_version): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**verb**](/glossary#verb): \n\n\n","success_response_body":{"metrics":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","url":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user_name":"OBP","app_name":"SOFI","developer_email":"felixsmith@example.com","implemented_by_partial_function":"getBanks","implemented_in_version":"v210","consumer_id":"123","verb":"get","correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1","duration":39}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API"],"typed_success_response_body":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"implemented_in_version":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"verb":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"date":{"type":"string","format":"date-time"},"user_name":{"type":"string"},"url":{"type":"string"},"duration":{"type":"integer"},"correlation_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetMetricsAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/metrics/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateConnectorMethod","implemented_by":{"version":"OBPv4.0.0","function":"updateConnectorMethod"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/connector-methods/CONNECTOR_METHOD_ID","summary":"Update Connector Method","description":"Update an internal connector.
\nThe method_body is URL-encoded format String
\nAuthentication is Mandatory
\nURL Parameters:
\nCONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51
\nJSON response body fields:
\n","description_markdown":"Update an internal connector.\n\nThe method_body is URL-encoded format String\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONNECTOR_METHOD_ID](/glossary#): ace0352a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"},"success_response_body":{"connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51","method_name":"getBank","method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Connector-Method"],"typed_request_body":{"type":"object","properties":{"programming_lang":{"type":"string"},"method_body":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}},"roles":[{"role":"CanUpdateConnectorMethod","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/connector-methods/CONNECTOR_METHOD_ID","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"},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"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"}}},"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/v5.1.0/message-docs/CONNECTOR","connector_methods":["obp.messageDocs"]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","summary":"Get My Api Collection Endpoints","description":"Get Api Collection Endpoints By API_COLLECTION_NAME.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_NAME.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-createJsonSchemaValidation","implemented_by":{"version":"OBPv4.0.0","function":"createJsonSchemaValidation"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/json-schema-validations/OPERATION_ID","summary":"Create a JSON Schema Validation","description":"Create a JSON Schema Validation.
\nPlease supply a json-schema as request body.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON request body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\nmaxLength: maxLength
\nminLength: minLength
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv4.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","description_markdown":"Create a JSON Schema Validation.\n\nPlease supply a json-schema as request body.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**json_schema**](/glossary#): json_schema\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n","example_request_body":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true},"success_response_body":{"operation_id":"OBPv4.0.0-createXxx","json_schema":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["JSON-Schema-Validation"],"typed_request_body":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}},"roles":[{"role":"CanCreateJsonSchemaValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/json-schema-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"createDynamicEndpoint"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/dynamic-endpoints","summary":"Create Dynamic Endpoint","description":"Create dynamic endpoints.
\nCreate dynamic endpoints with one json format swagger content.
\nIf the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
\nplease check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
\nAuthentication is Mandatory
\n","description_markdown":"Create dynamic endpoints.\n\nCreate dynamic endpoints with one json format swagger content.\n\nIf the host of swagger is `dynamic_entity`, then you need link the swagger fields to the dynamic entity fields, \nplease check `Endpoint Mapping` endpoints.\n\nIf the host of swagger is `obp_mock`, every dynamic endpoint will return example response of swagger,\n\nwhen create MethodRouting for given dynamic endpoint, it will be routed to given url.\n\n\n\nAuthentication is Mandatory","example_request_body":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09008: DynamicEndpoint already exists.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_request_body":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"roles":[{"role":"CanCreateDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteJsonSchemaValidation","implemented_by":{"version":"OBPv4.0.0","function":"deleteJsonSchemaValidation"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/json-schema-validations/OPERATION_ID","summary":"Delete a JSON Schema Validation","description":"Delete a JSON Schema Validation by operation_id.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"Delete a JSON Schema Validation by operation_id.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["JSON-Schema-Validation"],"roles":[{"role":"CanDeleteJsonSchemaValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/json-schema-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAllApiCollections","implemented_by":{"version":"OBPv5.1.0","function":"getAllApiCollections"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/api-collections","summary":"Get All API Collections","description":"Get All API Collections.
\nAuthentication is Mandatory
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get All API Collections.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllApiCollections","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelEndpointTag"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","summary":"Update Bank Level Endpoint Tag","description":"Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[ENDPOINT_TAG_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","example_request_body":{"tag_name":"BankAccountTag1"},"success_response_body":{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-30099: Invalid ENDPOINT_TAG_ID. Please specify a valid value for ENDPOINT_TAG_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["API"],"typed_request_body":{"type":"object","properties":{"tag_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"roles":[{"role":"CanUpdateBankLevelEndpointTag","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","connector_methods":["obp.updateBankLevelEndpointTag","obp.getBankLevelEndpointTag","obp.getEndpointTagById"]},{"operation_id":"OBPv4.0.0-getAllAuthenticationTypeValidationsPublic","implemented_by":{"version":"OBPv4.0.0","function":"getAllAuthenticationTypeValidationsPublic"},"request_verb":"GET","request_url":"/obp/v4.0.0/endpoints/authentication-type-validations","summary":"Get all Authentication Type Validations - public","description":"Get all Authentication Type Validations - public.
\nAuthentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get all Authentication Type Validations - public.\n\n\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"authentication_types_validations":[{"operation_id":"OBPv4.0.0-updateXxx","allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Authentication-Type-Validation"],"typed_success_response_body":{"type":"object","properties":{"authentication_types_validations":{"type":"array","items":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/endpoints/authentication-type-validations","connector_methods":[]},{"operation_id":"OBPv3.1.0-getObpConnectorLoopback","implemented_by":{"version":"OBPv3.1.0","function":"getObpConnectorLoopback"},"request_verb":"GET","request_url":"/obp/v3.1.0/connector/loopback","summary":"Get Connector Status (Loopback)","description":"This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
\nCurrently this is only implemented for Kafka based connectors.
\nFor Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
\nIn the future, this endpoint may also return information about database connections etc.
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nduration_time: 60
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\n","description_markdown":"This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.\n\nCurrently this is only implemented for Kafka based connectors.\n\nFor Kafka based connectors, this endpoint writes a message to Kafka and reads it again.\n\nIn the future, this endpoint may also return information about database connections etc.\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**connector_version**](/glossary#connector_version): \n\n\n\n[**duration_time**](/glossary#duration_time): 60\n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n","success_response_body":{"connector_version":"kafka_vSept2018","git_commit":"f0acd4be14cdcb94be3433ec95c1ad65228812a0","duration_time":"10 ms"},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"connector_version":{"type":"string"},"git_commit":{"type":"string"},"duration_time":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/connector/loopback","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getAllJsonSchemaValidations","implemented_by":{"version":"OBPv4.0.0","function":"getAllJsonSchemaValidations"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/json-schema-validations","summary":"Get all JSON Schema Validations","description":"Get all JSON Schema Validations.
\nAuthentication is Mandatory
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv4.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","description_markdown":"Get all JSON Schema Validations.\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**json_schema**](/glossary#): json_schema\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n","success_response_body":{"json_schema_validations":[{"operation_id":"OBPv4.0.0-createXxx","json_schema":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["JSON-Schema-Validation"],"typed_success_response_body":{"type":"object","properties":{"json_schema_validations":{"type":"array","items":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetJsonSchemaValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/json-schema-validations","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollection","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollection"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_ID","summary":"Delete My Api Collection","description":"Delete Api Collection By API_COLLECTION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete Api Collection By API_COLLECTION_ID\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getFeaturedApiCollections","implemented_by":{"version":"OBPv4.0.0","function":"getFeaturedApiCollections"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/featured","summary":"Get Featured Api Collections","description":"Get Featured Api Collections.
\nAuthentication is Optional
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Featured Api Collections.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/api-collections/featured","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankLevelDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelDynamicEndpoint"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-endpoints","summary":"Create Bank Level Dynamic Endpoint","description":"Create dynamic endpoints.
\nCreate dynamic endpoints with one json format swagger content.
\nIf the host of swagger is dynamic_entity
, then you need link the swagger fields to the dynamic entity fields,
\nplease check Endpoint Mapping
endpoints.
If the host of swagger is obp_mock
, every dynamic endpoint will return example response of swagger,
when create MethodRouting for given dynamic endpoint, it will be routed to given url.
\nAuthentication is Mandatory
\n","description_markdown":"Create dynamic endpoints.\n\nCreate dynamic endpoints with one json format swagger content.\n\nIf the host of swagger is `dynamic_entity`, then you need link the swagger fields to the dynamic entity fields, \nplease check `Endpoint Mapping` endpoints.\n\nIf the host of swagger is `obp_mock`, every dynamic endpoint will return example response of swagger,\n\nwhen create MethodRouting for given dynamic endpoint, it will be routed to given url.\n\n\n\nAuthentication is Mandatory","example_request_body":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09008: DynamicEndpoint already exists.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_request_body":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}},"roles":[{"role":"CanCreateBankLevelDynamicEndpoint","requires_bank_id":true},{"role":"CanCreateDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteAuthenticationTypeValidation","implemented_by":{"version":"OBPv4.0.0","function":"deleteAuthenticationTypeValidation"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/authentication-type-validations/OPERATION_ID","summary":"Delete an Authentication Type Validation","description":"Delete an Authentication Type Validation by operation_id.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"Delete an Authentication Type Validation by operation_id.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":true,"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Authentication-Type-Validation"],"roles":[{"role":"CanDeleteAuthenticationValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/authentication-type-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateDynamicEndpointHost","implemented_by":{"version":"OBPv4.0.0","function":"updateDynamicEndpointHost"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host","summary":" Update Dynamic Endpoint Host","description":"Update dynamic endpoint Host.
\nThe value can be obp_mock, dynamic_entity, or some service url.
Authentication is Mandatory
\n","description_markdown":"Update dynamic endpoint Host.\nThe value can be obp_mock, dynamic_entity, or some service url.\n\n\nAuthentication is Mandatory","example_request_body":{"host":"dynamic_entity"},"success_response_body":{"host":"dynamic_entity"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_request_body":{"type":"object","properties":{"host":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"host":{"type":"string"}}},"roles":[{"role":"CanUpdateDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host","connector_methods":[]},{"operation_id":"OBPv4.0.0-getApiCollectionsForUser","implemented_by":{"version":"OBPv4.0.0","function":"getApiCollectionsForUser"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/USER_ID/api-collections","summary":"Get Api Collections for User","description":"Get Api Collections for User.
\nAuthentication is Mandatory
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collections for User.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetApiCollectionsForUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/api-collections","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateMyApiCollection","implemented_by":{"version":"OBPv5.1.0","function":"updateMyApiCollection"},"request_verb":"PUT","request_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_ID","summary":"Update My Api Collection By API_COLLECTION_ID","description":"Update Api Collection for logged in user.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Update Api Collection for logged in user.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelDynamicEntity"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Update Bank Level Dynamic Entity","description":"Update a Bank Level DynamicEntity.
\nAuthentication is Mandatory
\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.
"someField0": {\n "type": "reference:Bank",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "07ace513-75cf-4891-b0b6-3ae465309b8d"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&branchId=019a5606-8c0f-4536-a346-0bdd58e3f6d7"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&atmId=019a5606-8c0f-4536-a346-0bdd58e3f6d7"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&productCode=019a5606-8c0f-4536-a346-0bdd58e3f6d7"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&cardId=019a5606-8c0f-4536-a346-0bdd58e3f6d7"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7&transactionId=9fab0ff4-5329-4be2-ae24-d2158fe333b3"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7&counterpartyId=9fab0ff4-5329-4be2-ae24-d2158fe333b3"\n}\n\n
\n","description_markdown":"Update a Bank Level DynamicEntity.\n\n\nAuthentication is Mandatory\n\nUpdate one DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nThe following field types are as supported:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.\n```\n\"someField0\": {\n \"type\": \"reference:Bank\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField1\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField2\": {\n \"type\": \"reference:Customer\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField3\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField4\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField5\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField6\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField7\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField8\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField9\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField10\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField11\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField12\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"07ace513-75cf-4891-b0b6-3ae465309b8d\"\n}\n\n\"someField13\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&branchId=019a5606-8c0f-4536-a346-0bdd58e3f6d7\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&atmId=019a5606-8c0f-4536-a346-0bdd58e3f6d7\"\n}\n\n\"someField15\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&productCode=019a5606-8c0f-4536-a346-0bdd58e3f6d7\"\n}\n\n\"someField17\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&cardId=019a5606-8c0f-4536-a346-0bdd58e3f6d7\"\n}\n\n\"someField18\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7&transactionId=9fab0ff4-5329-4be2-ae24-d2158fe333b3\"\n}\n\n\"someField19\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=07ace513-75cf-4891-b0b6-3ae465309b8d&accountId=019a5606-8c0f-4536-a346-0bdd58e3f6d7&counterpartyId=9fab0ff4-5329-4be2-ae24-d2158fe333b3\"\n}\n\n```","example_request_body":{"FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"hasPersonalEntity":true},"success_response_body":{"bankId":"gh.29.uk","FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"roles":[{"role":"CanUpdateBankLevelDynamicEntity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getTopAPIs","implemented_by":{"version":"OBPv3.1.0","function":"getTopAPIs"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/metrics/top-apis","summary":"Get Top APIs","description":"Get metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.
\nShould be able to filter on the following fields
\neg: /management/metrics/top-apis?from_date=1970-01-01T00:00:00.000Z&to_date=2024-03-29T00:00:40.425Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z
\n2 to_date (defaults to the current date) eg:to_date=2024-03-29T00:00:40.426Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\nAuthentication is Mandatory
\nJSON response body fields:
\nImplemented_by_partial_function:
\n\n\n\n","description_markdown":"Get metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.\n\nShould be able to filter on the following fields\n\neg: /management/metrics/top-apis?from_date=1970-01-01T00:00:00.000Z&to_date=2024-03-29T00:00:40.425Z&consumer_id=5\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions\n&verb=GET&anon=false&app_name=MapperPostman\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n1 from_date (defaults to the one year ago): eg:from_date=1970-01-01T00:00:00.000Z\n\n2 to_date (defaults to the current date) eg:to_date=2024-03-29T00:00:40.426Z\n\n3 consumer_id (if null ignore)\n\n4 user_id (if null ignore)\n\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n6 url (if null ignore), note: can not contain '&'.\n\n7 app_name (if null ignore)\n\n8 implemented_by_partial_function (if null ignore),\n\n9 implemented_in_version (if null ignore)\n\n10 verb (if null ignore)\n\n11 correlation_id (if null ignore)\n\n12 duration (if null ignore) non digit chars will be silently omitted\n\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%\n\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**Implemented_by_partial_function**](/glossary#implemented_by_partial_function): \n\n\n\n[**count**](/glossary#count): \n\n\n\n[**implemented_in_version**](/glossary#implemented_in_version): \n\n\n\n[**top_apis**](/glossary#top_apis): \n\n\n","success_response_body":{"top_apis":[{"count":7076,"Implemented_by_partial_function":"getBanks","implemented_in_version":"v1.2.1"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10016: Incorrect filter Parameters in URL. ","OBP-30042: Could not get the top apis from database. ","OBP-50000: Unknown Error."],"tags":["Metric"],"typed_success_response_body":{"type":"object","properties":{"top_apis":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"Implemented_by_partial_function":{"type":"string"},"implemented_in_version":{"type":"string"}}}}}},"roles":[{"role":"CanReadMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/metrics/top-apis","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-createBankLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelEndpointTag"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags","summary":"Create Bank Level Endpoint Tag","description":"Create Bank Level Endpoint Tag
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON request body fields:
\ntag_name: BankAccountTag1
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Create Bank Level Endpoint Tag\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","example_request_body":{"tag_name":"BankAccountTag1"},"success_response_body":{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["API"],"typed_request_body":{"type":"object","properties":{"tag_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"roles":[{"role":"CanCreateBankLevelEndpointTag","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags","connector_methods":["obp.createBankLevelEndpointTag","obp.getBankLevelEndpointTag"]},{"operation_id":"OBPv4.0.0-createSystemDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"createSystemDynamicEntity"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/system-dynamic-entities","summary":"Create System Level Dynamic Entity","description":"Create a system level Dynamic Entity.
\nAuthentication is Mandatory
\nCreate a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically
\nThe following field types are as supported:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
The DATE_WITH_DAY format is: yyyy-MM-dd
\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
\nSee the following list of currently available reference types and examples of how to construct key values correctly. Note: As more Dynamic Entities are created on this instance, this list will grow:
"someField0": {\n "type": "reference:Bank",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "e7e5367f-7003-443c-a1de-e9aff4164ac2"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&branchId=365f36be-1bba-456c-a2e3-61e1f65d3b11"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&atmId=365f36be-1bba-456c-a2e3-61e1f65d3b11"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&accountId=365f36be-1bba-456c-a2e3-61e1f65d3b11"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&productCode=365f36be-1bba-456c-a2e3-61e1f65d3b11"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&cardId=365f36be-1bba-456c-a2e3-61e1f65d3b11"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&accountId=365f36be-1bba-456c-a2e3-61e1f65d3b11&transactionId=7acda12a-0372-4ffb-a1fc-7a8ee4e6a98f"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=e7e5367f-7003-443c-a1de-e9aff4164ac2&accountId=365f36be-1bba-456c-a2e3-61e1f65d3b11&counterpartyId=7acda12a-0372-4ffb-a1fc-7a8ee4e6a98f"\n}\n\n
\nNote: if you set hasPersonalEntity
= false, then OBP will not generate the CRUD my FooBar endpoints.
Get the server's public JSON Web Key (JWK) set and certificate chain.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
\nJSON response body fields:
\ne:
\nkid:
\nkty:
\nn:
\nuse:
\n","description_markdown":"Get the server's public JSON Web Key (JWK) set and certificate chain.\n It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.\n\n \n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**e**](/glossary#e): \n\n\n\n[**kid**](/glossary#kid): \n\n\n\n[**kty**](/glossary#kty): \n\n\n\n[**n**](/glossary#n): \n\n\n\n[**use**](/glossary#use): \n\n\n","success_response_body":{"kty":"RSA","e":"AQAB","use":"sig","kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s","n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"kid":{"type":"string"},"use":{"type":"string"},"n":{"type":"string"},"e":{"type":"string"},"kty":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/certs","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpointsById","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpointsById"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","summary":"Get My Api Collection Endpoints By Id","description":"Get Api Collection Endpoints By API_COLLECTION_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_endpoints: api_collection_endpoints
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoints By API_COLLECTION_ID.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_endpoints**](/glossary#): api_collection_endpoints\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoints":[{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collection_endpoints":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints","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":"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 i18n language tag , e.g. ?locale=zh_CN
\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.
\nYou can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123
\nSee the Resource Doc endpoint for more information.
\nFollowing are more examples:
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653
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 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://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\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/v5.1.0/resource-docs/API_VERSION/obp","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getMethodRoutings","implemented_by":{"version":"OBPv3.1.0","function":"getMethodRoutings"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/method_routings","summary":"Get MethodRoutings","description":"Get the all MethodRoutings.
\nQuery url parameters:
\neg:
\nhttps://api3.openbankproject.com/obp/v3.1.0/management/method_routings?active=true
\nhttps://api3.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank
Authentication is Mandatory
\nJSON response body fields:
\nkey: CustomerNumber
\n\nvalue: 5987953
\n","description_markdown":"Get the all MethodRoutings.\n\nQuery url parameters:\n\n* method_name: filter with method_name\n* active: if active = true, it will show all the webui_ props. Even if they are set yet, we will return all the default webui_ props\n\neg: \nhttps://api3.openbankproject.com/obp/v3.1.0/management/method_routings?active=true\nhttps://api3.openbankproject.com/obp/v3.1.0/management/method_routings?method_name=getBank\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**parameters**](/glossary#parameters): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"method_routings":[{"is_bank_id_exact_match":false,"method_name":"getBanks","connector_name":"rest_vMar2019","method_routing_id":"method-routing-id","bank_id_pattern":"some_bank_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Method-Routing","API"],"typed_success_response_body":{"type":"object","properties":{"method_routings":{"type":"array","items":{"type":"object","properties":{"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"connector_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetMethodRoutings","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/method_routings","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-entities","summary":"Get Bank Level Dynamic Entities","description":"Get all the bank level Dynamic Entities for one bank.
\nAuthentication is Mandatory
\n","description_markdown":"Get all the bank level Dynamic Entities for one bank.\n\nAuthentication is Mandatory","success_response_body":{"dynamic_entities":[{"bankId":"gh.29.uk","FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetBankLevelDynamicEntities","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyDynamicEndpoint"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","summary":"Delete My Dynamic Endpoint","description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createMyApiCollection","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollection"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collections","summary":"Create My Api Collection","description":"Create Api Collection for logged in user.
\nAuthentication is Mandatory
\nJSON request body fields:
\napi_collection_name: Favourites
\nis_sharable: is_sharable
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Create Api Collection for logged in user.\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**is_sharable**](/glossary#): is_sharable\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\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollections","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollections"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections","summary":"Get My Api Collections","description":"Get all the apiCollections for logged in user.
\nAuthentication is Mandatory
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get all the apiCollections for logged in user.\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\n\n\n\n[**api_collections**](/glossary#): api_collections\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collections":[{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"api_collections":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv4.0.0-verifyRequestSignResponse","implemented_by":{"version":"OBPv4.0.0","function":"verifyRequestSignResponse"},"request_verb":"GET","request_url":"/obp/v4.0.0/development/echo/jws-verified-request-jws-signed-response","summary":"Verify Request and Sign Response of a current call","description":"Verify Request and Sign Response of a current call.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Verify Request and Sign Response of a current call.\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["API"],"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/development/echo/jws-verified-request-jws-signed-response","connector_methods":[]},{"operation_id":"OBPv3.1.0-getOAuth2ServerJWKsURIs","implemented_by":{"version":"OBPv3.1.0","function":"getOAuth2ServerJWKsURIs"},"request_verb":"GET","request_url":"/obp/v3.1.0/jwks-uris","summary":"Get JSON Web Key (JWK) URIs","description":"Get the OAuth2 server's public JSON Web Key (JWK) URIs.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
\nJSON response body fields:
\n\n\n","description_markdown":"Get the OAuth2 server's public JSON Web Key (JWK) URIs.\n It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.\n\n \n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**jwks_uri**](/glossary#jwks_uri): \n\n\n\n[**jwks_uris**](/glossary#jwks_uris): \n\n\n","success_response_body":{"jwks_uris":[{"jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"jwks_uris":{"type":"array","items":{"type":"object","properties":{"jwks_uri":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/jwks-uris","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getConnectorMethod","implemented_by":{"version":"OBPv4.0.0","function":"getConnectorMethod"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/connector-methods/CONNECTOR_METHOD_ID","summary":"Get Connector Method by Id","description":"Get an internal connector by CONNECTOR_METHOD_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nCONNECTOR_METHOD_ID: ace0352a-9a0f-4bfa-b30b-9003aa467f51
\nJSON response body fields:
\n","description_markdown":"Get an internal connector by CONNECTOR_METHOD_ID.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONNECTOR_METHOD_ID](/glossary#): ace0352a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51","method_name":"getBank","method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Connector-Method"],"typed_success_response_body":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}},"roles":[{"role":"CanGetConnectorMethod","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/connector-methods/CONNECTOR_METHOD_ID","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 i18n language tag , e.g. ?locale=zh_CN
\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.
\nYou can easily pass the cache, use different value for cache-modifier, eg: ?cache-modifier= 123
\nSee the Resource Doc endpoint for more information.
\nFollowing are more examples:
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653
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 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://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=zh_CN\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\nhttps://api3.openbankproject.com/obp/v4.0.0/resource-docs/v4.0.0/obp?cache-modifier=3141592653\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-29T00:00:41Z","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":{"response_date":{"type":"string","format":"date-time"},"count":{"type":"integer"}}},"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.1.0/resource-docs/API_VERSION/obp","connector_methods":["obp.getBankAccountsForUser"]},{"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/v5.1.0/api/versions","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyDynamicEndpoints","implemented_by":{"version":"OBPv4.0.0","function":"getMyDynamicEndpoints"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/dynamic-endpoints","summary":"Get My Dynamic Endpoints","description":"Get My Dynamic Endpoints.
\nAuthentication is Mandatory
\n","description_markdown":"Get My Dynamic Endpoints.\n\nAuthentication is Mandatory","success_response_body":{"dynamic_endpoints":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","dynamic_endpoint_id":"dynamic-endpoint-id","swagger_string":{"swagger":"2.0","info":{"title":"Bank Accounts (Dynamic Endpoint)","version":"1.0.0"},"definitions":{"AccountName":{"type":"object","properties":{"name":{"type":"string","example":"family account"},"balance":{"type":"integer","format":"int64","example":1000.123}}}},"paths":{"/accounts":{"post":{"operationId":"POST_account","produces":["application/json"],"responses":{"201":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"POST Accounts","summary":"POST Accounts"}},"/accounts/{account_id}":{"get":{"operationId":"GET_account","produces":["application/json"],"responses":{"200":{"description":"Success Response","schema":{"$ref":"#/definitions/AccountName"}}},"consumes":["application/json"],"description":"Get Bank Account","summary":"Get Bank Account by Id"}}},"host":"obp_mock","schemes":["http","https"]}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Endpoint-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_endpoints":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"dynamic_endpoint_id":{"type":"string"},"swagger_string":{"type":"object","properties":{"swagger":{"type":"string"},"paths":{"type":"object","properties":{"/accounts":{"type":"object","properties":{"post":{"type":"object","properties":{"responses":{"type":"object","properties":{"201":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}},"/accounts/{account_id}":{"type":"object","properties":{"get":{"type":"object","properties":{"description":{"type":"string"},"consumes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"operationId":{"type":"string"},"responses":{"type":"object","properties":{"200":{"type":"object","properties":{"description":{"type":"string"},"schema":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}},"summary":{"type":"string"},"produces":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}}}}},"info":{"type":"object","properties":{"title":{"type":"string"},"version":{"type":"string"}}},"definitions":{"type":"object","properties":{"AccountName":{"type":"object","properties":{"type":{"type":"string"},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"type":{"type":"string"},"example":{"type":"string"}}},"balance":{"type":"object","properties":{"type":{"type":"string"},"format":{"type":"string"},"example":{"type":"number"}}}}}}}}},"schemes":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"host":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllAuthenticationTypeValidations","implemented_by":{"version":"OBPv4.0.0","function":"getAllAuthenticationTypeValidations"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/authentication-type-validations","summary":"Get all Authentication Type Validations","description":"Get all Authentication Type Validations.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Get all Authentication Type Validations.\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","success_response_body":{"authentication_types_validations":[{"operation_id":"OBPv4.0.0-updateXxx","allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Authentication-Type-Validation"],"typed_success_response_body":{"type":"object","properties":{"authentication_types_validations":{"type":"array","items":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}}}}},"roles":[{"role":"CanGetAuthenticationTypeValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/authentication-type-validations","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelEndpointTags","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelEndpointTags"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags","summary":"Get Bank Level Endpoint Tags","description":"Get Bank Level Endpoint Tags.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Get Bank Level Endpoint Tags.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","success_response_body":[{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"}],"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"tl":{"type":"object","properties":{}},"head":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}}}},"roles":[{"role":"CanGetBankLevelEndpointTag","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags","connector_methods":["obp.getBankLevelEndpointTags"]},{"operation_id":"OBPv5.1.0-getAggregateMetrics","implemented_by":{"version":"OBPv5.1.0","function":"getAggregateMetrics"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/aggregate-metrics","summary":"Get Aggregate Metrics","description":"Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.
\nShould be able to filter on the following fields
\neg: /management/aggregate-metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the day before the current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to the current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 include_app_names (if null ignore).eg: &include_app_names=API-EXPLORER,API-Manager,SOFI,null
\n13 include_url_patterns (if null ignore).you can design you own SQL LIKE pattern. eg: &include_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n14 include_implemented_by_partial_functions (if null ignore).eg: &include_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\nAuthentication is Mandatory
\nJSON response body fields:
\n\n\n\n\n","description_markdown":"Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.\n\nShould be able to filter on the following fields\n\neg: /management/aggregate-metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&consumer_id=5\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions\n&verb=GET&anon=false&app_name=MapperPostman\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n1 from_date (defaults to the day before the current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to the current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 consumer_id (if null ignore)\n\n4 user_id (if null ignore)\n\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n6 url (if null ignore), note: can not contain '&'.\n\n7 app_name (if null ignore)\n\n8 implemented_by_partial_function (if null ignore),\n\n9 implemented_in_version (if null ignore)\n\n10 verb (if null ignore)\n\n11 correlation_id (if null ignore)\n\n12 include_app_names (if null ignore).eg: &include_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n13 include_url_patterns (if null ignore).you can design you own SQL LIKE pattern. eg: &include_url_patterns=%management/metrics%,%management/aggregate-metrics%\n\n14 include_implemented_by_partial_functions (if null ignore).eg: &include_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**average_response_time**](/glossary#average_response_time): \n\n\n\n[**count**](/glossary#count): \n\n\n\n[**maximum_response_time**](/glossary#maximum_response_time): 60\n\n\n\n[**minimum_response_time**](/glossary#minimum_response_time): \n\n\n","success_response_body":{"count":7076,"average_response_time":65.21,"minimum_response_time":1.0,"maximum_response_time":9039.0},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","Aggregate-Metrics"],"typed_success_response_body":{"type":"object","properties":{"count":{"type":"integer"},"average_response_time":{"type":"number"},"maximum_response_time":{"type":"number"},"minimum_response_time":{"type":"number"}}},"roles":[{"role":"CanReadAggregateMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/aggregate-metrics","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-getCallContext","implemented_by":{"version":"OBPv4.0.0","function":"getCallContext"},"request_verb":"GET","request_url":"/obp/v4.0.0/development/call_context","summary":"Get the Call Context of a current call","description":"Get the Call Context of the current call.
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Get the Call Context of the current call.\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["API"],"roles":[{"role":"CanGetCallContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/development/call_context","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteMethodRouting","implemented_by":{"version":"OBPv3.1.0","function":"deleteMethodRouting"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","summary":"Delete MethodRouting","description":"Delete a MethodRouting specified by METHOD_ROUTING_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete a MethodRouting specified by METHOD_ROUTING_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[METHOD_ROUTING_ID](/glossary#method_routing_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Method-Routing","API"],"roles":[{"role":"CanDeleteMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-config","implemented_by":{"version":"OBPv3.1.0","function":"config"},"request_verb":"GET","request_url":"/obp/v3.1.0/config","summary":"Get API Configuration","description":"Returns information about:
\nAuthentication is Mandatory
\nJSON response body fields:
\nakka:
\n\n\n\n\n\n\n\n\nrequire_scopes_for_listed_roles: true
\n\n\nvalue: 5987953
\n\n\n","description_markdown":"Returns information about:\n\n* The default bank_id\n* Akka configuration\n* Elastic Search configuration\n* Cached functions \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**akka**](/glossary#akka): \n\n\n\n[**cache**](/glossary#cache): \n\n\n\n[**elastic_search**](/glossary#elastic_search): \n\n\n\n[**function_name**](/glossary#function_name): \n\n\n\n[**log_level**](/glossary#log_level): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n\n[**ports**](/glossary#ports): \n\n\n\n[**property**](/glossary#property): \n\n\n\n[**require_scopes_for_all_roles**](/glossary#require_scopes_for_all_roles): \n\n\n\n[**require_scopes_for_listed_roles**](/glossary#require_scopes_for_listed_roles): true\n\n\n\n[**scopes**](/glossary#scopes): \n\n\n\n[**ttl_in_seconds**](/glossary#ttl_in_seconds): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**warehouse**](/glossary#warehouse): \n\n\n\n[remote_data_secret_matched](/glossary#remote_data_secret_matched): \n\n\n","success_response_body":{"akka":{"ports":[{"property":"default","value":"8080"}],"log_level":"Debug","remote_data_secret_matched":true},"elastic_search":{"metrics":[{"property":"String","value":"Mapper"}],"warehouse":[{"property":"String","value":"ElasticSearch"}]},"cache":[{"function_name":"getBanks","ttl_in_seconds":5}],"scopes":{"require_scopes_for_all_roles":true,"require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"elastic_search":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"property":{"type":"string"},"value":{"type":"string"}}}},"warehouse":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}}}},"scopes":{"type":"object","properties":{"require_scopes_for_all_roles":{"type":"boolean"},"require_scopes_for_listed_roles":{"type":"array","items":{"type":"string"}}}},"akka":{"type":"object","properties":{"ports":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"property":{"type":"string"}}}},"remote_data_secret_matched":{"type":"boolean"},"log_level":{"type":"string"}}},"cache":{"type":"array","items":{"type":"object","properties":{"ttl_in_seconds":{"type":"integer"},"function_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetConfig","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/config","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteBankLevelDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelDynamicEndpoint"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","summary":" Delete Bank Level Dynamic Endpoint","description":"Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nAuthentication is Mandatory","error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Dynamic-Endpoint-Manage","API"],"roles":[{"role":"CanDeleteBankLevelDynamicEndpoint","requires_bank_id":true},{"role":"CanDeleteDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAuthenticationTypeValidation","implemented_by":{"version":"OBPv4.0.0","function":"updateAuthenticationTypeValidation"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/authentication-type-validations/OPERATION_ID","summary":"Update an Authentication Type Validation","description":"Update an Authentication Type Validation.
\nPlease supply allowed authentication types.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"Update an Authentication Type Validation.\n\nPlease supply allowed authentication types.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"],"success_response_body":{"operation_id":"OBPv4.0.0-updateXxx","allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Authentication-Type-Validation"],"typed_request_body":{"type":"object","properties":{"head":{"type":"string","enum":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI","Anonymous"]},"tl":{"type":"array","items":{"type":"object","properties":{}}}}},"typed_success_response_body":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}},"roles":[{"role":"CanUpdateAuthenticationTypeValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/authentication-type-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionEndpoint"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","summary":"Get My Api Collection Endpoint","description":"Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.
\nAuthentication is Optional
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteDynamicEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"deleteDynamicEndpoint"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","summary":" Delete Dynamic Endpoint","description":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-09009: DynamicEndpoint not found. Please specify a valid value for DYNAMIC_ENDPOINT_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Dynamic-Endpoint-Manage","API"],"roles":[{"role":"CanDeleteDynamicEndpoint","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyApiCollectionByName","implemented_by":{"version":"OBPv4.0.0","function":"getMyApiCollectionByName"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/api-collections/name/API_COLLECTION_NAME","summary":"Get My Api Collection By Name","description":"Get Api Collection By API_COLLECTION_NAME.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Api Collection By API_COLLECTION_NAME.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/name/API_COLLECTION_NAME","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateMyDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"updateMyDynamicEntity"},"request_verb":"PUT","request_url":"/obp/v4.0.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Update My Dynamic Entity","description":"Update my DynamicEntity.
\nAuthentication is Mandatory
\nUpdate one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.
\nCurrent support filed types as follow:
\n[number, integer, boolean, string, DATE_WITH_DAY, reference]
DATE_WITH_DAY format: yyyy-MM-dd
\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.
"someField0": {\n "type": "reference:Bank",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "02c704c8-dc82-4e94-9562-c501f8b8fee7"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&branchId=d00eeef6-5671-413a-bd87-c38c0ba323ec"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&atmId=d00eeef6-5671-413a-bd87-c38c0ba323ec"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&productCode=d00eeef6-5671-413a-bd87-c38c0ba323ec"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&cardId=d00eeef6-5671-413a-bd87-c38c0ba323ec"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec&transactionId=f54c6325-4484-40ad-95f1-554e4c223d9b"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec&counterpartyId=f54c6325-4484-40ad-95f1-554e4c223d9b"\n}\n\n
\n","description_markdown":"Update my DynamicEntity.\n\n\nAuthentication is Mandatory\n\nUpdate one of my DynamicEntity, after update finished, the corresponding CRUD endpoints will be changed.\n\nCurrent support filed types as follow:\n[number, integer, boolean, string, DATE_WITH_DAY, reference]\n\nDATE_WITH_DAY format: yyyy-MM-dd\n\nReference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..\nThe following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.\n```\n\"someField0\": {\n \"type\": \"reference:Bank\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField1\": {\n \"type\": \"reference:Consumer\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField2\": {\n \"type\": \"reference:Customer\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField3\": {\n \"type\": \"reference:MethodRouting\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField4\": {\n \"type\": \"reference:DynamicEntity\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField5\": {\n \"type\": \"reference:TransactionRequest\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField6\": {\n \"type\": \"reference:ProductAttribute\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField7\": {\n \"type\": \"reference:AccountAttribute\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField8\": {\n \"type\": \"reference:TransactionAttribute\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField9\": {\n \"type\": \"reference:CustomerAttribute\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField10\": {\n \"type\": \"reference:AccountApplication\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField11\": {\n \"type\": \"reference:CardAttribute\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField12\": {\n \"type\": \"reference:Counterparty\",\n \"example\": \"02c704c8-dc82-4e94-9562-c501f8b8fee7\"\n}\n\n\"someField13\": {\n \"type\": \"reference:Branch:bankId&branchId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&branchId=d00eeef6-5671-413a-bd87-c38c0ba323ec\"\n}\n\n\"someField14\": {\n \"type\": \"reference:Atm:bankId&atmId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&atmId=d00eeef6-5671-413a-bd87-c38c0ba323ec\"\n}\n\n\"someField15\": {\n \"type\": \"reference:BankAccount:bankId&accountId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec\"\n}\n\n\"someField16\": {\n \"type\": \"reference:Product:bankId&productCode\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&productCode=d00eeef6-5671-413a-bd87-c38c0ba323ec\"\n}\n\n\"someField17\": {\n \"type\": \"reference:PhysicalCard:bankId&cardId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&cardId=d00eeef6-5671-413a-bd87-c38c0ba323ec\"\n}\n\n\"someField18\": {\n \"type\": \"reference:Transaction:bankId&accountId&transactionId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec&transactionId=f54c6325-4484-40ad-95f1-554e4c223d9b\"\n}\n\n\"someField19\": {\n \"type\": \"reference:Counterparty:bankId&accountId&counterpartyId\",\n \"example\": \"bankId=02c704c8-dc82-4e94-9562-c501f8b8fee7&accountId=d00eeef6-5671-413a-bd87-c38c0ba323ec&counterpartyId=f54c6325-4484-40ad-95f1-554e4c223d9b\"\n}\n\n```","example_request_body":{"FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"hasPersonalEntity":true},"success_response_body":{"bankId":"gh.29.uk","FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-09001: DynamicEntity not found. Please specify a valid value for DYNAMIC_ENTITY_ID.","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_request_body":{"type":"object","properties":{"hasPersonalEntity":{"type":"boolean"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/dynamic-entities/DYNAMIC_ENTITY_ID","connector_methods":["obp.dynamicEntityProcess"]},{"operation_id":"OBPv5.1.0-waitingForGodot","implemented_by":{"version":"OBPv5.1.0","function":"waitingForGodot"},"request_verb":"GET","request_url":"/obp/v5.1.0/waiting-for-godot","summary":"Waiting For Godot","description":"Waiting For Godot
\nUses query parameter "sleep" in milliseconds.
\nFor instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.
Authentication is Optional
\nJSON response body fields:
\nsleep_in_milliseconds: sleep_in_milliseconds
\n","description_markdown":"Waiting For Godot\n\nUses query parameter \"sleep\" in milliseconds.\nFor instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.\n\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n[**sleep_in_milliseconds**](/glossary#): sleep_in_milliseconds\n\n\n","success_response_body":{"sleep_in_milliseconds":50},"error_response_bodies":["OBP-50000: Unknown Error.","no connector set"],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"sleep_in_milliseconds":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/waiting-for-godot","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpointById","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpointById"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID","summary":"Delete My Api Collection Endpoint By Id","description":"Delete Api Collection Endpoint
\nDelete Api Collection Endpoint By Id
Authentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete Api Collection Endpoint\nDelete Api Collection Endpoint By Id\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ENDPOINT_ID](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getJsonSchemaValidation","implemented_by":{"version":"OBPv4.0.0","function":"getJsonSchemaValidation"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/json-schema-validations/OPERATION_ID","summary":"Get a JSON Schema Validation","description":"Get a JSON Schema Validation by operation_id.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nexamples: examples
\njson_schema: json_schema
\nmaxLength: maxLength
\nminLength: minLength
\noperation_id: OBPv4.0.0-getBanks
\nproperties: properties
\nrequired: required
\ntitle: Dr.
\ntype:
\nxxx_id: xxx_id
\n","description_markdown":"Get a JSON Schema Validation by operation_id.\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**$schema**](/glossary#): $schema\n\n\n\n[**additionalProperties**](/glossary#): additionalProperties\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[**examples**](/glossary#): examples\n\n\n\n[**json_schema**](/glossary#): json_schema\n\n\n\n[**maxLength**](/glossary#): maxLength\n\n\n\n[**minLength**](/glossary#): minLength\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**properties**](/glossary#): properties\n\n\n\n[**required**](/glossary#): required\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**xxx_id**](/glossary#): xxx_id\n\n\n","success_response_body":{"operation_id":"OBPv4.0.0-createXxx","json_schema":{"$schema":"http://json-schema.org/draft-07/schema","description":"The demo json-schema","title":"The demo schema","required":["xxx_id"],"type":"object","properties":{"xxx_id":{"type":"string","minLength":2,"maxLength":50,"examples":["xxx_id_demo_value"]}},"additionalProperties":true}},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["JSON-Schema-Validation"],"typed_success_response_body":{"type":"object","properties":{"json_schema":{"type":"object","properties":{"title":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"$schema":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"properties":{"type":"object","properties":{"xxx_id":{"type":"object","properties":{"minLength":{"type":"integer"},"maxLength":{"type":"integer"},"type":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}}}}},"additionalProperties":{"type":"boolean"}}},"operation_id":{"type":"string"}}},"roles":[{"role":"CanGetJsonSchemaValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/json-schema-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getRateLimitingInfo","implemented_by":{"version":"OBPv3.1.0","function":"getRateLimitingInfo"},"request_verb":"GET","request_url":"/obp/v3.1.0/rate-limiting","summary":"Get Rate Limiting Info","description":"Get information about the Rate Limiting setup on this OBP Instance such as:
\nIs rate limiting enabled and active?
\nWhat backend is used to keep track of the API calls (e.g. REDIS).
Authentication is Mandatory
\nJSON response body fields:
\nenabled: true
\nis_active: true
\n\ntechnology: technology1
\n","description_markdown":"Get information about the Rate Limiting setup on this OBP Instance such as:\n\nIs rate limiting enabled and active?\nWhat backend is used to keep track of the API calls (e.g. REDIS).\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**enabled**](/glossary#enabled): true\n\n\n\n[**is_active**](/glossary#is_active): true\n\n\n\n[**service_available**](/glossary#service_available): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n","success_response_body":{"enabled":true,"technology":"REDIS","service_available":true,"is_active":true},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"is_active":{"type":"boolean"},"technology":{"type":"string"},"service_available":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/rate-limiting","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-createConnectorMethod","implemented_by":{"version":"OBPv4.0.0","function":"createConnectorMethod"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/connector-methods","summary":"Create Connector Method","description":"Create an internal connector.
\nThe method_body is URL-encoded format String
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an internal connector.\n\nThe method_body is URL-encoded format String\n\n\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"method_name":"getBank","method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"},"success_response_body":{"connector_method_id":"ace0352a-9a0f-4bfa-b30b-9003aa467f51","method_name":"getBank","method_body":"%20%20%20%20%20%20Future.successful%28%0A%20%20%20%20%20%20%20%20Full%28%28BankCommons%28%0A%20%20%20%20%20%20%20%20%20%20BankId%28%22Hello%20bank%20id%22%29%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%221%22%2C%0A%20%20%20%20%20%20%20%20%20%20%228%22%0A%20%20%20%20%20%20%20%20%29%2C%20None%29%29%0A%20%20%20%20%20%20%29","programming_lang":"Scala"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Connector-Method"],"typed_request_body":{"type":"object","properties":{"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"connector_method_id":{"type":"string"},"method_name":{"type":"string"},"programming_lang":{"type":"string"},"method_body":{"type":"string"}}},"roles":[{"role":"CanCreateConnectorMethod","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/connector-methods","connector_methods":[]},{"operation_id":"OBPv4.0.0-createAuthenticationTypeValidation","implemented_by":{"version":"OBPv4.0.0","function":"createAuthenticationTypeValidation"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/authentication-type-validations/OPERATION_ID","summary":"Create an Authentication Type Validation","description":"Create an Authentication Type Validation.
\nPlease supply allowed authentication types.
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create an Authentication Type Validation.\n\nPlease supply allowed authentication types.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"],"success_response_body":{"operation_id":"OBPv4.0.0-updateXxx","allowed_authentication_types":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Authentication-Type-Validation"],"typed_request_body":{"type":"object","properties":{"head":{"type":"string","enum":["DirectLogin","OAuth1.0a","GatewayLogin","DAuth","OAuth2_OIDC","OAuth2_OIDC_FAPI","Anonymous"]},"tl":{"type":"array","items":{"type":"object","properties":{}}}}},"typed_success_response_body":{"type":"object","properties":{"authTypes":{"type":"array","items":{"type":"object","properties":{}}},"operationId":{"type":"string"}}},"roles":[{"role":"CanCreateAuthenticationTypeValidation","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/authentication-type-validations/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-elasticSearchMetrics","implemented_by":{"version":"OBPv2.0.0","function":"elasticSearchMetrics"},"request_verb":"GET","request_url":"/obp/v2.0.0/search/metrics","summary":"Search API Metrics via Elasticsearch","description":"Search the API calls made to this API instance via Elastic Search.
\nLogin is required.
\nCanSearchMetrics entitlement is required to search metrics data.
\nparameters:
\nesType - elasticsearch type
\nsimple query:
\nq - plain_text_query
\ndf - default field to search
\nsort - field to sort on
\nsize - number of hits returned, default 10
\nfrom - show hits starting from
\njson query:
\nsource - JSON_query_(URL-escaped)
\nexample usage:
\n/search/metrics/q=findThis
\nor:
\n/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
\nNote!!
\nThe whole JSON query string MUST be URL-encoded:
\netc..
\nOnly q, source and esType are passed to Elastic
\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Search the API calls made to this API instance via Elastic Search.\n\nLogin is required.\n\nCanSearchMetrics entitlement is required to search metrics data.\n\n\nparameters:\n\n esType - elasticsearch type\n\n simple query:\n\n q - plain_text_query\n\n df - default field to search\n\n sort - field to sort on\n\n size - number of hits returned, default 10\n\n from - show hits starting from\n\n json query:\n\n source - JSON_query_(URL-escaped)\n\n\nexample usage:\n\n /search/metrics/q=findThis\n\nor:\n\n /search/metrics/source={\"query\":{\"query_string\":{\"query\":\"findThis\"}}}\n\n\nNote!!\n\nThe whole JSON query string MUST be URL-encoded:\n\n* For { use %7B\n* For } use %7D\n* For : use %3A\n* For \" use %22\n\netc..\n\n\n\nOnly q, source and esType are passed to Elastic\n\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html\n\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html\n\n\n \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-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/search/metrics","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"deleteMyApiCollectionEndpoint"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","summary":"Delete My Api Collection Endpoint","description":"Delete Api Collection Endpoint By OPERATION_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete Api Collection Endpoint By OPERATION_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints/OPERATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSystemDynamicEntities","implemented_by":{"version":"OBPv4.0.0","function":"getSystemDynamicEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/system-dynamic-entities","summary":"Get System Dynamic Entities","description":"Get all System Dynamic Entities
\nAuthentication is Mandatory
\n","description_markdown":"Get all System Dynamic Entities \n\nAuthentication is Mandatory","success_response_body":{"dynamic_entities":[{"bankId":"gh.29.uk","FooBar":{"description":"description of this entity, can be markdown text.","required":["name"],"properties":{"name":{"type":"string","minLength":3,"maxLength":20,"example":"James Brown","description":"description of **name** field, can be markdown text."},"number":{"type":"integer","example":698761728,"description":"description of **number** field, can be markdown text."}}},"dynamicEntityId":"dynamic-entity-id","userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","hasPersonalEntity":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"typed_success_response_body":{"type":"object","properties":{"dynamic_entities":{"type":"array","items":{"type":"object","properties":{"dynamicEntityId":{"type":"string"},"bankId":{"type":"string"},"hasPersonalEntity":{"type":"boolean"},"userId":{"type":"string"},"FooBar":{"type":"object","properties":{"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","properties":{"name":{"type":"object","properties":{"minLength":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"maxLength":{"type":"integer"},"example":{"type":"string"},"description":{"type":"string"}}},"number":{"type":"object","properties":{"example":{"type":"integer"},"type":{"type":"string","enum":["number","integer","boolean","string","DATE_WITH_DAY"]},"description":{"type":"string"}}}}},"description":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetSystemLevelDynamicEntities","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteSystemDynamicEntity","implemented_by":{"version":"OBPv4.0.0","function":"deleteSystemDynamicEntity"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","summary":"Delete System Level Dynamic Entity","description":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.
\nAuthentication is Mandatory
\n","description_markdown":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nAuthentication is Mandatory","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Dynamic-Entity-Manage","API"],"roles":[{"role":"CanDeleteSystemLevelDynamicEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system-dynamic-entities/DYNAMIC_ENTITY_ID","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/v5.1.0/api/glossary","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-getMetrics","implemented_by":{"version":"OBPv2.1.0","function":"getMetrics"},"request_verb":"GET","request_url":"/obp/v2.1.0/management/metrics","summary":"Get Metrics","description":"Get the all metrics
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z
\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) non digit chars will be silently omitted
\nAuthentication is Mandatory
\nJSON response body fields:
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nverb:
\n","description_markdown":"Get the all metrics\n\nrequire CanReadMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics\n\nShould be able to filter on the following metrics fields\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=50&offset=2\n\n1 from_date (defaults to one week before current date): eg:from_date=1100-01-01T01:01:01.000Z\n\n2 to_date (defaults to current date) eg:to_date=1100-01-01T01:01:01.000Z\n\n3 limit (for pagination: defaults to 50) eg:limit=200\n\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\n5 sort_by (defaults to date field) eg: sort_by=date\n possible values:\n \"url\",\n \"date\",\n \"user_name\",\n \"app_name\",\n \"developer_email\",\n \"implemented_by_partial_function\",\n \"implemented_in_version\",\n \"consumer_id\",\n \"verb\"\n\n6 direction (defaults to date desc) eg: direction=desc\n\neg: /management/metrics?from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78\n\nOther filters:\n\n7 consumer_id (if null ignore)\n\n8 user_id (if null ignore)\n\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n10 url (if null ignore), note: can not contain '&'.\n\n11 app_name (if null ignore)\n\n12 implemented_by_partial_function (if null ignore),\n\n13 implemented_in_version (if null ignore)\n\n14 verb (if null ignore)\n\n15 correlation_id (if null ignore)\n\n16 duration (if null ignore) non digit chars will be silently omitted\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**correlation_id**](/glossary#): 1flssoftxq0cr1nssr68u0mioj\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**duration**](/glossary#duration): 5.123\n\n\n\n[**implemented_by_partial_function**](/glossary#implemented_by_partial_function): \n\n\n\n[**implemented_in_version**](/glossary#implemented_in_version): \n\n\n\n[**metrics**](/glossary#metrics): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**verb**](/glossary#verb): \n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"metrics":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","url":"www.openbankproject.com","date":"1100-01-01T00:00:00Z","user_name":"OBP","app_name":"SOFI","developer_email":"felixsmith@example.com","implemented_by_partial_function":"getBanks","implemented_in_version":"v210","consumer_id":"123","verb":"get","correlation_id":"v8ho6h5ivel3uq7a5zcnv0w1","duration":39}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"metrics":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"implemented_in_version":{"type":"string"},"developer_email":{"type":"string"},"consumer_id":{"type":"string"},"verb":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"date":{"type":"string","format":"date-time"},"user_name":{"type":"string"},"url":{"type":"string"},"duration":{"type":"integer"},"correlation_id":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanReadMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/metrics","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv4.0.0-deleteBankLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelEndpointTag"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","summary":"Delete Bank Level Endpoint Tag","description":"Delete Bank Level Endpoint Tag.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\nvalue: 5987953
\n","description_markdown":"Delete Bank Level Endpoint Tag.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[ENDPOINT_TAG_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"value":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"roles":[{"role":"CanDeleteBankLevelEndpointTag","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoints/OPERATION_ID/tags/ENDPOINT_TAG_ID","connector_methods":["obp.deleteEndpointTag","obp.getEndpointTagById"]},{"operation_id":"OBPv5.0.0-getAdapterInfo","implemented_by":{"version":"OBPv5.0.0","function":"getAdapterInfo"},"request_verb":"GET","request_url":"/obp/v5.0.0/adapter","summary":"Get Adapter Info","description":"Get basic information about the Adapter.
\nAuthentication is Optional
\nAuthentication is Mandatory
\nJSON response body fields:
\nbackend_messages: backend_messages
\ndate: 2020-01-27
\nerrorCode: errorCode
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\ntext:
\ntotal_duration: total_duration
\n\nduration: 5.123
\n","description_markdown":"Get basic information about the Adapter.\n\nAuthentication is Optional\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n[**backend_messages**](/glossary#): backend_messages\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**errorCode**](/glossary#errorCode): errorCode\n\n\n\n[**git_commit**](/glossary#): 59623811dd8a41f6ffe67be46954eee11913dc28\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**source**](/glossary#): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**text**](/glossary#text): \n\n\n\n[**total_duration**](/glossary#): total_duration\n\n\n\n[**version**](/glossary#version): \n\n\n\n[duration](/glossary#duration): 5.123\n\n\n","success_response_body":{"name":"ACCOUNT_MANAGEMENT_FEE","version":"","git_commit":"59623811dd8a41f6ffe67be46954eee11913dc28","date":"2020-01-27","total_duration":"5.123","backend_messages":[{"source":"","status":"","errorCode":"","text":"","duration":"5.123"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"git_commit":{"type":"string"},"version":{"type":"string"},"date":{"type":"string","format":"date-time"},"name":{"type":"string"},"total_duration":{"type":"number"},"backend_messages":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string"},"text":{"type":"string"},"status":{"type":"string"},"errorCode":{"type":"string"},"duration":{"type":"number"}}}}}},"roles":[{"role":"CanGetAdapterInfo","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/adapter","connector_methods":["obp.getAdapterInfo"]},{"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.
\nFollowing are more examples:
\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger
\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
\nhttps://api3.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\nFollowing are more examples:\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\nhttps://api3.openbankproject.com/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\nhttps://api3.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/v5.1.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv4.0.0-createSystemLevelEndpointTag","implemented_by":{"version":"OBPv4.0.0","function":"createSystemLevelEndpointTag"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/endpoints/OPERATION_ID/tags","summary":"Create System Level Endpoint Tag","description":"Create System Level Endpoint Tag
\nAuthentication is Mandatory
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON request body fields:
\ntag_name: BankAccountTag1
\nJSON response body fields:
\nbank_id: gh.29.uk
\nendpoint_tag_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\ntag_name: BankAccountTag1
\n","description_markdown":"Create System Level Endpoint Tag\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[OPERATION_ID](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**endpoint_tag_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n[**tag_name**](/glossary#): BankAccountTag1\n\n\n","example_request_body":{"tag_name":"BankAccountTag1"},"success_response_body":{"bank_id":"gh.29.uk","endpoint_tag_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks","tag_name":"BankAccountTag1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["API"],"typed_request_body":{"type":"object","properties":{"tag_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"tag_name":{"type":"string"},"bank_id":{"type":"string"},"endpoint_tag_id":{"type":"string"}}},"roles":[{"role":"CanCreateSystemLevelEndpointTag","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoints/OPERATION_ID/tags","connector_methods":["obp.createSystemLevelEndpointTag","obp.getSystemLevelEndpointTag"]},{"operation_id":"OBPv4.0.0-createMyApiCollectionEndpoint","implemented_by":{"version":"OBPv4.0.0","function":"createMyApiCollectionEndpoint"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","summary":"Create My Api Collection Endpoint","description":"Create Api Collection Endpoint.
\nAuthentication is Mandatory
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON request body fields:
\noperation_id: OBPv4.0.0-getBanks
\nJSON response body fields:
\napi_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\noperation_id: OBPv4.0.0-getBanks
\n","description_markdown":"Create Api Collection Endpoint.\n\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[API_COLLECTION_NAME](/glossary#): Favourites\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_endpoint_id**](/glossary#): 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**operation_id**](/glossary#): OBPv4.0.0-getBanks\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-getBanks"},"success_response_body":{"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","operation_id":"OBPv4.0.0-getBanks"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_endpoint_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections/API_COLLECTION_NAME/api-collection-endpoints","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSharableApiCollectionById","implemented_by":{"version":"OBPv4.0.0","function":"getSharableApiCollectionById"},"request_verb":"GET","request_url":"/obp/v4.0.0/api-collections/sharable/API_COLLECTION_ID","summary":"Get Sharable Api Collection By Id","description":"Get Sharable Api Collection By Id.
\nAuthentication is Optional
URL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: This an optional field. Maximum length is 2000. It can be any characters here.
\nis_sharable: is_sharable
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get Sharable Api Collection By Id.\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n[API_COLLECTION_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**api_collection_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**api_collection_name**](/glossary#): Favourites\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[**is_sharable**](/glossary#): is_sharable\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","api_collection_name":"Favourites","is_sharable":true,"description":"This an optional field. Maximum length is 2000. It can be any characters here."},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Api-Collection"],"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/api-collections/sharable/API_COLLECTION_ID","connector_methods":[]}]}