Get status of Credit Card orders
\nGet all orders
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\ncard_type: Credit
\n\n\n","description_markdown":"Get status of Credit Card orders\nGet all orders\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**card_description**](/glossary#card_description): \n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**cards**](/glossary#cards): \n\n\n\n[**use_type**](/glossary#use_type): \n\n\n","success_response_body":{"cards":[{"card_type":"5","card_description":"good","use_type":"3"}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50212: Connector did not return the set of status of credit card.","OBP-50000: Unknown Error."],"tags":["Card"],"typed_success_response_body":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"use_type":{"type":"string"},"card_description":{"type":"string"},"card_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/credit_cards/orders","connector_methods":[]},{"operation_id":"OBPv4.0.0-getProduct","implemented_by":{"version":"OBPv4.0.0","function":"getProduct"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Get Bank Product","description":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrequency: DAILY
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n\nmeta:
\nmore_info: More information about this fee
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\ntype:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nfees: fees
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\n","description_markdown":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:\n\n* Name\n* Code\n* Parent Product Code\n* More info URL\n* Description\n* Terms and Conditions\n* Description\n* Meta\n* Attributes\n* Fees\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n\n[product_fee_id](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n","success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"Description of the object. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"attributes":[{"product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}],"fees":[{"product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"fees":{"type":"array","items":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv3.0.0-getEntitlementRequests","implemented_by":{"version":"OBPv3.0.0","function":"getEntitlementRequests"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/USER_ID/entitlement-requests","summary":"Get Entitlement Requests for a User","description":"Get Entitlement Requests for a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get Entitlement Requests for a User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlement_request_id**](/glossary#entitlement_request_id): \n\n\n\n[**entitlement_requests**](/glossary#entitlement_requests): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"entitlement_requests":[{"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"role_name":"CanQueryOtherUser","bank_id":"gh.29.uk","created":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetEntitlementRequestsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/entitlement-requests","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","description_markdown":"Get all Connector Methods.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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-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.
\nUser Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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.2.1-addCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyPhysicalLocation"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Add physical location to other bank account","description":"Add geocoordinates of the counterparty's main location
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","description_markdown":"Add geocoordinates of the counterparty's main location\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"physical_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a physical location","Coordinates not possible","Physical Location cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/product","summary":"Delete Product Attribute Definition","description":"Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Product Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Product"],"roles":[{"role":"CanDeleteProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/product","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteBankAccountBalance","implemented_by":{"version":"OBPv5.1.0","function":"deleteBankAccountBalance"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","summary":"Delete Bank Account Balance","description":"Delete a Bank Account Balance specified by BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete a Bank Account Balance specified by BALANCE_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BALANCE_ID](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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":["Account","Balance"],"roles":[{"role":"CanDeleteBankAccountBalance","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycStatuses","implemented_by":{"version":"OBPv2.0.0","function":"getKycStatuses"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_statuses","summary":"Get Customer KYC statuses","description":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n\n","description_markdown":"Get the KYC statuses for a customer specified by CUSTOMER_ID over time.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): false\n\n\n\n[**statuses**](/glossary#statuses): \n\n\n","success_response_body":{"statuses":[{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"statuses":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"customer_number":{"type":"string"},"ok":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetAnyKycStatuses","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"operation_id":"OBPv3.1.0-createCustomerAddress","implemented_by":{"version":"OBPv3.1.0","function":"createCustomerAddress"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/address","summary":"Create Address","description":"Create an Address for a Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\ncity:
\ncountry_code: 1254
\n\n\n\n\n\n\n\ntags: Create-My-User
\nJSON response body fields:
\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","description_markdown":"Create an Address for a Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**customer_address_id**](/glossary#customer_address_id): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK"},"success_response_body":{"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK","insert_date":"1099-12-31T21:00:00Z"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"city":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"insert_date":{"type":"string","format":"date-time"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/address","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerOverviewFlat","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerOverviewFlat"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers/customer-number-query/overview-flat","summary":"Get Customer Overview Flat","description":"Gets the Customer Overview Flat specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncontract_code: contract_code
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate_of_birth: 2018-03-09
\n\nlabel: My Account
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\nscheme: OBP
\ntitle: Dr.
\ntype:
\nvalue: 5987953
\nbranch_code: branch_code
\ncancellation_date: cancellation_date
\ncontract_code: contract_code
\ncontracts: contracts
\nform_of_payment: form_of_payment
\ninstrument_status_code: instrument_status_code
\ninstrument_status_definition: instrument_status_definition
\ninterest_amount: interest_amount
\ninterest_rate: interest_rate
\nis_substituted: is_substituted
\nissuance_amount: issuance_amount
\nmaturity_date: maturity_date
\nopening_date: opening_date
\npayment_method: payment_method
\nproduct_description: product_description
\nrenewal_date: renewal_date
\nterm: term
\n","description_markdown":"Gets the Customer Overview Flat specified by customer_number and bank_code.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**contract_code**](/glossary#): contract_code\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[branch_code](/glossary#): branch_code\n\n\n\n[cancellation_date](/glossary#): cancellation_date\n\n\n\n[**contract_code**](/glossary#): contract_code\n\n\n\n[contracts](/glossary#): contracts\n\n\n\n[form_of_payment](/glossary#): form_of_payment\n\n\n\n[instrument_status_code](/glossary#): instrument_status_code\n\n\n\n[instrument_status_definition](/glossary#): instrument_status_definition\n\n\n\n[interest_amount](/glossary#): interest_amount\n\n\n\n[interest_rate](/glossary#): interest_rate\n\n\n\n[is_substituted](/glossary#): is_substituted\n\n\n\n[issuance_amount](/glossary#): issuance_amount\n\n\n\n[maturity_date](/glossary#): maturity_date\n\n\n\n[opening_date](/glossary#): opening_date\n\n\n\n[payment_method](/glossary#): payment_method\n\n\n\n[product_description](/glossary#): product_description\n\n\n\n[renewal_date](/glossary#): renewal_date\n\n\n\n[term](/glossary#): term\n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","date_of_birth":"1099-12-31T21:00:00Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}],"accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"My Account","product_code":"787LOW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","contracts":[{"product_code":"787LOW","contract_code":"LKJL98769F","payment_method":"cache"}],"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"contract_code":"LKJL98769F","product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"date_of_birth":{"type":"string","format":"date-time"},"email":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"contracts":{"type":"array","items":{"type":"object","properties":{"payment_method":{"type":"string"},"product_code":{"type":"string"},"contract_code":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"roles":[{"role":"CanGetCustomerOverviewFlat","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number-query/overview-flat","connector_methods":[]},{"operation_id":"OBPv2.0.0-getTransactionTypes","implemented_by":{"version":"OBPv2.0.0","function":"getTransactionTypes"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/transaction-types","summary":"Get Transaction Types at Bank","description":"Get Transaction Types for the bank specified by BANK_ID:
\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nvalue: 5987953
\n","description_markdown":"Get Transaction Types for the bank specified by BANK_ID:\n\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nUser Authentication is Optional. The User need not be logged in.\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[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**short_code**](/glossary#short_code): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_types**](/glossary#transaction_types): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_types":[{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"transaction_types":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv4.0.0-createUserInvitation","implemented_by":{"version":"OBPv4.0.0","function":"createUserInvitation"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitation","summary":"Create User Invitation","description":"Create User Invitation.
\nThis endpoint will send an invitation email to the developers, then they can use the link to create the obp user.
\npurpose filed only support:List(DEVELOPER, CUSTOMER).
\nYou can customise the email details use the following webui props:
\nwhen purpose == DEVELOPER
\nwebui_developer_user_invitation_email_subject
\nwebui_developer_user_invitation_email_from
\nwebui_developer_user_invitation_email_text
\nwebui_developer_user_invitation_email_html_text
when purpose = == CUSTOMER
\nwebui_customer_user_invitation_email_subject
\nwebui_customer_user_invitation_email_from
\nwebui_customer_user_invitation_email_text
\nwebui_customer_user_invitation_email_html_text
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Create User Invitation.\n \n This endpoint will send an invitation email to the developers, then they can use the link to create the obp user.\n \n purpose filed only support:List(DEVELOPER, CUSTOMER).\n \n You can customise the email details use the following webui props:\n \n when purpose == DEVELOPER\n webui_developer_user_invitation_email_subject\n webui_developer_user_invitation_email_from\n webui_developer_user_invitation_email_text\n webui_developer_user_invitation_email_html_text\n \n when purpose = == CUSTOMER\n webui_customer_user_invitation_email_subject\n webui_customer_user_invitation_email_from\n webui_customer_user_invitation_email_text\n webui_customer_user_invitation_email_html_text\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER"},"success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"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-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User-Invitation","KYC"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"roles":[{"role":"CanCreateUserInvitation","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitation","connector_methods":[]},{"operation_id":"OBPv5.1.0-createConsumer","implemented_by":{"version":"OBPv5.1.0","function":"createConsumer"},"request_verb":"POST","request_url":"/obp/v5.1.0/management/consumers","summary":"Create a Consumer","description":"Create a Consumer (Authenticated access).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napp_name: appNameBank
\napp_type: Web
\ncompany: Tesobe GmbH
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nenabled: false
\nredirect_url: https://apisandbox.openbankproject.com
\nclient_certificate: client_certificate
\nlogo_url: logo_url
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\nconsumer_secret: xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Create a Consumer (Authenticated access).\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[client_certificate](/glossary#): client_certificate\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**consumer_secret**](/glossary#): xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","enabled":true,"client_certificate":"-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----","logo_url":"https://apisandbox.openbankproject.com/logo"},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","consumer_secret":"xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"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":["Consumer"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"client_certificate":{"type":"string"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"consumer_secret":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"roles":[{"role":"CanCreateConsumer","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers","connector_methods":[]},{"operation_id":"OBPv4.0.0-getMyCorrelatedEntities","implemented_by":{"version":"OBPv4.0.0","function":"getMyCorrelatedEntities"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/correlated-entities","summary":"Get Correlated Entities for the current User","description":"Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncorrelated_entities: correlated_entities
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\ninsert_date: 2020-01-27
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nvalue: 5987953
\n\n\n","description_markdown":"Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**correlated_entities**](/glossary#): correlated_entities\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_attributes**](/glossary#): user_attributes\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"correlated_entities":[{"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","user_attributes":[{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"}]}]}]},"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-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"correlated_entities":{"type":"array","items":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}}},"user_id":{"type":"string"}}}},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/correlated-entities","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerEmail","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerEmail"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/email","summary":"Update the email of a Customer","description":"Update an email of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update an email of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"email":"marko@tesobe.com"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerEmail","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/email","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateAtm","implemented_by":{"version":"OBPv5.1.0","function":"updateAtm"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","summary":"UPDATE ATM","description":"Update ATM.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","description_markdown":"Update ATM.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_type**](/glossary#): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":""},"success_response_body":{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":"","attributes":[{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"roles":[{"role":"CanUpdateAtm","requires_bank_id":true},{"role":"CanUpdateAtmAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyMoreInfo"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Delete more info of other bank account","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting more info","More Info cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":[]},{"operation_id":"OBPv3.0.0-getCustomersForUser","implemented_by":{"version":"OBPv3.0.0","function":"getCustomersForUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/current/customers","summary":"Get Customers for Current User","description":"Gets all Customers that are linked to a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","description_markdown":"Gets all Customers that are linked to a User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"19900101","relationship_status":"single","dependants":1,"dob_of_dependants":["19900101"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error."],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/current/customers","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createBankAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","summary":"Create bank level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the specified Bank.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the specified Bank.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","bank_id":"gh.29.uk","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateAccountNotificationWebhookAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateCounterpartyLimit","implemented_by":{"version":"OBPv5.1.0","function":"updateCounterpartyLimit"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","summary":"Update Counterparty Limit","description":"Update Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","description_markdown":"Update Counterparty Limit.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_limit_id**](/glossary#counterparty_limit_id): abc9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","example_request_body":{"currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100},"success_response_body":{"counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Counterparty-Limits"],"typed_request_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","connector_methods":[]},{"operation_id":"OBPv5.0.0-createAccount","implemented_by":{"version":"OBPv5.0.0","function":"createAccount"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Create Account (PUT)","description":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the PUT body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.\n\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.\n\nIf the PUT body USER_ID *is* specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.\n\nIf the PUT body USER_ID is *not* specified, the account will be owned by the logged in User.\n\nThe 'product_code' field SHOULD be a product_code from Product.\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.\n\nNote: The Amount MUST be zero.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"success_response_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20001: User not logged in. Authentication is required!","OBP-30107: Invalid User Id.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30106: Invalid Balance Amount.","OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00","OBP-30109: Initial Balance of Account must be Zero (0).","OBP-30105: Invalid Balance Currency.","OBP-30208: Account_ID already exists at the Bank.","OBP-50000: Unknown Error."],"tags":["Account","Onboarding"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"},"product_code":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"label":{"type":"string"},"branch_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateAccount","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"deleteEndpointMapping"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Delete Endpoint Mapping","description":"Delete a Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\n","description_markdown":"Delete a Endpoint Mapping.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\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":["Endpoint-Mapping"],"roles":[{"role":"CanDeleteEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getFirehoseAccountsAtOneBank","implemented_by":{"version":"OBPv4.0.0","function":"getFirehoseAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/firehose/accounts/views/VIEW_ID","summary":"Get Firehose Accounts at Bank","description":"Get Accounts which have a firehose view assigned to them.
\nThis endpoint allows bulk access to accounts.
\nRequires the CanUseFirehoseAtAnyBank Role
\nTo be shown on the list, each Account must have a firehose View linked to it.
\nA firehose view has is_firehose = true
\nFor VIEW_ID try 'owner'
\noptional request parameters for filter with attributes
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\nvalue: 5987953
\n\n","description_markdown":"Get Accounts which have a firehose view assigned to them.\n\nThis endpoint allows bulk access to accounts.\n\nRequires the CanUseFirehoseAtAnyBank Role\n\nTo be shown on the list, each Account must have a firehose View linked to it.\n\nA firehose view has is_firehose = true\n\nFor VIEW_ID try 'owner'\n\noptional request parameters for filter with attributes\nURL params example:\n /banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1\n\nto invalid Browser cache, add timestamp query parameter as follow, the parameter name must be `_timestamp_`\nURL params example:\n `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358`\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**account_rules**](/glossary#account_rules): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_attributes](/glossary#account_attributes): \n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","bank_id":"gh.29.uk","label":"My Account","number":"","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_rules":[{"scheme":"OVERDRAFT","value":"10"}]}]},"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: "],"tags":["Account","Account-Firehose","FirehoseData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"account_rules":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"id":{"type":"string"}}}}}},"roles":[{"role":"CanUseAccountFirehoseAtAnyBank","requires_bank_id":false},{"role":"CanUseAccountFirehose","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/firehose/accounts/views/VIEW_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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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-getMyPersonalUserAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getMyPersonalUserAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/user/attributes","summary":"Get My Personal User Attributes","description":"Get My Personal User Attributes.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nvalue: 5987953
\n","description_markdown":"Get My Personal User Attributes.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_attributes**](/glossary#): user_attributes\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"user_attributes":[{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"user_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/user/attributes","connector_methods":[]},{"operation_id":"OBPv5.1.0-getMetrics","implemented_by":{"version":"OBPv5.1.0","function":"getMetrics"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/metrics","summary":"Get Metrics","description":"Get API metrics rows. These are records of each REST API call.
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nYou can filter by the following fields by applying url parameters
\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 e.g.:from_date=1100-01-01T01:01:01.000Z Defaults to the Unix Epoch i.e. Thu Jan 01 00:00:00 UTC 1970
\n2 to_date e.g.:to_date=1100-01-01T01:01:01.000Z Defaults to a far future date i.e. Sat Jan 01 00:00:00 UTC 4000
\nNote: it is recommended you send a valid from_date (e.g. 5 seconds ago) and to_date (now + 1 second) if you want to get the latest records
\nOtherwise you may receive stale cached results.
3 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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\n\nduration: 5.123
\nimplemented_by_partial_function:
\n\n\nresponse_body: response_body
\nsource_ip: source_ip
\ntarget_ip: target_ip
\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 API metrics rows. These are records of each REST API call.\n\nrequire CanReadMetrics role\n\nFilters Part 1.*filtering* (no wilde cards etc.) parameters to GET /management/metrics\n\nYou can filter by the following fields by applying url parameters\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 e.g.:from_date=1100-01-01T01:01:01.000Z Defaults to the Unix Epoch i.e. Thu Jan 01 00:00:00 UTC 1970\n\n2 to_date e.g.:to_date=1100-01-01T01:01:01.000Z Defaults to a far future date i.e. Sat Jan 01 00:00:00 UTC 4000\n\nNote: it is recommended you send a valid from_date (e.g. 5 seconds ago) and to_date (now + 1 second) if you want to get the latest records\n Otherwise you may receive stale cached results.\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\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[**response_body**](/glossary#): response_body\n\n\n\n[**source_ip**](/glossary#): source_ip\n\n\n\n[**target_ip**](/glossary#): target_ip\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":"1099-12-31T21: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,"source_ip":"2001:0db8:3c4d:0015:0000:0000:1a2f:1a2b","target_ip":"2001:0db8:3c4d:0015:0000:0000:1a2f:1a2b","response_body":{"code":401,"message":"OBP-20001: User not logged in. Authentication is required!"}}]},"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"},"target_ip":{"type":"string"},"date":{"type":"string","format":"date-time"},"verb":{"type":"string"},"response_body":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}},"implemented_by_partial_function":{"type":"string"},"user_name":{"type":"string"},"source_ip":{"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":[]},{"operation_id":"OBPv2.0.0-deleteEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"deleteEntitlement"},"request_verb":"DELETE","request_url":"/obp/v2.0.0/users/USER_ID/entitlement/ENTITLEMENT_ID","summary":"Delete Entitlement","description":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ENTITLEMENT_ID](/glossary#entitlement_id): \n\n\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","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Role","User","Entitlement"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/entitlement/ENTITLEMENT_ID","connector_methods":[]},{"operation_id":"OBPv2.1.0-getTransactionRequestTypesSupportedByBank","implemented_by":{"version":"OBPv2.1.0","function":"getTransactionRequestTypesSupportedByBank"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-request-types","summary":"Get Transaction Request Types at Bank","description":"Get the list of the Transaction Request Types supported by the bank.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ntransaction_request_type: SEPA
\n\n","description_markdown":"Get the list of the Transaction Request Types supported by the bank.\n\nUser Authentication is Optional. The User need not be logged in.\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[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n","success_response_body":{"transaction_request_types":[{"transaction_request_type":"SandboxTan"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Transaction-Request","Bank"],"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"transaction_request_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyOpenCorporatesUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Add Open Corporates URL to Counterparty","description":"Add open corporates url to other bank account
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Add open corporates url to other bank account\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"open_corporates_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding an open corporate url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getBankAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes","summary":"Get Bank Attributes","description":"Get Bank Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_attributes: bank_attributes
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get Bank Attributes\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_attributes**](/glossary#): bank_attributes\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"bank_attributes":[{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_success_response_body":{"type":"object","properties":{"bank_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes","connector_methods":[]},{"operation_id":"OBPv3.0.0-dataWarehouseStatistics","implemented_by":{"version":"OBPv3.0.0","function":"dataWarehouseStatistics"},"request_verb":"POST","request_url":"/obp/v3.0.0/search/warehouse/statistics/INDEX/FIELD","summary":"Data Warehouse Statistics","description":"Search the data warehouse and get statistical aggregations over a warehouse field
\nDoes a stats aggregation over some numeric field:
\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanSearchWarehouseStats Role is required. You can request this below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/statistics/INDEX/FIELD
\nPOST /search/warehouse/statistics/ALL/FIELD
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\nnone:
\n","description_markdown":"Search the data warehouse and get statistical aggregations over a warehouse field\n\nDoes a stats aggregation over some numeric field:\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCanSearchWarehouseStats Role is required. You can request this below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\nPOST /search/warehouse/statistics/INDEX/FIELD\n\nPOST /search/warehouse/statistics/ALL/FIELD\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n[FIELD](/glossary#field): \n\n\n\n[INDEX](/glossary#index): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**match_all**](/glossary#match_all): \n\n\n\n[**query**](/glossary#query): \n\n\n\n[none](/glossary#none): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[none](/glossary#none): \n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{},"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":["Data-Warehouse"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{}},"roles":[{"role":"CanSearchWarehouseStatistics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/search/warehouse/statistics/INDEX/FIELD","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.
\nIntroduction:
\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\nTo use this endpoint, please supply a valid json-schema in the request body.
\nNote: It might take a few minutes for the newly created JSON Schema to take effect!
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON request body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. 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: Description of the object. 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\nIntroduction:\n\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\n\n\n\nTo use this endpoint, please supply a valid json-schema in the request body.\n\nNote: It might take a few minutes for the newly created JSON Schema to take effect!\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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): Description of the object. 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":"OBPv3.1.0-createMeeting","implemented_by":{"version":"OBPv3.1.0","function":"createMeeting"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings","summary":"Create Meeting (video conference/call)","description":"Create Meeting: Initiate a video conference/call with the bank.
\nThe Meetings resource contains meta data about video/other conference sessions
\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
\nLogin is required.
\nThis call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\ndate: 2020-01-27
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Create Meeting: Initiate a video conference/call with the bank.\n\nThe Meetings resource contains meta data about video/other conference sessions\n\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).\n\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).\n\nLogin is required.\n\nThis call is **experimental**. Currently staff_user_id is not set. Further calls will be needed to correctly set this.\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","example_request_body":{"provider_id":"Chris","purpose_id":"String, eg: onboarding","date":"1099-12-31T22:01:01Z","creator":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"invitees":[{"contact_details":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"status":"String, eg: Good"}]},"success_response_body":{"meeting_id":"UUID-String","provider_id":"Chris","purpose_id":"String, eg: onboarding","bank_id":"gh.29.uk","present":{"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"keys":{"session_id":"String","staff_token":"String","customer_token":"String"},"when":"1099-12-31T21:00:00Z","creator":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"invitees":[{"contact_details":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"status":"String, eg: Good"}]},"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-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_request_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/meetings","connector_methods":[]},{"operation_id":"OBPv3.1.0-getWebUiProps","implemented_by":{"version":"OBPv3.1.0","function":"getWebUiProps"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/webui_props","summary":"Get WebUiProps","description":"Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.
\nurl query parameter:
\nactive: It must be a boolean string. and If active = true, it will show
\ncombination of explicit (inserted) + implicit (default) method_routings.
eg:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/webui_props
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/webui_props?active=true
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","description_markdown":"Get the all WebUiProps key values, those props key with \"webui_\" can be stored in DB, this endpoint get all from DB.\n\nurl query parameter: \nactive: It must be a boolean string. and If active = true, it will show\n combination of explicit (inserted) + implicit (default) method_routings.\n\neg: \nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/webui_props\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/webui_props?active=true\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"webui_props":[{"name":"webui_api_explorer_url","value":"https://apiexplorer.openbankproject.com","web_ui_props_id":"web-ui-props-id"}]},"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":["WebUi-Props"],"typed_success_response_body":{"type":"object","properties":{"webui_props":{"type":"array","items":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetWebUiProps","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/webui_props","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAtms","implemented_by":{"version":"OBPv5.1.0","function":"getAtms"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/atms","summary":"Get Bank ATMS","description":"Returns information about ATMs for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 100 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\natms:
\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","description_markdown":"Returns information about ATMs for a single bank specified by BANK_ID including:\n\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n\nPagination:\n\nBy default, 100 records are returned.\n\nYou can use the url query parameters *limit* and *offset* for pagination\n\nUser Authentication is Optional. The User need not be logged in.\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[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_type**](/glossary#): \n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"atms":[{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":"","attributes":[{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false}]}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_success_response_body":{"type":"object","properties":{"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms","connector_methods":[]},{"operation_id":"OBPv5.1.0-createVRPConsentRequest","implemented_by":{"version":"OBPv5.1.0","function":"createVRPConsentRequest"},"request_verb":"POST","request_url":"/obp/v5.1.0/consumer/vrp-consent-requests","summary":"Create Consent Request VRP","description":"This endpoint is used to begin the process of creating a consent that may be used for Variable Recurring Payments (VRPs).
\nVRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis.
\nOnce granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the
\nCounterparty Limits linked to this particular consent are respected.
Client, Consumer or Application Authentication is mandatory for this endpoint.
\ni.e. the caller of this endpoint is the API Client, Consumer or Application rather than a specific User.
\nAt the end of the process the following objects are created in OBP or connected backend systems:
\n- An automatically generated View which controls access.
\n- A Counterparty that is the Beneficiary of the Variable Recurring Payments. The Counterparty specifies the Bank Account number or other routing address.
\n- Limits for the Counterparty which constrain the amount of money that can be sent to it in various periods (yearly, monthly, weekly).
The Account holder may modify the Counterparty or Limits e.g. to increase or decrease the maximum possible payment amounts or the frequencey of the payments.
\nIn the case of a public client we use the client_id and private key to obtain an access token, otherwise we use the client_id and client_secret.
\nThe obtained access token is used in the HTTP Authorization header of the request as follows:
Example:
\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0
After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint.
Application Access is Required. The Application must be authenticated.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\n\n\n\ncounterparty_name: John Smith Ltd.
\ncurrency: EUR
\nfrom_account: from_account
\nlimit: 100
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nscheme: OBP
\nto_account: to_account
\n\n\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","description_markdown":"This endpoint is used to begin the process of creating a consent that may be used for Variable Recurring Payments (VRPs).\n\nVRPs are useful in situations when a beneficiary needs to be paid different amounts on a regular basis.\n\nOnce granted, the consent allows its holder to initiate multiple Transaction Requests to the Counterparty defined in this endpoint as long as the\nCounterparty Limits linked to this particular consent are respected.\n\nClient, Consumer or Application Authentication is mandatory for this endpoint.\n\ni.e. the caller of this endpoint is the API Client, Consumer or Application rather than a specific User.\n\nAt the end of the process the following objects are created in OBP or connected backend systems:\n - An automatically generated View which controls access.\n - A Counterparty that is the Beneficiary of the Variable Recurring Payments. The Counterparty specifies the Bank Account number or other routing address.\n - Limits for the Counterparty which constrain the amount of money that can be sent to it in various periods (yearly, monthly, weekly).\n\nThe Account holder may modify the Counterparty or Limits e.g. to increase or decrease the maximum possible payment amounts or the frequencey of the payments.\n\n\nIn the case of a public client we use the client_id and private key to obtain an access token, otherwise we use the client_id and client_secret.\nThe obtained access token is used in the HTTP Authorization header of the request as follows:\n\nExample:\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0\n\nAfter successfully creating the VRP consent request, you need to call the `Create Consent By CONSENT_REQUEST_ID` endpoint to finalize the consent using the CONSENT_REQUEST_ID returned by this endpoint.\n\nApplication Access is Required. The Application must be authenticated.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON request body fields:**\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**counterparty_name**](/glossary#): John Smith Ltd.\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**from_account**](/glossary#): from_account\n\n\n\n[**limit**](/glossary#): 100\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**to_account**](/glossary#): to_account\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[phone_number](/glossary#phone_number): \n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_request_id**](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**payload**](/glossary#payload): payload\n\n\n","example_request_body":{"from_account":{"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"branch_routing":{"scheme":"OBP","address":"DERBY6"}},"to_account":{"counterparty_name":"John Smith Ltd.","bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"branch_routing":{"scheme":"OBP","address":"DERBY6"},"limit":{"currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100}},"email":"felixsmith@example.com","phone_number":"+44 07972 444 876","valid_from":"2026-03-16T21:00:25Z","time_to_live":3600},"success_response_body":{"consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","payload":{"from_account":{"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"branch_routing":{"scheme":"OBP","address":"DERBY6"}},"to_account":{"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"branch_routing":{"scheme":"OBP","address":"DERBY6"},"limit":{"currency":"EUR","max_single_amount":1000,"max_monthly_amount":10000,"max_number_of_monthly_transactions":10,"max_yearly_amount":12000,"max_number_of_yearly_transactions":100}},"valid_from":"2024-07-10T09:22:06Z","time_to_live":3600},"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-35020: You exceeded max value of time to live of consents.","OBP-20306: PEM Encoded Certificate cannot be found at request header.","OBP-20300: PEM Encoded Certificate issue.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","VRP","Transaction-Request"],"typed_request_body":{"type":"object","properties":{"to_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"counterparty_name":{"type":"string"},"limit":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"phone_number":{"type":"string"},"email":{"type":"string"},"from_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"time_to_live":{"type":"integer"},"valid_from":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"consumer_id":{"type":"string"},"payload":{"type":"object","properties":{"from_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}},"to_account":{"type":"object","properties":{"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"branch_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"limit":{"type":"object","properties":{"max_monthly_amount":{"type":"integer"},"max_number_of_yearly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"integer"},"currency":{"type":"string"},"max_single_amount":{"type":"integer"},"max_number_of_monthly_transactions":{"type":"integer"}}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}},"consent_request_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/vrp-consent-requests","connector_methods":[]},{"operation_id":"OBPv5.0.0-createConsentRequest","implemented_by":{"version":"OBPv5.0.0","function":"createConsentRequest"},"request_verb":"POST","request_url":"/obp/v5.0.0/consumer/consent-requests","summary":"Create Consent Request","description":"Client Authentication (mandatory)
\nIt is used when applications request an access token to access their own resources, not on behalf of a user.
\nThe client needs to authenticate themselves for this request.
\nIn case of public client we use client_id and private key to obtain access token, otherwise we use client_id and client_secret.
\nThe obtained access token is used in the HTTP Bearer auth header of our request.
Example:
\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0
After successfully creating the VRP consent request, you need to call the Create Consent By CONSENT_REQUEST_ID endpoint to finalize the consent.
Application Access is Required. The Application must be authenticated.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\naccount_access: account_access
\n\n\nbank_id: gh.29.uk
\n\n\nscheme: OBP
\nview_id: owner
\nbank_id: gh.29.uk
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","description_markdown":"Client Authentication (mandatory)\n\nIt is used when applications request an access token to access their own resources, not on behalf of a user.\n\nThe client needs to authenticate themselves for this request.\nIn case of public client we use client_id and private key to obtain access token, otherwise we use client_id and client_secret.\nThe obtained access token is used in the HTTP Bearer auth header of our request.\n\nExample:\nAuthorization: Bearer eXtneO-THbQtn3zvK_kQtXXfvOZyZFdBCItlPDbR2Bk.dOWqtXCtFX-tqGTVR0YrIjvAolPIVg7GZ-jz83y6nA0\n\nAfter successfully creating the VRP consent request, you need to call the `Create Consent By CONSENT_REQUEST_ID` endpoint to finalize the consent.\n\nApplication Access is Required. The Application must be authenticated.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON request body fields:**\n\n\n\n[**account_access**](/glossary#): account_access\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**everything**](/glossary#everything): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[entitlements](/glossary#entitlements): \n\n\n\n[phone_number](/glossary#phone_number): \n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_request_id**](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**payload**](/glossary#payload): payload\n\n\n","example_request_body":{"everything":false,"account_access":[{"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","email":"felixsmith@example.com","phone_number":"+44 07972 444 876","valid_from":"2026-03-16T21:00:25Z","time_to_live":3600},"success_response_body":{"consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","payload":{"everything":false,"account_access":[{"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"view_id":"owner"}],"phone_number":"+44 07972 444 876","valid_from":"2022-06-14T12:42:00Z","time_to_live":3600},"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-35020: You exceeded max value of time to live of consents.","OBP-20306: PEM Encoded Certificate cannot be found at request header.","OBP-20300: PEM Encoded Certificate issue.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"account_access":{"type":"array","items":{"type":"object","properties":{"view_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"everything":{"type":"boolean"},"phone_number":{"type":"string"},"email":{"type":"string"},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"valid_from":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"payload":{"type":"object","properties":{"phone_number":{"type":"string"},"everything":{"type":"boolean"},"account_access":{"type":"array","items":{"type":"object","properties":{"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"view_id":{"type":"string"}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionType","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionType"},"request_verb":"PUT","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-types","summary":"Create Transaction Type at bank","description":"Create Transaction Types for the bank specified by BANK_ID:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\n\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nvalue: 5987953
\n","description_markdown":"Create Transaction Types for the bank specified by BANK_ID:\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**amount**](/glossary#): 10.12\n\n\n\n[**bankId**](/glossary#bankid): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**shortCode**](/glossary#shortcode): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}},"success_response_body":{"id":{"value":"123"},"bankId":{"value":"gh.uk.9j"},"shortCode":"80080","summary":"SANDBOX_TAN","description":"This is the sandbox mode, charging litter money.","charge":{"currency":"EUR","amount":"100"}},"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-10001: Incorrect json format.","OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"bankId":{"type":"object","properties":{"value":{"type":"string"}}},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"},"shortCode":{"type":"string"},"description":{"type":"string"},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"roles":[{"role":"CanCreateTransactionType","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/transaction-types","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID","summary":"Delete Bank Cascade","description":"Delete a Bank Cascade specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete a Bank Cascade specified by BANK_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","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":["Bank"],"roles":[{"role":"CanDeleteBankCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyImageUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Add image url to other bank account","description":"Add a url that points to the logo of the counterparty
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Add a url that points to the logo of the counterparty\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"image_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding an image url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"image_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteCustomerCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteCustomerCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/customers/CUSTOMER_ID","summary":"Delete Customer Cascade","description":"Delete a Customer Cascade specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete a Customer Cascade specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer"],"roles":[{"role":"CanDeleteCustomerCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID/customers/CUSTOMER_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getUserAuthContexts","implemented_by":{"version":"OBPv5.0.0","function":"getUserAuthContexts"},"request_verb":"GET","request_url":"/obp/v5.0.0/users/USER_ID/auth-context","summary":"Get User Auth Contexts","description":"Get User Auth Contexts for a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\ntime_stamp: 1100-01-01T01:01:01.000Z
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","description_markdown":"Get User Auth Contexts for a User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**time_stamp**](/glossary#): 1100-01-01T01:01:01.000Z\n\n\n\n[**user_auth_context_id**](/glossary#user_auth_context_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","time_stamp":"1099-12-31T21:00:00Z","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"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":["User"],"typed_success_response_body":{"type":"object","properties":{"consumer_id":{"type":"string"},"time_stamp":{"type":"string","format":"date-time"},"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanGetUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/auth-context","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountPrivateAlias"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Get Other Account Private Alias","description":"Returns the private alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the private alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n","success_response_body":{"alias":"String"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow private alias access","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv3.1.0-getAccountWebhooks","implemented_by":{"version":"OBPv3.1.0","function":"getAccountWebhooks"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/banks/BANK_ID/account-web-hooks","summary":"Get Account Webhooks","description":"Get Account Webhooks.
\nPossible custom URL parameters for pagination:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n","description_markdown":"Get Account Webhooks.\n\nPossible custom URL parameters for pagination:\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n* account_id=STRING (if null ignore)\n* user_id=STRING (if null ignore)\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**web_hooks**](/glossary#web_hooks): \n\n\n","success_response_body":{"web_hooks":[{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":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":["Webhook","Bank"],"typed_success_response_body":{"type":"object","properties":{"web_hooks":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetWebhooks","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserInvitations","implemented_by":{"version":"OBPv4.0.0","function":"getUserInvitations"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitations","summary":"Get User Invitations","description":"Get User Invitations
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Get User Invitations\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User-Invitation"],"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"roles":[{"role":"CanGetUserInvitation","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitations","connector_methods":[]},{"operation_id":"OBPv5.0.0-getBank","implemented_by":{"version":"OBPv5.0.0","function":"getBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID","summary":"Get Bank","description":"Get the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Get the bank specified by BANK_ID\nReturns information about a single bank specified by BANK_ID including:\n\n* Bank code and full name of bank\n* Logo URL\n* Website\n\nUser Authentication is Optional. The User need not be logged in.\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[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"OBPv3.1.0-getCheckbookOrders","implemented_by":{"version":"OBPv3.1.0","function":"getCheckbookOrders"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/checkbook/orders","summary":"Get Checkbook orders","description":"Get all checkbook orders
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\naccount_type: AC
\n\nbank_id: gh.29.uk
\n\n\n\n\n\norder_date: 2020-01-27
\n\n\nscheme: OBP
\n\n\n","description_markdown":"Get all checkbook orders\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**account_type**](/glossary#): AC\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routings**](/glossary#branch_routings): \n\n\n\n[**distribution_channel**](/glossary#distribution_channel): \n\n\n\n[**first_check_number**](/glossary#first_check_number): \n\n\n\n[**number_of_checkbooks**](/glossary#number_of_checkbooks): \n\n\n\n[**order**](/glossary#order): \n\n\n\n[**order_date**](/glossary#order_date): 2020-01-27\n\n\n\n[**order_id**](/glossary#order_id): \n\n\n\n[**orders**](/glossary#orders): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**shipping_code**](/glossary#shipping_code): \n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"account":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_type":"330","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"branch_routings":[{"scheme":"OBP","address":"DERBY6"}]},"orders":[{"order":{"order_id":"xjksajfkj","order_date":"07082013","number_of_checkbooks":"4","distribution_channel":"1201","status":"2","first_check_number":"5165276","shipping_code":"1"}}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50211: Connector did not return the set of check book.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"branch_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_id":{"type":"string"}}},"orders":{"type":"array","items":{"type":"object","properties":{"order":{"type":"object","properties":{"shipping_code":{"type":"string"},"number_of_checkbooks":{"type":"string"},"status":{"type":"string"},"order_id":{"type":"string"},"distribution_channel":{"type":"string"},"first_check_number":{"type":"string"},"order_date":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/checkbook/orders","connector_methods":[]},{"operation_id":"OBPv5.0.0-answerUserAuthContextUpdateChallenge","implemented_by":{"version":"OBPv5.0.0","function":"answerUserAuthContextUpdateChallenge"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge","summary":"Answer User Auth Context Update Challenge","description":"Answer User Auth Context Update Challenge.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","description_markdown":"Answer User Auth Context Update Challenge.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[AUTH_CONTEXT_UPDATE_ID](/glossary#auth_context_update_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**user_auth_context_update_id**](/glossary#user_auth_context_update_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"answer":"123"},"success_response_body":{"user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","status":"INITIATED","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"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-10001: Incorrect json format.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["User"],"typed_request_body":{"type":"object","properties":{"answer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"getBankAttribute"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Get Bank Attribute By BANK_ATTRIBUTE_ID","description":"Get Bank Attribute By BANK_ATTRIBUTE_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get Bank Attribute By BANK_ATTRIBUTE_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\n\n\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[**bank_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}},"roles":[{"role":"CanGetBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-corePrivateAccountsAllBanks","implemented_by":{"version":"OBPv3.0.0","function":"corePrivateAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/accounts","summary":"Get Accounts at all Banks (private)","description":"Returns the list of accounts containing private views for the user.
\nEach account lists the views available to the user.
optional request parameters:
\nwhole url example:
\n/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\naccount_type: AC
\n\n\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nscheme: OBP
\n\n\n","description_markdown":"Returns the list of accounts containing private views for the user.\nEach account lists the views available to the user.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**account_type**](/glossary#): AC\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n","success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"String","bank_id":"gh.29.uk","account_type":"330","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"views":[{"id":"owner","short_name":"owner","description":"This view is for the owner for the account.","is_public":false}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PrivateData","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"id":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"is_public":{"type":"boolean"},"short_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteCustomerAttribute","implemented_by":{"version":"OBPv4.0.0","function":"deleteCustomerAttribute"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/CUSTOMER_ID/attributes/CUSTOMER_ATTRIBUTE_ID","summary":"Delete Customer Attribute","description":"Delete Customer Attribute
\nCustomerAttributes are used to enhance the OBP Customer object with Bank specific entities.
\nDelete a Customer Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete Customer Attribute\n\n\nCustomerAttributes are used to enhance the OBP Customer object with Bank specific entities.\n\n \n\nDelete a Customer Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ATTRIBUTE_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\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-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":["Customer"],"roles":[{"role":"CanDeleteCustomerAttributeAtOneBank","requires_bank_id":true},{"role":"CanDeleteCustomerAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/CUSTOMER_ID/attributes/CUSTOMER_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateConsumerCertificate","implemented_by":{"version":"OBPv5.1.0","function":"updateConsumerCertificate"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/certificate","summary":"Update Consumer Certificate","description":"Update a Certificate for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Update a Certificate for a Consumer specified by CONSUMER_ID.\n\n Please note: Your consumer may be disabled as a result of this action.\n\n CONSUMER_ID can be obtained after you register the application.\n\n Or use the endpoint 'Get Consumers' to get it\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"certificate":"QmFnIEF0dHJpYnV0ZXMNCiAgICBsb2NhbEtleUlEOiBFMSA3RiBCMyBCOCBEQiA4QyA2NCBGNiA4QyA1NSAzNCA3QSAyNiBCRSBEMCBCNCBENCBBMyBGRCA2NiANCnN1YmplY3Q9QyA9IE1ELCBPID0gTUFJQiwgQ04gPSBNQUlCIFByaXNhY2FydSBTZXJnaXUgKFRlc3QpDQoNCmlzc3Vlcj1DID0gTUQsIE8gPSBCTk0sIE9VID0gRFRJLCBDTiA9IEJOTSBDQSAodGVzdCksIGVtYWlsQWRkcmVzcyA9IGFkbWluQGJubS5tZA0KDQotLS0tLUJFR0lOIENFUlRJRklDQVRFLS0tLS0NCk1JSUdoVENDQkcyZ0F3SUJBZ0lDQkRvd0RRWUpLb1pJaHZjTkFRRUZCUUF3WGpFTE1Ba0dBMVVFQmhNQ1RVUXgNCkREQUtCZ05WQkFvTUEwSk9UVEVNTUFvR0ExVUVDd3dEUkZSSk1SWXdGQVlEVlFRRERBMUNUazBnUTBFZ0tIUmwNCmMzUXBNUnN3R1FZSktvWklodmNOQVFrQkZneGhaRzFwYmtCaWJtMHViV1F3SGhjTk1qUXdOREU0TVRFME5qUXgNCldoY05Nall3TkRFNE1URTBOalF4V2pCRE1Rc3dDUVlEVlFRR0V3Sk5SREVOTUFzR0ExVUVDZ3dFVFVGSlFqRWwNCk1DTUdBMVVFQXd3Y1RVRkpRaUJRY21sellXTmhjblVnVTJWeVoybDFJQ2hVWlhOMEtUQ0NBU0l3RFFZSktvWkkNCmh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTFdYMzlFSmZLNEg5MDZKSVpMbHRxTU56amxDd3NyMm0rZjMNCjVYdHZ4SVY1akEvUWlZSDdDVjBQK0E1U2grKytaNldUb1NnQStQemYwdTdWYWRVbWtyWEZBV0lzOXlPemduUjQNCmZ5TVVSNXR4UWJYdmZYcXVJUS9XQ0ZnRHBIU3I4eWN0UHlsOGdsUjFidVF0UmlTdEdMT0RnalhsTmhTMlhTYTMNCmFwVGhUVHAya3o1dEoyWjBXRnlxa1ZVM1FJNkdNVGU5eWhDdnVZQkI1QWJuUUU4bXVPb2NNaEJkRFREY2ZGdW0NCk5paUozelhLMXZzKzEzNW5sZEMxOXozWnBuaVBSeER2WGthR00wc0xiNnk5T1NIOUdmYTZHcXJnendTTmpubEkNCnZCeWFlK1dtbG16TzlBZXVKNVRaUFhPdzNwcFdpTWdTOVlZOWp1UUtFQUFBQUFBQTQ4c0NBd0VBQWFPQ0FtWXcNCmdnSmlNQkVHQ1dDR1NBR0crRUlCQVFRRUF3SUZvREFwQmdOVkhTVUVJakFnQmdnckJnRUZCUWNEQWdZSUt3WUINCkJRVUhBd1FHQ2lzR0FRUUJnamNVQWdJd0hRWURWUjBPQkJZRUZGR2ptcXM4OXUyMXcvZmNHVlgrb0pNZSsvWTYNCk1JR1FCZ05WSFNNRWdZZ3dnWVdBRkh1ckdvcWhWYVFUVkJwRVlObmNnRUl5Vkd3dG9XS2tZREJlTVFzd0NRWUQNClZRUUdFd0pOUkRFTU1Bb0dBMVVFQ2d3RFFrNU5NUXd3Q2dZRFZRUUxEQU5FVkVreEZqQVVCZ05WQkFNTURVSk8NClRTQkRRU0FvZEdWemRDa3hHekFaQmdrcWhraUc5dzBCQ1FFV0RHRmtiV2x1UUdKdWJTNXRaSUlKQUpuU0UxdVoNCkU1MU5NQlFHQTFVZEVnUU5NQXVCQ1VOQlFHSnViUzV0WkRBMkJnbGdoa2dCaHZoQ0FRUUVLUlluYUhSMGNEb3YNCkwzQnJhUzVpYm0wdWJXUXZjR3RwTDNCMVlpOWpjbXd2WTJGamNtd3VZM0pzTURZR0NXQ0dTQUdHK0VJQkF3UXANCkZpZG9kSFJ3T2k4dmNHdHBMbUp1YlM1dFpDOXdhMmt2Y0hWaUwyTnliQzlqWVdOeWJDNWpjbXd3T0FZRFZSMGYNCkJERXdMekF0b0N1Z0tZWW5hSFIwY0RvdkwzQnJhUzVpYm0wdWJXUXZjR3RwTDNCMVlpOWpjbXd2WTJGamNtd3UNClkzSnNNRU1HQ0NzR0FRVUZCd0VCQkRjd05UQXpCZ2dyQmdFRkJRY3dBb1luYUhSMGNEb3ZMM2QzZHk1aWJtMHUNCmJXUXZjSFZpTDJOaFkyVnlkQzlqWVdObGNuUXVZM0owTUZBR0NXQ0dTQUdHK0VJQkRRUkRGa0ZMWlhrZ1VHRnANCmNpQkhaVzVsY21GMFpXUWdZbmtnVlc1cFEzSjVjSFFnZGk0d0xqWXVPQzQySUdadmNpQlFTME5USXpFeUxXWnANCmJHVWdjM1J2Y21GblpUQUpCZ05WSFJNRUFqQUFNQTRHQTFVZER3RUIvd1FFQXdJR1FEQU5CZ2txaGtpRzl3MEINCkFRVUZBQU9DQWdFQUpTU0ZhRWZOOWVna2wyYVFEc3QvVEtWWmxSbFdWZWkrVmZwMnM1ZXpWNG9ibnZRUXI5QkcNCmZrNklqaU8zbGZHTjQyTkVZSTV6SGh3SDl2WTRiMjM2ZkdMZWltbmZDc2lGb0FyTEtGUDR6Y0dvS0ZJR2ZBNDINCnQzSmxIcENvbmNpMmxqUzg4MzN2c1k5M2xGSzFTa2NvUjBMT0s0NzdaNlBWMjVtdjVjdmhCN1ZkNWs4SWpLU3MNCllwWkpaSi9STWZNT3dPQUtqeDFhWDNxQUhhNVhTOUNINEJaMEl4SnBYcWZpMm5GUFVNRy8yU0JmSTN4dDhsM1UNClJtVy9qZVRoRG5tL0Vsb05sb3pObzdRS3AvbysyUVBFZDBUWkFBdUljQWFiM09waUptOWlrUlh3c21mNkFmS0INCnIwQmtHcTFiTi9RQk1DMDM4RHA4S1pKZmdmaTYxYnBiVUNFdDRsVWY0R252TW9FdjZnbTh1czE2VTI1d0Y0SUwNCnd5cmFBZHJUVHhaWEVydGY2c3pWY2JBRUY0QmdFM0hCVmF2V2FxbDZac1FFRFJoTGVtWVJwMHhleUtwYXI4d3INClhqN1oycmJteWpFci9ES1hMdHF2UlFIQVVrVDBEQXRST2R4NmpsNUtGSFVvbTM2QUZmeU5UcjJ6a0p2MkZWTlENCmc0TnJMRnk0WldidE84ZDc2M2NoMEpjaWYzZUdadnFmQnVETUs3Q25jUWluamxVcTg1cFpzeGlFUW56VTJOdGgNClRFUzBqZjZ6ZS9ibHpVaUsrRXlyeWpEeWNaYlk3RHlwWWVlTlJJbk9zVUVjZmtFT3BVL3dFTG83dnpNaGY1b2MNCmdjcUFKSzdOQWlEQzVHR0Iyb296ZzNSTTJBbGdPT1ZpRFZwRzRMaUxPenpqVStqaXlyclY3OGs9DQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tDQo="},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"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":["Consumer"],"typed_request_body":{"type":"object","properties":{"certificate":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"roles":[{"role":"CanUpdateConsumerCertificate","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/certificate","connector_methods":[]},{"operation_id":"OBPv2.0.0-addSocialMediaHandle","implemented_by":{"version":"OBPv2.0.0","function":"addSocialMediaHandle"},"request_verb":"POST","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Create Customer Social Media Handle","description":"Create a customer social media handle for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\ncustomer_number: 5987953
\n\n\n\ntype:
\nJSON response body fields:
\n\n","description_markdown":"Create a customer social media handle for the customer specified by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_activated**](/glossary#date_activated): \n\n\n\n[**date_added**](/glossary#date_added): \n\n\n\n[**handle**](/glossary#handle): \n\n\n\n[**type**](/glossary#type): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"customer_number":"5987953","type":"PlaceholderString","handle":"PlaceholderString","date_added":"1099-12-31T21:00:00Z","date_activated":"1099-12-31T21:00:00Z"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20006: User is missing one or more roles: ","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"type":{"type":"string"},"date_activated":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"handle":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanAddSocialMediaHandle","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllBankLevelEndpointMappings","implemented_by":{"version":"OBPv4.0.0","function":"getAllBankLevelEndpointMappings"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoint-mappings","summary":"Get all Bank Level Endpoint Mappings","description":"Get all Bank Level Endpoint Mappings.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Get all Bank Level Endpoint Mappings.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","success_response_body":{"endpoint-mappings":[{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}]},"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":["Endpoint-Mapping"],"typed_success_response_body":{"type":"object","properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllBankLevelEndpointMappings","requires_bank_id":true},{"role":"CanGetAllEndpointMappings","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerAddress","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerAddress"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","summary":"Update the Address of a Customer","description":"Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","description_markdown":"Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ADDRESS_ID](/glossary#customer_address_id): \n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**customer_address_id**](/glossary#customer_address_id): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK"},"success_response_body":{"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK","insert_date":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"city":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"insert_date":{"type":"string","format":"date-time"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateCardAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateCardAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/card","summary":"Create or Update Card Attribute Definition","description":"Create or Update Card Attribute Definition
\nThe category field must be Card
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Card Attribute Definition\n\nThe category field must be Card\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Card","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Card","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateCardAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/card","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateAgentStatus","implemented_by":{"version":"OBPv5.1.0","function":"updateAgentStatus"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","summary":"Update Agent status","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[AGENT_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\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[**agent_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**is_confirmed_agent**](/glossary#): is_confirmed_agent\n\n\n\n[**is_pending_agent**](/glossary#): is_pending_agent\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n","example_request_body":{"is_pending_agent":false,"is_confirmed_agent":true},"success_response_body":{"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","legal_name":"Eveline Tripman","mobile_phone_number":"+49 30 901820","agent_number":"5987953","currency":"EUR","is_confirmed_agent":false,"is_pending_agent":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-10001: Incorrect json format.","OBP-30201: Agent not found. Please specify a valid value for AGENT_ID. ","OBP-30325: Agent Account Link not found.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"is_pending_agent":{"type":"boolean"},"is_confirmed_agent":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}},"roles":[{"role":"CanUpdateAgentStatusAtAnyBank","requires_bank_id":false},{"role":"CanUpdateAgentStatusAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getTransactionRequestById","implemented_by":{"version":"OBPv5.1.0","function":"getTransactionRequestById"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/transaction-requests/TRANSACTION_REQUEST_ID","summary":"Get Transaction Request by ID","description":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-60010: Get Transaction Requests Exception. ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"roles":[{"role":"CanGetTransactionRequestAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/transaction-requests/TRANSACTION_REQUEST_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCardAttribute","implemented_by":{"version":"OBPv3.1.0","function":"updateCardAttribute"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID/attributes/CARD_ATTRIBUTE_ID","summary":"Update Card Attribute","description":"Update Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ATTRIBUTE_ID: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","description_markdown":"Update Card Attribute\n\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Card Attribute is linked to its Card by CARD_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CARD_ATTRIBUTE_ID](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[CARD_ID](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DOUBLE","value":"2012-04-23"},"success_response_body":{"name":"OVERDRAFT_START_DATE","card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","attribute_type":"DOUBLE","bank_id":{"value":"gh.29.uk"},"value":"2012-04-23","card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"card_id":{"type":"string"},"name":{"type":"string"},"card_attribute_id":{"type":"string"},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards/CARD_ID/attributes/CARD_ATTRIBUTE_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.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nNote: Resource Docs are cached, TTL is 3600 seconds\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv4.0.0-getCoreAccountById","implemented_by":{"version":"OBPv4.0.0","function":"getCoreAccountById"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/account","summary":"Get Account by Id (Core)","description":"Information returned about the account specified by ACCOUNT_ID:
\nThis call returns the owner view and requires access to that view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nproduct_code: 1234BW
\nscheme: OBP
\n\n","description_markdown":"Information returned about the account specified by ACCOUNT_ID:\n\n* Number - The human readable account number given by the bank that identifies the account.\n* Label - A label given by the owner of the account\n* Owners - Users that own this account\n* Type - The type of account\n* Balance - Currency and Value\n* Account Routings - A list that might include IBAN or national account identifiers\n* Account Rules - A list that might include Overdraft and other bank specific rules\n* Tags - A list of Tags assigned to this account\n\nThis call returns the owner view and requires access to that view.\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**views_basic**](/glossary#views_basic): \n\n\n","success_response_body":{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","bank_id":"gh.29.uk","label":"My Account","number":"546387432","product_code":"AC","balance":{"currency":"EUR","amount":"0"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"views_basic":["owner"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"views_basic":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"product_code":{"type":"string"},"id":{"type":"string"},"number":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/account","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomerMessages","implemented_by":{"version":"OBPv4.0.0","function":"getCustomerMessages"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","summary":"Get Customer Messages for a Customer","description":"Get messages for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ndate: 2020-01-27
\nfrom_department: Open Bank
\nfrom_person: Tom
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nmessage: 123456
\n\ntransport: SMS
\n","description_markdown":"Get messages for the customer specified by CUSTOMER_ID\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**messages**](/glossary#messages): \n\n\n\n[**transport**](/glossary#transport): SMS\n\n\n","success_response_body":{"messages":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","date":"1099-12-31T21:00:00Z","transport":"SMS","message":"123456","from_department":"Open Bank","from_person":"Tom"}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer-Message","Customer"],"typed_success_response_body":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"date":{"type":"string","format":"date-time"},"transport":{"type":"string"},"id":{"type":"string"},"from_person":{"type":"string"},"from_department":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerMessages","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","connector_methods":[]},{"operation_id":"OBPv4.0.0-getProducts","implemented_by":{"version":"OBPv4.0.0","function":"getProducts"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products","summary":"Get Products","description":"Returns information about the financial products offered by a bank specified by BANK_ID including:
\nCan filter with attributes name and values.
\nURL params example: /banks/some-bank-id/products?&limit=50&offset=1
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\n\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","description_markdown":"Returns information about the financial products offered by a bank specified by BANK_ID including:\n\n* Name\n* Code\n* Parent Product Code\n* More info URL\n* Terms And Conditions URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\n\nCan filter with attributes name and values.\nURL params example: /banks/some-bank-id/products?&limit=50&offset=1\n\nUser Authentication is Optional. The User need not be logged in.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n","success_response_body":{"products":[{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"Description of the object. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products","connector_methods":[]},{"operation_id":"OBPv5.1.0-createUserWithAccountAccessById","implemented_by":{"version":"OBPv5.1.0","function":"createUserWithAccountAccessById"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/user-account-access","summary":"Create (DAuth) User with Account Access","description":"This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.
\nPut the smart contract address in username
\nFor provider use "dauth"
\nThis endpoint will create the (DAuth) User with username and provider if the User does not already exist.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the logged in user needs to be account holder.
\nFor information about DAuth see below:
\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n![http://www.example.com/id-docs/123/image.png](\"http://www.example.com/id-docs/123/image.png\"){kind=link}
# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n) your-RSA-key-pair
\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nis_system: true
\nprovider: ETHEREUM
\nusername: felixsmith
\nview_id: owner
\n\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"This endpoint is used as part of the DAuth solution to grant access to account and transaction data to a smart contract on the blockchain.\n\nPut the smart contract address in username\n\nFor provider use \"dauth\"\n\nThis endpoint will create the (DAuth) User with username and provider if the User does not already exist.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the logged in user needs to be account holder.\n\nFor information about DAuth see below:\n\n\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n\n) your-RSA-key-pair\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
Waiting For Godot
\nUses query parameter "sleep" in milliseconds.
\nFor instance: .../waiting-for-godot?sleep=50 means postpone response in 50 milliseconds.
User Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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.","OBP-00014: Mandatory properties must be 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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv4.0.0-createSettlementAccount","implemented_by":{"version":"OBPv4.0.0","function":"createSettlementAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/settlement-accounts","summary":"Create Settlement Account","description":"Create a new settlement account at a bank.
\nThe created settlement account id will be the concatenation of the payment system and the account currency.
\nFor examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD
By default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID
\nThose two accounts have EUR as default currency.
If you want to create default settlement account for a specific currency, you can fill the payment_system field with the DEFAULT value.
When a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.
\nIf no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.
\n- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.
\n- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.
\n- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.
If the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the POST body USER_ID is not specified, the account will be owned by the logged in User.
\nNote: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\npayment_system: SEPA
\nscheme: OBP
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Create a new settlement account at a bank.\n\nThe created settlement account id will be the concatenation of the payment system and the account currency.\nFor examples: SEPA_SETTLEMENT_ACCOUNT_EUR, CARD_SETTLEMENT_ACCOUNT_USD\n\nBy default, when you create a new bank, two settlements accounts are created automatically: OBP_DEFAULT_INCOMING_ACCOUNT_ID and OBP_DEFAULT_OUTGOING_ACCOUNT_ID\nThose two accounts have EUR as default currency.\n\nIf you want to create default settlement account for a specific currency, you can fill the `payment_system` field with the `DEFAULT` value.\n\nWhen a transaction is saved in OBP through the mapped connector, OBP-API look for the account to save the double-entry transaction.\nIf no OBP account can be found from the counterparty, the double-entry transaction will be saved on a bank settlement account.\n- First, the mapped connector looks for a settlement account specific to the payment system and currency. E.g SEPA_SETTLEMENT_ACCOUNT_EUR.\n- If we don't find any specific settlement account with the payment system, we look for a default settlement account for the counterparty currency. E.g DEFAULT_SETTLEMENT_ACCOUNT_EUR.\n- Else, we select one of the two OBP default settlement accounts (OBP_DEFAULT_INCOMING_ACCOUNT_ID/OBP_DEFAULT_OUTGOING_ACCOUNT_ID) according to the transaction direction.\n\nIf the POST body USER_ID *is* specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.\n\nIf the POST body USER_ID is *not* specified, the account will be owned by the logged in User.\n\nNote: The Amount MUST be zero.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"success_response_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00","OBP-30109: Initial Balance of Account must be Zero (0).","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-50000: Unknown Error."],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateSettlementAccountAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/settlement-accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAccountByAccountRouting","implemented_by":{"version":"OBPv4.0.0","function":"getAccountByAccountRouting"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/accounts/account-routing-query","summary":"Get Account by Account Routing","description":"This endpoint returns the account (if it exists) linked with the provided scheme and address.
\nThe bank_id field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.
Example of account routing scheme: IBAN, "OBP", "AccountNumber", ...
\nExample of account routing address: DE17500105178275645584, "321774cc-fccd-11ea-adc1-0242ac120002", "55897106215", ...
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\n\nscheme: OBP
\nbank_id: gh.29.uk
\nJSON response body fields:
\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","description_markdown":"This endpoint returns the account (if it exists) linked with the provided scheme and address.\n\nThe `bank_id` field is optional, but if it's not provided, we don't guarantee that the returned account is unique across all the banks.\n\nExample of account routing scheme: `IBAN`, \"OBP\", \"AccountNumber\", ...\nExample of account routing address: `DE17500105178275645584`, \"321774cc-fccd-11ea-adc1-0242ac120002\", \"55897106215\", ...\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"bank_id":"gh.29.uk","account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NoneLabel","number":"123","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/accounts/account-routing-query","connector_methods":[]},{"operation_id":"OBPv3.1.0-getProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"getProductCollection"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Get Product Collection","description":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\n\nproduct_code: 1234BW
\n\n\ntype:
\nvalue: 5987953
\n\n","description_markdown":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**collection_code**](/glossary#collection_code): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_attributes](/glossary#product_attributes): \n\n\n","success_response_body":{"collection_code":"A","products":[{"bank_id":"gh.29.uk","code":"1234BW","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"product_attributes":[{"product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"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-50000: Unknown Error."],"tags":["Product-Collection","Product"],"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"name":{"type":"string"},"category":{"type":"string"}}}},"collection_code":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-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":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\n\n\nDelete Api Collection Endpoint By OPERATION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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":"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).
Note: Rate limiting can be set at the Consumer level and also for anonymous calls.
\nSee the consumer rate limits / call limits endpoints.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nenabled: false
\nis_active: false
\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\nNote: Rate limiting can be set at the Consumer level and also for anonymous calls.\n\nSee the consumer rate limits / call limits endpoints.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**is_active**](/glossary#is_active): false\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","Rate-Limits"],"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":[]},{"operation_id":"OBPv4.0.0-getUsersByEmail","implemented_by":{"version":"OBPv4.0.0","function":"getUsersByEmail"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/email/EMAIL/terminator","summary":"Get Users by Email Address","description":"Get users by email address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
URL Parameters:
\n\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","description_markdown":"Get users by email address\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nCanGetAnyUser entitlement is required,\n\n\n**URL Parameters:**\n\n[EMAIL](/glossary#): felixsmith@example.com\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**is_deleted**](/glossary#): is_deleted\n\n\n\n[**is_locked**](/glossary#): is_locked\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**text**](/glossary#text): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[agreements](/glossary#): agreements\n\n\n\n[last_marketing_agreement_signed_date](/glossary#): last_marketing_agreement_signed_date\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"agreements":[{"type":"","text":""}],"is_deleted":false,"last_marketing_agreement_signed_date":"1099-12-31T21:00:00Z","is_locked":false}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-20007: User not found by email.","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/email/EMAIL/terminator","connector_methods":[]},{"operation_id":"OBPv3.1.0-enableDisableConsumers","implemented_by":{"version":"OBPv3.1.0","function":"enableDisableConsumers"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/consumers/CONSUMER_ID","summary":"Enable or Disable Consumers","description":"Enable/Disable a Consumer specified by CONSUMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nenabled: false
\n","description_markdown":"Enable/Disable a Consumer specified by CONSUMER_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n","example_request_body":{"enabled":false},"success_response_body":{"enabled":false},"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":["Consumer"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"roles":[{"role":"CanEnableConsumers","requires_bank_id":false},{"role":"CanDisableConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addImageForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Add a Transaction Image","description":"Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe image is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nlabel: My Account
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Posts an image about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nThe image is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","example_request_body":{"label":"String","URL":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-10017: Incorrect URL Format. ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCustomersForUserIdsOnly","implemented_by":{"version":"OBPv5.1.0","function":"getCustomersForUserIdsOnly"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/current/customers/customer_ids","summary":"Get Customers for Current User (IDs only)","description":"Gets all Customers Ids that are linked to a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","description_markdown":"Gets all Customers Ids that are linked to a User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"19900101","relationship_status":"single","dependants":1,"dob_of_dependants":["19900101"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error."],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/current/customers/customer_ids","connector_methods":[]},{"operation_id":"OBPv4.0.0-createMyPersonalUserAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createMyPersonalUserAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/my/user/attributes","summary":"Create My Personal User Attribute","description":"Create My Personal User Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","description_markdown":"Create My Personal User Attribute\n\nThe `type` field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"BATTERY_LEVEL","type":"STRING","value":"90"},"success_response_body":{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["User"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/user/attributes","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomersAtOneBank","implemented_by":{"version":"OBPv5.0.0","function":"getCustomersAtOneBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/customers","summary":"Get Customers at Bank","description":"Get Customers at Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Get Customers at Bank.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"19900101","relationship_status":"single","dependants":1,"dob_of_dependants":["19900101"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:25Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetCustomers","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers","connector_methods":[]},{"operation_id":"OBPv4.0.0-getProductFee","implemented_by":{"version":"OBPv4.0.0","function":"getProductFee"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Get Product Fee","description":"Get Product Fee
\nGet one product fee by its id.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Product Fee\n\nGet one product fee by its id.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-checkFundsAvailable","implemented_by":{"version":"OBPv3.1.0","function":"checkFundsAvailable"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/funds-available","summary":"Check Available Funds","description":"Check Available Funds
\nMandatory URL parameters:
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ndate: 2020-01-27
\n","description_markdown":"Check Available Funds\nMandatory URL parameters:\n\n* amount=NUMBER\n* currency=STRING\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n[**available_funds_request_id**](/glossary#available_funds_request_id): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n","success_response_body":{"answer":"yes","date":"2026-03-16T21:00:23Z","available_funds_request_id":"c4ykz59svsr9b7fmdxk8ezs7"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20054: Invalid amount. Please specify a valid value for amount.","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-50000: Unknown Error."],"tags":["Account","Confirmation of Funds Service (PIIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"available_funds_request_id":{"type":"string"},"answer":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/funds-available","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestFreeForm","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestFreeForm"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","summary":"Create Transaction Request (FREE_FORM)","description":"For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"For an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[FREE_FORM](/glossary#free_form): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"description":"This is a FREE_FORM Transaction Request"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"roles":[{"role":"CanCreateAnyTransactionRequest","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAllRegulatedEntityAttributes","implemented_by":{"version":"OBPv5.1.0","function":"getAllRegulatedEntityAttributes"},"request_verb":"GET","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes","summary":"Get All Regulated Entity Attributes","description":"Get all attributes for the specified Regulated Entity.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nattributes: attribute value in form of (name, value)
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get all attributes for the specified Regulated Entity.\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**regulated_entity_attribute_id**](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**regulated_entity_id**](/glossary#): regulated_entity_id\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"attributes":[{"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","attribute_type":"","value":"5987953","is_active":false}]},"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":["Directory","API"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetRegulatedEntityAttributes","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteSystemViewPermission","implemented_by":{"version":"OBPv5.1.0","function":"deleteSystemViewPermission"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/system-views/VIEW_ID/permissions/PERMISSION_NAME","summary":"Delete Permission to a System View","description":"Delete Permission to a System View
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPERMISSION_NAME: PERMISSION_NAME
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete Permission to a System View\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[PERMISSION_NAME](/glossary#): PERMISSION_NAME\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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":["View-System"],"roles":[{"role":"CanDeleteSystemViewPermission","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views/VIEW_ID/permissions/PERMISSION_NAME","connector_methods":[]},{"operation_id":"OBPv2.0.0-getSocialMediaHandles","implemented_by":{"version":"OBPv2.0.0","function":"getSocialMediaHandles"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Get Customer Social Media Handles","description":"Get social media handles for a customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncustomer_number: 5987953
\n\n\n\ntype:
\n","description_markdown":"Get social media handles for a customer specified by CUSTOMER_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**checks**](/glossary#checks): \n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date_activated**](/glossary#date_activated): \n\n\n\n[**date_added**](/glossary#date_added): \n\n\n\n[**handle**](/glossary#handle): \n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"checks":[{"customer_number":"5987953","type":"PlaceholderString","handle":"PlaceholderString","date_added":"1099-12-31T21:00:00Z","date_activated":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"date_added":{"type":"string","format":"date-time"},"type":{"type":"string"},"date_activated":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"handle":{"type":"string"}}}}}},"roles":[{"role":"CanGetSocialMediaHandles","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateCustomerAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateCustomerAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes/CUSTOMER_ATTRIBUTE_ID","summary":"Update Customer Attribute","description":"Update Customer Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Customer Attribute\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ATTRIBUTE_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"},"success_response_body":{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanUpdateCustomerAttributeAtOneBank","requires_bank_id":true},{"role":"CanUpdateCustomerAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes/CUSTOMER_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPublicAlias"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Update public alias of other bank account","description":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating the public alias","Alias cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCustomerAddresses","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerAddresses"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses","summary":"Get Customer Addresses","description":"Get the Addresses of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ncity:
\ncountry_code: 1254
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\n\n\n\n\n\n\ntags: Create-My-User
\n","description_markdown":"Get the Addresses of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**addresses**](/glossary#addresses): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**customer_address_id**](/glossary#customer_address_id): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"addresses":[{"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE","tags":["mailing","home"],"status":"OK","insert_date":"1099-12-31T21:00: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":["Customer","KYC"],"typed_success_response_body":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"customer_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"insert_date":{"type":"string","format":"date-time"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"customer_address_id":{"type":"string"},"state":{"type":"string"},"status":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAccountsHeldByUser","implemented_by":{"version":"OBPv5.1.0","function":"getAccountsHeldByUser"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/USER_ID/accounts-held","summary":"Get Accounts Held By User","description":"Get Accounts held by the User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/users/USER_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","description_markdown":"Get Accounts held by the User if even the User has not been assigned the owner View yet.\n\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/users/USER_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n","success_response_body":{"accounts":[{"id":"7b97bd26-583b-4c3b-8282-55ea9d934aad","label":"My Account","bank_id":"123","number":"123","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]}]},"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-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAccountsHeldAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/accounts-held","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllBankLevelDynamicMessageDocs","implemented_by":{"version":"OBPv4.0.0","function":"getAllBankLevelDynamicMessageDocs"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-message-docs","summary":"Get all Bank Level Dynamic Message Docs","description":"Get all Bank Level Dynamic Message Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Get all Bank Level Dynamic Message Docs.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","success_response_body":{"dynamic-message-docs":[{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"}]},"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-Message-Doc"],"typed_success_response_body":{"type":"object","properties":{"dynamic-message-docs":{"type":"array","items":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllDynamicMessageDocs","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-message-docs","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteUserAuthContexts","implemented_by":{"version":"OBPv3.1.0","function":"deleteUserAuthContexts"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/users/USER_ID/auth-context","summary":"Delete User's Auth Contexts","description":"Delete the Auth Contexts of a User specified by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete the Auth Contexts of a User specified by USER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","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":["User"],"roles":[{"role":"CanDeleteUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/auth-context","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUsers","implemented_by":{"version":"OBPv4.0.0","function":"getUsers"},"request_verb":"GET","request_url":"/obp/v4.0.0/users","summary":"Get all Users","description":"Get all users
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","description_markdown":"Get all users\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCanGetAnyUser entitlement is required,\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n* locked_status (if null ignore)\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**is_deleted**](/glossary#): is_deleted\n\n\n\n[**is_locked**](/glossary#): is_locked\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**text**](/glossary#text): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[agreements](/glossary#): agreements\n\n\n\n[last_marketing_agreement_signed_date](/glossary#): last_marketing_agreement_signed_date\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"agreements":[{"type":"","text":""}],"is_deleted":false,"last_marketing_agreement_signed_date":"1099-12-31T21:00:00Z","is_locked":false}]},"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":["User"],"typed_success_response_body":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users","connector_methods":[]},{"operation_id":"OBPv5.1.0-suggestedSessionTimeout","implemented_by":{"version":"OBPv5.1.0","function":"suggestedSessionTimeout"},"request_verb":"GET","request_url":"/obp/v5.1.0/ui/suggested-session-timeout","summary":"Get Suggested Session Timeout","description":"Returns information about:
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\ntimeout_in_seconds: timeout_in_seconds
\n","description_markdown":"Returns information about:\n\n* Suggested session timeout in case of a user inactivity\n \n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**timeout_in_seconds**](/glossary#): timeout_in_seconds\n\n\n","success_response_body":{"timeout_in_seconds":"300"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"timeout_in_seconds":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/ui/suggested-session-timeout","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateTransactionRequestAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","summary":"Create or Update Transaction Request Attribute Definition","description":"Create or Update Transaction Request Attribute Definition
\nThe category field must be TransactionRequest
\nThe type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Transaction Request Attribute Definition\n\nThe category field must be TransactionRequest\n\nThe type field must be one of: DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/transaction-request","connector_methods":[]},{"operation_id":"OBPv5.1.0-createMyConsumer","implemented_by":{"version":"OBPv5.1.0","function":"createMyConsumer"},"request_verb":"POST","request_url":"/obp/v5.1.0/my/consumers","summary":"Create a Consumer","description":"Create a Consumer (Authenticated access).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napp_name: appNameBank
\napp_type: Web
\ncompany: Tesobe GmbH
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nenabled: false
\nredirect_url: https://apisandbox.openbankproject.com
\nclient_certificate: client_certificate
\nlogo_url: logo_url
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Create a Consumer (Authenticated access).\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[client_certificate](/glossary#): client_certificate\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","enabled":true,"client_certificate":"-----BEGIN CERTIFICATE-----MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDgM4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==-----END CERTIFICATE-----","logo_url":"https://apisandbox.openbankproject.com/logo"},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Consumer"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"client_certificate":{"type":"string"},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consumers","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteCustomerAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteCustomerAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/customer","summary":"Delete Customer Attribute Definition","description":"Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"roles":[{"role":"CanDeleteCustomerAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/customer","connector_methods":[]},{"operation_id":"OBPv5.0.0-updateCustomerAccountLinkById","implemented_by":{"version":"OBPv5.0.0","function":"updateCustomerAccountLinkById"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","summary":"Update Customer Account Link by Id","description":"Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","description_markdown":"Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ACCOUNT_LINK_ID](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_account_link_id**](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n","example_request_body":{"relationship_type":"Owner"},"success_response_body":{"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"relationship_type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}},"roles":[{"role":"CanUpdateCustomerAccountLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","connector_methods":[]},{"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)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":{"metrics":[{"connector_name":"mapper","function_name":"getBanks","correlation_id":"12345","date":"1099-12-31T21: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_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":[]},{"operation_id":"OBPv4.0.0-createCustomerAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createCustomerAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute","summary":"Create Customer Attribute","description":"Create Customer Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Customer Attribute\n\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"},"success_response_body":{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerAttributeAtOneBank","requires_bank_id":true},{"role":"CanCreateCustomerAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"updateDynamicMessageDoc"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Update Dynamic Message Doc","description":"Update a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Update a Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","example_request_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","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":["Dynamic-Message-Doc"],"typed_request_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanUpdateDynamicMessageDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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":"OBPv2.0.0-publicAccountsAllBanks","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAllBanks"},"request_verb":"GET","request_url":"/obp/v2.0.0/accounts/public","summary":"Get Public Accounts at all Banks","description":"Get public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","description_markdown":"Get public accounts at all banks (Anonymous access).\nReturns accounts that contain at least one public view (a view where is_public is true)\nFor each account the API returns the ID and the available views.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30066: Could not get accounts.","OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/accounts/public","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCustomerByCustomerNumber","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerByCustomerNumber"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/customer-number","summary":"Get Customer by CUSTOMER_NUMBER","description":"Gets the Customer specified by CUSTOMER_NUMBER.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","description_markdown":"Gets the Customer specified by CUSTOMER_NUMBER.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "d9d56362-3205-462a-b65c-598179a3777a"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&branchId=710595f1-c920-4987-b5fa-bf7d4aacdcb6"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&atmId=710595f1-c920-4987-b5fa-bf7d4aacdcb6"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&accountId=710595f1-c920-4987-b5fa-bf7d4aacdcb6"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&productCode=710595f1-c920-4987-b5fa-bf7d4aacdcb6"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&cardId=710595f1-c920-4987-b5fa-bf7d4aacdcb6"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&accountId=710595f1-c920-4987-b5fa-bf7d4aacdcb6&transactionId=d6959536-ca08-4b02-9e56-6fbe9f98dae7"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=d9d56362-3205-462a-b65c-598179a3777a&accountId=710595f1-c920-4987-b5fa-bf7d4aacdcb6&counterpartyId=d6959536-ca08-4b02-9e56-6fbe9f98dae7"\n}\n\nNote: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.
This endpoint is used to update the Account Access of Consent.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint is used to update the Account Access of Consent.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89"}]}},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"AUTHORISED"},"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-10001: Incorrect json format.","OBP-35001: Consent not found by CONSENT_ID. ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)"],"typed_request_body":{"type":"object","properties":{"access":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"iban":{"type":"string"}}}}}}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"roles":[{"role":"CanUpdateConsentAccountAccessAtOneBank","requires_bank_id":true},{"role":"CanUpdateConsentAccountAccessAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/consents/CONSENT_ID/account-access","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomerAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getCustomerAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes","summary":"Get Customer Attributes","description":"Get Customer Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Customer Attributes\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAttributesAtOneBank","requires_bank_id":true},{"role":"CanGetCustomerAttributesAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-getExplicitCounterpartyById","implemented_by":{"version":"OBPv4.0.0","function":"getExplicitCounterpartyById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Get Counterparty by Id (Explicit)","description":"This endpoint returns a single Counterparty on an Account View specified by its COUNTERPARTY_ID:
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"This endpoint returns a single Counterparty on an Account View specified by its COUNTERPARTY_ID:\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Counterparty-Metadata"],"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"image_url":{"type":"string"}}},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-saveHistoricalTransaction","implemented_by":{"version":"OBPv3.1.0","function":"saveHistoricalTransaction"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/historical/transactions ","summary":"Save Historical Transactions ","description":"Import the historical transactions.
\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.
\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty
\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.
\nSo:
\nWhen you need the account to account, just omit counterparty_id field.eg:
\n{
\n"from": {
\n"bank_id": "gh.29.uk",
\n"account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
When you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"counterparty_id": "26392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
or, you can counterparty to account
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntype:
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","description_markdown":"Import the historical transactions.\n\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.\nSo: \nWhen you need the account to account, just omit counterparty_id field.eg:\n{\n \"from\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"to\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nWhen you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:\n{\n \"from\": {\n \"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"to\": {\n \"counterparty_id\": \"26392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nor, you can counterparty to account\n{\n \"from\": {\n \"counterparty_id\": \"f6392b7d-4218-45ea-b9a7-eaa71c0202f9\"\n },\n \"to\": {\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n },\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nThis call is experimental.\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n","example_request_body":{"from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","type":"SANDBOX_TAN","charge_policy":"SHARED"},"success_response_body":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1099-12-31T22:01:01Z","completed":"1099-12-31T22:01:01Z","transaction_request_type":"SANDBOX_TAN","charge_policy":"SHARED"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"completed":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateHistoricalTransaction","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/historical/transactions ","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycCheck","implemented_by":{"version":"OBPv2.0.0","function":"addKycCheck"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","summary":"Add KYC Check","description":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","description_markdown":"Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_CHECK_ID](/glossary#kyc_check_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): false\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","example_request_body":{"customer_number":"5987953","date":"1099-12-31T21:00:00Z","how":"online_meeting","staff_user_id":"67876","staff_name":"Simon","satisfied":true,"comments":"String"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1099-12-31T21:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"staff_user_id":{"type":"string"},"staff_name":{"type":"string"},"comments":{"type":"string"},"how":{"type":"string"},"satisfied":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"string"},"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}},"roles":[{"role":"CanAddKycCheck","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_check/KYC_CHECK_ID","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv4.0.0-createOrUpdateAccountAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateAccountAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/account","summary":"Create or Update Account Attribute Definition","description":"Create or Update Account Attribute Definition
\nThe category field must be Account
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Account Attribute Definition\n\nThe category field must be Account\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Account","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Account","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateAccountAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/account","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction","summary":"Delete Transaction Attribute Definition","description":"Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Transaction Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"roles":[{"role":"CanDeleteTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction","connector_methods":[]},{"operation_id":"OBPv5.1.0-getMyConsents","implemented_by":{"version":"OBPv5.1.0","function":"getMyConsents"},"request_verb":"GET","request_url":"/obp/v5.1.0/my/consents","summary":"Get My Consents","description":"This endpoint gets the Consents created by a current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\n\n","description_markdown":"This endpoint gets the Consents created by a current User.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**aud**](/glossary#): String\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**consent_reference_id**](/glossary#): 123456\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**createdByUserId**](/glossary#): createdByUserId\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**exp**](/glossary#): 60\n\n\n\n[**iat**](/glossary#): 60\n\n\n\n[**iss**](/glossary#): String\n\n\n\n[**jti**](/glossary#): String\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**jwt_payload**](/glossary#): jwt_payload\n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nbf**](/glossary#): 60\n\n\n\n[**request_headers**](/glossary#): request_headers\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**sub**](/glossary#): felixsmith\n\n\n\n[**values**](/glossary#): values\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[access](/glossary#): access\n\n\n\n[accounts](/glossary#accounts): \n\n\n\n[allPsd2](/glossary#): allPsd2\n\n\n\n[availableAccounts](/glossary#): availableAccounts\n\n\n\n[balances](/glossary#): balances\n\n\n\n[bban](/glossary#): bban\n\n\n\n[currency](/glossary#): EUR\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n\n[iban](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[maskedPan](/glossary#): maskedPan\n\n\n\n[msisdn](/glossary#): msisdn\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[pan](/glossary#): pan\n\n\n\n[transactions](/glossary#transactions): \n\n\n","success_response_body":{"consents":[{"consent_reference_id":"123456","consent_id":"9d429899-24f5-42c8-8565-943ffa6a7947","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","status":"","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","jwt_payload":{"createdByUserId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","sub":"felixsmith","iss":"String","aud":"String","jti":"String","iat":60,"nbf":60,"exp":60,"request_headers":[{"name":"tags","values":["static"]}],"name":"ACCOUNT_MANAGEMENT_FEE","email":"felixsmith@example.com","entitlements":[{"role_name":"","bank_id":"gh.29.uk"}],"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}],"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"balances":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"transactions":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"availableAccounts":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"api_standard":"Berlin Group","api_version":"v1.3"}]},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"status":{"type":"string"},"jwt":{"type":"string"},"api_version":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserCustomerLinksByCustomerId","implemented_by":{"version":"OBPv4.0.0","function":"getUserCustomerLinksByCustomerId"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID","summary":"Get User Customer Links by Customer","description":"Get User Customer Links by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get User Customer Links by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_inserted**](/glossary#date_inserted): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**user_customer_link_id**](/glossary#user_customer_link_id): \n\n\n\n[**user_customer_links**](/glossary#user_customer_links): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"user_customer_links":[{"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","date_inserted":"1099-12-31T21:00:00Z","is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"user_customer_links":{"type":"array","items":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"user_id":{"type":"string"},"date_inserted":{"type":"string","format":"date-time"}}}}}},"roles":[{"role":"CanGetUserCustomerLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-addCardForBank","implemented_by":{"version":"OBPv5.0.0","function":"addCardForBank"},"request_verb":"POST","request_url":"/obp/v5.0.0/management/banks/BANK_ID/cards","summary":"Create Card","description":"Create Card at bank specified by BANK_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nallows: [credit,debit,cash_withdrawal]
\nbrand: Visa
\ncard_number: 364435172576215
\ncard_type: Credit
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: false
\nexpires_date: 2021-01-27
\nissue_number: 1
\nname_on_card: SusanSmith
\n\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\ncollected: 2020-01-27
\nposted: 2020-01-27
\n\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\nbrand: Visa
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncvv: 123
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Create Card at bank specified by BANK_ID .\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**brand**](/glossary#): Visa\n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[collected](/glossary#collected): 2020-01-27\n\n\n\n[posted](/glossary#posted): 2020-01-27\n\n\n\n[replacement](/glossary#replacement): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**brand**](/glossary#): Visa\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**cancelled**](/glossary#cancelled): false\n\n\n\n[**card_id**](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**cvv**](/glossary#): 123\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"card_number":"364435172576215","card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"technology":"technology1","networks":[""],"allows":["credit","debit"],"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"},{"requested_date":"2026-03-16T21:00:23Z","reason_requested":"GOOD_SECURITY_PRACTICE"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","brand":"Visa"},"success_response_body":{"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","bank_id":"gh.29.uk","card_number":"364435172576215","card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"technology1","networks":[""],"allows":["credit","debit"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","cvv":"123","brand":"Visa"},"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-10015: Allowed values are:","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"posted":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"valid_from_date":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"brand":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"account_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"card_number":{"type":"string"},"cvv":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"customer_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"brand":{"type":"string"},"card_id":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"serial_number":{"type":"string"},"networks":{"type":"array","items":{"type":"string"}},"collected":{"type":"string","format":"date-time"},"cancelled":{"type":"boolean"}}},"roles":[{"role":"CanCreateCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAgents","implemented_by":{"version":"OBPv5.1.0","function":"getAgents"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/agents","summary":"Get Agents at Bank","description":"Get Agents at Bank.
\nUser Authentication is Optional. The User need not be logged in.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nagents: agents
\nlegal_name: Eveline Tripman
\n","description_markdown":"Get Agents at Bank.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:25.834Z. NOTE! The default value is now (2026-03-16T21:00:25.834Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\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[**agent_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**agents**](/glossary#): agents\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n","success_response_body":{"agents":[{"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","legal_name":"Eveline Tripman","agent_number":"5987953"}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30326: Agents not found.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"agents":{"type":"array","items":{"type":"object","properties":{"agent_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteUser","implemented_by":{"version":"OBPv4.0.0","function":"deleteUser"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/users/USER_ID","summary":"Delete a User","description":"Delete a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete a User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","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":["User"],"roles":[{"role":"CanDeleteUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-customViewNamesCheck","implemented_by":{"version":"OBPv5.1.0","function":"customViewNamesCheck"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/system/integrity/custom-view-names-check","summary":"Check Custom View Names","description":"Check custom view names.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","description_markdown":"Check custom view names.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n\n[debug_info](/glossary#): debug_info\n\n\n","success_response_body":{"success":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":["System-Integrity"],"typed_success_response_body":{"type":"object","properties":{"success":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemIntegrity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system/integrity/custom-view-names-check","connector_methods":[]},{"operation_id":"OBPv3.1.0-getFirehoseCustomers","implemented_by":{"version":"OBPv3.1.0","function":"getFirehoseCustomers"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/firehose/customers","summary":"Get Firehose Customers","description":"Get Customers that has a firehose View.
\nAllows bulk access to customers.
\nUser must have the CanUseFirehoseAtAnyBank Role
Possible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Get Customers that has a firehose View.\n\nAllows bulk access to customers.\nUser must have the CanUseFirehoseAtAnyBank Role\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:23.799Z. NOTE! The default value is now (2026-03-16T21:00:23.799Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-00012: Customer firehose is not allowed on this instance. Please set allow_customer_firehose = true in props files. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","FirehoseData"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"roles":[{"role":"CanUseCustomerFirehoseAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/firehose/customers","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteProductCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/products/PRODUCT_CODE","summary":"Delete Product Cascade","description":"Delete a Product Cascade specified by PRODUCT_CODE.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","description_markdown":"Delete a Product Cascade specified by PRODUCT_CODE.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product"],"roles":[{"role":"CanDeleteProductCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv5.0.0-updateBank","implemented_by":{"version":"OBPv5.0.0","function":"updateBank"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks","summary":"Update Bank","description":"Update an existing bank (Authenticated access).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Update an existing bank (Authenticated access).\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","example_request_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"full name string","logo":"logo url","website":"www.openbankproject.com","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}]},"success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-34001: Could not update the Bank","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"full_name":{"type":"string"},"logo":{"type":"string"},"id":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","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
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete Api Collection By API_COLLECTION_ID\n\nglossary-item-not-found\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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-getEntitlements","implemented_by":{"version":"OBPv4.0.0","function":"getEntitlements"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/USER_ID/entitlements","summary":"Get Entitlements for User","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"list":[{"entitlement_id":"","role_name":"","bank_id":"gh.29.uk","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}]},"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":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetEntitlementsForAnyUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv2.1.0-getRoles","implemented_by":{"version":"OBPv2.1.0","function":"getRoles"},"request_verb":"GET","request_url":"/obp/v2.1.0/roles","summary":"Get Roles","description":"Returns all available roles
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\nrole:
\nroles: CanCreateMyUser
\n","description_markdown":"Returns all available roles\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**requires_bank_id**](/glossary#requires_bank_id): \n\n\n\n[**role**](/glossary#role): \n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n","success_response_body":{"roles":[{"role":"CanCreateBranch","requires_bank_id":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Role"],"typed_success_response_body":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/roles","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attribute","summary":"Create Transaction Attribute","description":"Create Transaction Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Transaction Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attribute","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateTransactionAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction","summary":"Create or Update Transaction Attribute Definition","description":"Create or Update Transaction Attribute Definition
\nThe category field must be Transaction
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Transaction Attribute Definition\n\nThe category field must be Transaction\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/transaction","connector_methods":[]},{"operation_id":"OBPv5.1.0-getApiTags","implemented_by":{"version":"OBPv5.1.0","function":"getApiTags"},"request_verb":"GET","request_url":"/obp/v5.1.0/tags","summary":"Get API Tags","description":"Get API TagsGet API Tags
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","description_markdown":"Get API TagsGet API Tags\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","success_response_body":{"accounts":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/tags","connector_methods":[]},{"operation_id":"OBPv3.0.0-getEntitlementRequestsForCurrentUser","implemented_by":{"version":"OBPv3.0.0","function":"getEntitlementRequestsForCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/entitlement-requests","summary":"Get Entitlement Requests for the current User","description":"Get Entitlement Requests for the current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get Entitlement Requests for the current User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlement_request_id**](/glossary#entitlement_request_id): \n\n\n\n[**entitlement_requests**](/glossary#entitlement_requests): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"entitlement_requests":[{"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"role_name":"CanQueryOtherUser","bank_id":"gh.29.uk","created":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/entitlement-requests","connector_methods":[]},{"operation_id":"OBPv1.4.0-getCustomersMessages","implemented_by":{"version":"OBPv1.4.0","function":"getCustomersMessages"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/messages","summary":"Get Customer Messages for all Customers","description":"Get messages for the logged in customer
\nMessages sent to the currently authenticated user.
Authentication via OAuth is required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndate: 2020-01-27
\nfrom_department: Open Bank
\nfrom_person: Tom
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nmessage: 123456
\n\n","description_markdown":"Get messages for the logged in customer\nMessages sent to the currently authenticated user.\n\nAuthentication via OAuth is required.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**messages**](/glossary#messages): \n\n\n","success_response_body":{"messages":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","date":"1099-12-31T21:00:00Z","message":"String","from_department":"String","from_person":"String"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer"],"typed_success_response_body":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"message":{"type":"string"},"from_department":{"type":"string"},"id":{"type":"string"},"from_person":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer/messages","connector_methods":[]},{"operation_id":"OBPv5.1.0-createCustomView","implemented_by":{"version":"OBPv5.1.0","function":"createCustomView"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views","summary":"Create Custom View","description":"Create a custom view on bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true on the view creation, the rest will be set to false.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Create a custom view on bank account\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n The 'alias' field in the JSON can take one of three values:\n\n * _public_: to use the public alias if there is one specified for the other account.\n * _private_: to use the private alias if there is one specified for the other account.\n\n * _''(empty string)_: to use no alias; the view shows the real name of the other account.\n\n The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to `true` and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.\n\n The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to `true` on the view creation, the rest will be set to `false`.\n\n You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP [system views](/index#group-View-System).\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**allowed_permissions**](/glossary#): allowed_permissions\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**which_alias_to_use**](/glossary#which_alias_to_use): public\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allowed_permissions**](/glossary#): allowed_permissions\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"name":"owner","description":"This view is for the owner for the account.","metadata_view":"","is_public":false,"which_alias_to_use":"public","hide_metadata_if_alias_used":false,"allowed_permissions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"]},"success_response_body":{"id":"owner","name":"owner","description":"This view is for the owner for the account.","metadata_view":"","is_public":false,"alias":"public","hide_metadata_if_alias_used":false,"allowed_permissions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"updateTransactionNarrative"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Update a Transaction Narrative","description":"Updates the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicMessageDoc"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Get Bank Level Dynamic Message Doc","description":"Get a Bank Level Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Get a Bank Level Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"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-Message-Doc"],"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanGetBankLevelDynamicMessageDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerAccountLinksByBankIdAccountId"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/customer-account-links","summary":"Get Customer Account Links by ACCOUNT_ID","description":"Get Customer Account Links by ACCOUNT_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nlinks: links
\nrelationship_type: Owner
\n","description_markdown":"Get Customer Account Links by ACCOUNT_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_account_link_id**](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**links**](/glossary#): links\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n","success_response_body":{"links":[{"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAccountLinks","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/customer-account-links","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsumers","implemented_by":{"version":"OBPv5.1.0","function":"getConsumers"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/consumers","summary":"Get Consumers","description":"Get the all Consumers.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Get the all Consumers.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:25.880Z. NOTE! The default value is now (2026-03-16T21:00:25.880Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**consumers**](/glossary#consumers): \n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","success_response_body":{"consumers":[{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"}]},"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":["Consumer"],"typed_success_response_body":{"type":"object","properties":{"consumers":{"type":"array","items":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","description_markdown":"Get the Call Context of the current call.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv5.1.0-regulatedEntities","implemented_by":{"version":"OBPv5.1.0","function":"regulatedEntities"},"request_verb":"GET","request_url":"/obp/v5.1.0/regulated-entities","summary":"Get Regulated Entities","description":"Returns information about:
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentities: entities
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Returns information about:\n\n* Regulated Entities\n \n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**attributeType**](/glossary#): attributeType\n\n\n\n[**certificate_authority_ca_owner_id**](/glossary#certificate_authority_ca_owner_id): CY_CBC\n\n\n\n[**entities**](/glossary#): entities\n\n\n\n[**entity_address**](/glossary#entity_address): EXAMPLE COMPANY LTD, 5 SOME STREET\n\n\n\n[**entity_certificate_public_key**](/glossary#entity_certificate_public_key): MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==\n\n\n\n[**entity_code**](/glossary#entity_code): PSD_PICY_CBC!12345\n\n\n\n[**entity_country**](/glossary#entity_country): CY\n\n\n\n[**entity_id**](/glossary#entity_id): 0af807d7-3c39-43ef-9712-82bcfde1b9ca\n\n\n\n[**entity_name**](/glossary#entity_name): EXAMPLE COMPANY LTD\n\n\n\n[**entity_post_code**](/glossary#entity_post_code): 1060\n\n\n\n[**entity_town_city**](/glossary#entity_town_city): SOME CITY\n\n\n\n[**entity_type**](/glossary#entity_type): PSD_PI\n\n\n\n[**entity_web_site**](/glossary#entity_web_site): www.example.com\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"entities":[{"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","certificate_authority_ca_owner_id":"CY_CBC","entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==","entity_name":"EXAMPLE COMPANY LTD","entity_code":"PSD_PICY_CBC!12345","entity_type":"PSD_PI","entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET","entity_town_city":"SOME CITY","entity_post_code":"1060","entity_country":"CY","entity_web_site":"www.example.com","services":[{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}],"attributes":[{"attributeType":"STRING","name":"STATUS","value":"closed"}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Directory","API"],"typed_success_response_body":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-createDirectDebit","implemented_by":{"version":"OBPv4.0.0","function":"createDirectDebit"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/direct-debit","summary":"Create Direct Debit","description":"Create direct debit for an account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Create direct debit for an account.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[date_expires](/glossary#): 2021-01-27\n\n\n\n[date_signed](/glossary#): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**active**](/glossary#active): false\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_cancelled**](/glossary#): 2020-01-27\n\n\n\n[**date_expires**](/glossary#): 2021-01-27\n\n\n\n[**date_signed**](/glossary#): 2020-01-27\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**direct_debit_id**](/glossary#direct_debit_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","date_signed":"1099-12-31T21:00:00Z","date_starts":"1099-12-31T21:00:00Z","date_expires":"1099-12-31T21:00:00Z"},"success_response_body":{"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","date_signed":"2026-03-16T21:00:25Z","date_starts":"2026-03-16T21:00:25Z","date_expires":"2026-03-16T21:00:25Z","date_cancelled":"2026-03-16T21:00:25Z","active":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20057: User not found by userId.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-50000: Unknown Error."],"tags":["Direct-Debit","Account"],"typed_request_body":{"type":"object","properties":{"date_signed":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"date_starts":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"date_signed":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"direct_debit_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/direct-debit","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,
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get a Dynamic Endpoint.\n\n\nGet one DynamicEndpoint,\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-getMySpaces","implemented_by":{"version":"OBPv4.0.0","function":"getMySpaces"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/spaces","summary":"Get My Spaces","description":"Get My Spaces.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_ids: bank_ids
\n","description_markdown":"Get My Spaces.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_ids**](/glossary#): bank_ids\n\n\n","success_response_body":{"bank_ids":["gh.29.uk"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"bank_ids":{"type":"array","items":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/spaces","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateTransactionRequestStatus","implemented_by":{"version":"OBPv5.1.0","function":"updateTransactionRequestStatus"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/transaction-requests/TRANSACTION_REQUEST_ID","summary":"Update Transaction Request Status","description":"Update Transaction Request Status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\n\n","description_markdown":"Update Transaction Request Status\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"status":"COMPLETED"},"success_response_body":{"status":"COMPLETED"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"status":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"}}},"roles":[{"role":"CanUpdateTransactionRequestStatusAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/transaction-requests/TRANSACTION_REQUEST_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerCreditRatingAndSource","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerCreditRatingAndSource"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit-rating-and-source","summary":"Update the credit rating and source of a Customer","description":"Update the credit rating and source of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the credit rating and source of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"credit_rating":"Good","credit_source":"Bank"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"credit_source":{"type":"string"},"credit_rating":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerCreditRatingAndSource","requires_bank_id":true},{"role":"CanUpdateCustomerCreditRatingAndSourceAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit-rating-and-source","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete a Bank Level DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get Bank Level Dynamic Endpoints.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-getTransactionRequestAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes","summary":"Get Transaction Request Attributes","description":"Get Transaction Request Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntransaction_request_attributes: transaction_request_attributes
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Request Attributes\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_request_attributes**](/glossary#): transaction_request_attributes\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_request_attributes":[{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"STRING","value":"123456789"}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"transaction_request_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionRequestAttributesAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountApplication","implemented_by":{"version":"OBPv3.1.0","function":"createAccountApplication"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications","summary":"Create Account Application","description":"Create Account Application
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nproduct_code: 1234BW
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","description_markdown":"Create Account Application\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[customer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[user_id](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_application_id**](/glossary#account_application_id): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_application**](/glossary#date_of_application): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"product_code":"1234BW","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"success_response_body":{"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763","product_code":"1234BW","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"date_of_application":"1099-12-31T21:00:00Z","status":"REQUESTED"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account-Application","Account"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"},"product_code":{"type":"string"},"customer_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_of_application":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"account_application_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-applications","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv4.0.0-getEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"getEndpointMapping"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Get Endpoint Mapping by Id","description":"Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Get an Endpoint Mapping by ENDPOINT_MAPPING_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanGetEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"deleteDynamicMessageDoc"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Delete Dynamic Message Doc","description":"Delete a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete a Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \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":["Dynamic-Message-Doc"],"roles":[{"role":"CanDeleteDynamicMessageDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"addTransactionNarrative"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Add a Transaction Narrative","description":"Creates a description of the transaction TRANSACTION_ID.
\nNote: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
\nIf you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).
User Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a description of the transaction TRANSACTION_ID.\n\nNote: Unlike other items of metadata, there is only one \"narrative\" per transaction accross all views.\nIf you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv5.0.0-createCustomer","implemented_by":{"version":"OBPv5.0.0","function":"createCustomer"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers","summary":"Create Customer","description":"The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
\nDates need to be in the format 2013-01-21T23:08:00Z
Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\ndate: 2020-01-27
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nbranch_id: DERBY6
\n\n\ncustomer_number: 5987953
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.\nDates need to be in the format 2013-01-21T23:08:00Z\n\nNote: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[branch_id](/glossary#): DERBY6\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n\n[customer_number](/glossary#): 5987953\n\n\n\n[date_of_birth](/glossary#): 2018-03-09\n\n\n\n[dependants](/glossary#): 1\n\n\n\n[dob_of_dependants](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[employment_status](/glossary#): worker\n\n\n\n[face_image](/glossary#face_image): \n\n\n\n[highest_education_attained](/glossary#): Master\n\n\n\n[kyc_status](/glossary#): false\n\n\n\n[last_ok_date](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[name_suffix](/glossary#): Sr\n\n\n\n[relationship_status](/glossary#): single\n\n\n\n[title](/glossary#): Dr.\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"legal_name":"Eveline Tripman","customer_number":"5987953","mobile_phone_number":"+49 30 901820","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:25Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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-10001: Incorrect json format.","OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID","OBP-30024: Could not create Consumer ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"relationship_status":{"type":"string"},"name_suffix":{"type":"string"},"highest_education_attained":{"type":"string"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"last_ok_date":{"type":"string","format":"date-time"},"title":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"email":{"type":"string"},"customer_number":{"type":"string"},"kyc_status":{"type":"boolean"},"legal_name":{"type":"string"},"branch_id":{"type":"string"},"employment_status":{"type":"string"},"mobile_phone_number":{"type":"string"},"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanCreateCustomer","requires_bank_id":true},{"role":"CanCreateCustomerAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createBankAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute","summary":"Create Bank Attribute","description":"Create Bank Attribute
\nTypical product attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nbank_attribute_id: bank_attribute_id
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Create Bank Attribute\n\nTypical product attributes might be:\n\nISIN (for International bonds)\nVKN (for German bonds)\nREDCODE (markit short code for credit derivative)\nLOAN_ID (e.g. used for Anacredit reporting)\n\nISSUE_DATE (When the bond was issued in the market)\nMATURITY_DATE (End of life time of a product)\nTRADABLE\n\nSee [FPML](http://www.fpml.org/) for more examples.\n\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_attribute_id**](/glossary#): bank_attribute_id\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","bank_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":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":["Bank"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"},"bank_attribute_id":{"type":"string"}}},"roles":[{"role":"CanCreateBankAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get all the bank level Dynamic Entities for one bank.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-deleteAccountAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteAccountAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/account","summary":"Delete Account Attribute Definition","description":"Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Account Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"roles":[{"role":"CanDeleteAccountAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/account","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_TAG_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"Delete System Level Endpoint Tag.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","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-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":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestRefund","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestRefund"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/REFUND/transaction-requests","summary":"Create Transaction Request (REFUND)","description":"Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.
In case the from object is used, it means that the refund comes from the part that sent you a transaction.
\nIn the from object, you have two choices :
\n- Use bank_id and account_id fields if the other account is registered on the OBP-API
\n- Use the counterparty_id field in case the counterparty account is out of the OBP-API
In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
\n(This case is not managed by the OBP-API and require an external adapter)
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nREFUND: REFUND
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nreason_code: reason_code
\nrefund: refund
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nfrom:
\nto:
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Either the `from` or the `to` field must be filled. Those fields refers to the information about the party that will be refunded.\n\nIn case the `from` object is used, it means that the refund comes from the part that sent you a transaction.\nIn the `from` object, you have two choices :\n- Use `bank_id` and `account_id` fields if the other account is registered on the OBP-API\n- Use the `counterparty_id` field in case the counterparty account is out of the OBP-API\n\nIn case the `to` object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.\n(This case is not managed by the OBP-API and require an external adapter)\n\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[REFUND](/glossary#): REFUND\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**reason_code**](/glossary#): reason_code\n\n\n\n[**refund**](/glossary#): refund\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[from](/glossary#from): \n\n\n\n[to](/glossary#to): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"from":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A refund description. ","refund":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","reason_code":"CUST"}},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"from":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"refund":{"type":"object","properties":{"reason_code":{"type":"string"},"transaction_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/REFUND/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-addAccount","implemented_by":{"version":"OBPv4.0.0","function":"addAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts","summary":"Create Account (POST)","description":"Create Account at bank specified by BANK_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf the POST body USER_ID is specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the POST body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nproduct_code: 1234BW
\nscheme: OBP
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nscheme: OBP
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Create Account at bank specified by BANK_ID.\n\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.\n\nIf the POST body USER_ID *is* specified, the logged in user must have the Role CanCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.\n\nIf the POST body USER_ID is *not* specified, the account will be owned by the logged in User.\n\nThe 'product_code' field SHOULD be a product_code from Product.\nIf the product_code matches a product_code from Product, account attributes will be created that match the Product Attributes.\n\nNote: The Amount MUST be zero.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"success_response_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","label":"My Account","product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30106: Invalid Balance Amount.","OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00","OBP-30109: Initial Balance of Account must be Zero (0).","OBP-30105: Invalid Balance Currency.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateAccount","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts","connector_methods":[]},{"operation_id":"OBPv5.1.0-accountAccessUniqueIndexCheck","implemented_by":{"version":"OBPv5.1.0","function":"accountAccessUniqueIndexCheck"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/system/integrity/account-access-unique-index-1-check","summary":"Check Unique Index at Account Access","description":"Check unique index at account access table.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","description_markdown":"Check unique index at account access table.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n\n[debug_info](/glossary#): debug_info\n\n\n","success_response_body":{"success":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":["System-Integrity"],"typed_success_response_body":{"type":"object","properties":{"success":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemIntegrity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system/integrity/account-access-unique-index-1-check","connector_methods":[]},{"operation_id":"OBPv3.0.0-updateViewForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"updateViewForBankAccount"},"request_verb":"PUT","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","summary":"Update Custom View","description":"Update an existing custom view on a bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Update an existing custom view on a bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n\nThe json sent is the same as during view creation (above), with one difference: the 'name' field\nof a view is not editable (it is only set when a view is created)\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","example_request_body":{"description":"this is for family","metadata_view":"owner","is_public":true,"which_alias_to_use":"family","hide_metadata_if_alias_used":true,"allowed_actions":["can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":true},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"allowed_actions":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"hide_metadata_if_alias_used":{"type":"boolean"},"metadata_view":{"type":"string"},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCurrenciesAtBank","implemented_by":{"version":"OBPv5.1.0","function":"getCurrenciesAtBank"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/currencies","summary":"Get Currencies at a Bank","description":"Get Currencies specified by BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nalphanumeric_code: alphanumeric_code
\ncurrencies: currencies
\n","description_markdown":"Get Currencies specified by BANK_ID\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alphanumeric_code**](/glossary#): alphanumeric_code\n\n\n\n[**currencies**](/glossary#): currencies\n\n\n","success_response_body":{"currencies":[{"alphanumeric_code":"EUR"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["FX"],"typed_success_response_body":{"type":"object","properties":{"currencies":{"type":"array","items":{"type":"object","properties":{"alphanumeric_code":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/currencies","connector_methods":[]},{"operation_id":"OBPv3.1.0-enableDisableAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"enableDisableAccountWebhook"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Enable/Disable an Account Webhook","description":"Enable/Disable an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Enable/Disable an Account Webhook\n\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","is_active":"true"},"success_response_body":{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":true},"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":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"account_webhook_id":{"type":"string"},"is_active":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanUpdateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv5.0.0-createProduct","implemented_by":{"version":"OBPv5.0.0","function":"createProduct"},"request_verb":"PUT","request_url":"/obp/v5.0.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Create Product","description":"Create or Update Product for the Bank.
\nTypical Super Family values / Asset classes are:
\nDebt
\nEquity
\nFX
\nCommodity
\nDerivative
Product hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nparent_product_code: 787LOW
\nproduct_code: 1234BW
\nterms_and_conditions_url: www.example.com/xyz
\nattributes: attribute value in form of (name, value)
\nfees: fees
\n","description_markdown":"Create or Update Product for the Bank.\n\n\nTypical Super Family values / Asset classes are:\n\nDebt\nEquity\nFX\nCommodity\nDerivative\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\n\n \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**parent_product_code**](/glossary#parent_product_code): 787LOW\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**terms_and_conditions_url**](/glossary#): www.example.com/xyz\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[fees](/glossary#): fees\n\n\n","example_request_body":{"parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"Description of the object. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","parent_product_code":"787LOW","name":"Deposit Account 1","more_info_url":"www.example.com/abc","terms_and_conditions_url":"www.example.com/xyz","description":"Description of the object. Maximum length is 2000. It can be any characters here.","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}},"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":["Product"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"more_info_url":{"type":"string"},"terms_and_conditions_url":{"type":"string"},"parent_product_code":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"more_info_url":{"type":"string"},"parent_product_code":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"terms_and_conditions_url":{"type":"string"}}},"roles":[{"role":"CanCreateProduct","requires_bank_id":true},{"role":"CanCreateProductAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelEndpointMapping"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Get Bank Level Endpoint Mapping","description":"Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Get an Bank Level Endpoint Mapping by ENDPOINT_MAPPING_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanGetBankLevelEndpointMapping","requires_bank_id":true},{"role":"CanGetEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateBankAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Update Bank Attribute","description":"Update Bank Attribute.
\nUpdate one Bak Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Update Bank Attribute. \n\nUpdate one Bak Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\n\n\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[**alias**](/glossary#alias): \n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_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.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\napi_collections: api_collections
\ndescription: Description of the object. 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\nUser Authentication is Optional. The User need not be logged in.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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-createDirectDebitManagement","implemented_by":{"version":"OBPv4.0.0","function":"createDirectDebitManagement"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/direct-debit","summary":"Create Direct Debit (management)","description":"Create direct debit for an account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Create direct debit for an account.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[date_expires](/glossary#): 2021-01-27\n\n\n\n[date_signed](/glossary#): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**active**](/glossary#active): false\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_cancelled**](/glossary#): 2020-01-27\n\n\n\n[**date_expires**](/glossary#): 2021-01-27\n\n\n\n[**date_signed**](/glossary#): 2020-01-27\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**direct_debit_id**](/glossary#direct_debit_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","date_signed":"1099-12-31T21:00:00Z","date_starts":"1099-12-31T21:00:00Z","date_expires":"1099-12-31T21:00:00Z"},"success_response_body":{"direct_debit_id":"aa0533bd-eb22-4bff-af75-d45240361b05","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","date_signed":"2026-03-16T21:00:25Z","date_starts":"2026-03-16T21:00:25Z","date_expires":"2026-03-16T21:00:25Z","date_cancelled":"2026-03-16T21:00:25Z","active":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20057: User not found by userId.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Direct-Debit","Account"],"typed_request_body":{"type":"object","properties":{"date_signed":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"date_starts":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"date_starts":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"date_signed":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"direct_debit_id":{"type":"string"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateDirectDebitAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/direct-debit","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAgentCashWithDrawal","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAgentCashWithDrawal"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/AGENT_CASH_WITHDRAWAL/transaction-requests","summary":"Create Transaction Request (AGENT_CASH_WITHDRAWAL)","description":"Either the from or the to field must be filled. Those fields refers to the information about the party that will be refunded.
In case the from object is used, it means that the refund comes from the part that sent you a transaction.
\nIn the from object, you have two choices :
\n- Use bank_id and account_id fields if the other account is registered on the OBP-API
\n- Use the counterparty_id field in case the counterparty account is out of the OBP-API
In case the to object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.
\n(This case is not managed by the OBP-API and require an external adapter)
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nAGENT_CASH_WITHDRAWAL: AGENT_CASH_WITHDRAWAL
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nagent_number: 5987953
\namount: 10.12
\nbank_id: gh.29.uk
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Either the `from` or the `to` field must be filled. Those fields refers to the information about the party that will be refunded.\n\nIn case the `from` object is used, it means that the refund comes from the part that sent you a transaction.\nIn the `from` object, you have two choices :\n- Use `bank_id` and `account_id` fields if the other account is registered on the OBP-API\n- Use the `counterparty_id` field in case the counterparty account is out of the OBP-API\n\nIn case the `to` object is used, it means you send a request to a counterparty to ask for a refund on a previous transaction you sent.\n(This case is not managed by the OBP-API and require an external adapter)\n\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[AGENT_CASH_WITHDRAWAL](/glossary#): AGENT_CASH_WITHDRAWAL\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"0"},"description":"Description of the object. Maximum length is 2000. It can be any characters here.","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"description":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/AGENT_CASH_WITHDRAWAL/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"deleteTransactionNarrative"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Delete a Transaction Narrative","description":"Deletes the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAtmAttributes","implemented_by":{"version":"OBPv5.1.0","function":"getAtmAttributes"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes","summary":"Get ATM Attributes","description":"Get ATM Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_attributes: atm_attributes
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get ATM Attributes\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_attributes**](/glossary#): atm_attributes\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"atm_attributes":[{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false}]},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"typed_success_response_body":{"type":"object","properties":{"atm_attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAtmAttribute","requires_bank_id":true},{"role":"CanGetAtmAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-getLogoutLink","implemented_by":{"version":"OBPv4.0.0","function":"getLogoutLink"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/current/logout-link","summary":"Get Logout Link","description":"Get the Logout Link
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nlink:
\n","description_markdown":"Get the Logout Link\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**link**](/glossary#link): \n\n\n","success_response_body":{"link":"127.0.0.1:8080/user_mgt/logout"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"link":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/current/logout-link","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPhysicalLocation"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Delete Counterparty Physical Location","description":"Delete physical location of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete physical location of other bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","Physical Location cannot be deleted","Delete not completed","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserWithAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getUserWithAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/USER_ID/attributes","summary":"Get User with Attributes by USER_ID","description":"Get User Attributes for the user defined via USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\ninsert_date: 2020-01-27
\nname: ACCOUNT_MANAGEMENT_FEE
\nprovider: ETHEREUM
\n\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"Get User Attributes for the user defined via USER_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_attributes**](/glossary#): user_attributes\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","user_attributes":[{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"}]},"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":["User"],"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}}},"user_id":{"type":"string"}}},"roles":[{"role":"CanGetUsersWithAttributes","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/attributes","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","summary":"Delete a Transaction Tag","description":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account,
\nor must be the user that posted the tag.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\nAuthentication via OAuth is required. The user must either have owner privileges for this account, \nor must be the user that posted the tag.\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TAG_ID](/glossary#tag_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction-request","summary":"Get Transaction Request Attribute Definition","description":"Get Transaction Request Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Transaction Request Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"TransactionRequest","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/transaction-request","connector_methods":[]},{"operation_id":"OBPv3.1.0-getTransactionByIdForBankAccount","implemented_by":{"version":"OBPv3.1.0","function":"getTransactionByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","summary":"Get Transaction by Id","description":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID).
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"details":{"type":"AC","description":"this is for family","posted":"1099-12-31T21:00:00Z","completed":"1099-12-31T21:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"where":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"images":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"id":{"type":"string"},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/transaction","connector_methods":[]},{"operation_id":"OBPv5.0.0-deleteSystemView","implemented_by":{"version":"OBPv5.0.0","function":"deleteSystemView"},"request_verb":"DELETE","request_url":"/obp/v5.0.0/system-views/VIEW_ID","summary":"Delete System View","description":"Deletes the system view specified by VIEW_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the system view specified by VIEW_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","user does not have owner access","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"roles":[{"role":"CanDeleteSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomersByCustomerPhoneNumber","implemented_by":{"version":"OBPv4.0.0","function":"getCustomersByCustomerPhoneNumber"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/search/customers/mobile-phone-number","summary":"Get Customers by MOBILE_PHONE_NUMBER","description":"Gets the Customers specified by MOBILE_PHONE_NUMBER.
\nThere are two wildcards often used in conjunction with the LIKE operator:
\n% - The percent sign represents zero, one, or multiple characters
\n_ - The underscore represents a single character
\nFor example {"customer_phone_number":"%381%"} lists all numbers which contain 381 sequence
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nmobile_phone_number: +49 30 901820
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Gets the Customers specified by MOBILE_PHONE_NUMBER.\n\nThere are two wildcards often used in conjunction with the LIKE operator:\n % - The percent sign represents zero, one, or multiple characters\n _ - The underscore represents a single character\nFor example {\"customer_phone_number\":\"%381%\"} lists all numbers which contain 381 sequence\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"mobile_phone_number":"+44 07972 444 876"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/search/customers/mobile-phone-number","connector_methods":[]},{"operation_id":"OBPv3.1.0-getAccountApplication","implemented_by":{"version":"OBPv3.1.0","function":"getAccountApplication"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications/ACCOUNT_APPLICATION_ID","summary":"Get Account Application by Id","description":"Get the Account Application.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","description_markdown":"Get the Account Application.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_APPLICATION_ID](/glossary#account_application_id): \n\n\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[**account_application_id**](/glossary#account_application_id): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_application**](/glossary#date_of_application): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763","product_code":"1234BW","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"date_of_application":"1099-12-31T21:00:00Z","status":"REQUESTED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account-Application","Account"],"typed_success_response_body":{"type":"object","properties":{"date_of_application":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"account_application_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-applications/ACCOUNT_APPLICATION_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyCorporateLocation"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Add Corporate Location to Counterparty","description":"Add the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nJSON response body fields:
\n\n","description_markdown":"Add the geolocation of the counterparty's registered address\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"corporate_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow adding a corporate location","Coordinates not possible","Corporate Location cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv5.1.0-revokeMyConsent","implemented_by":{"version":"OBPv5.1.0","function":"revokeMyConsent"},"request_verb":"Delete","request_url":"/obp/v5.1.0/my/consents/CONSENT_ID","summary":"Revoke My Consent","description":"Revoke Consent for current user specified by CONSENT_ID
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
Please note that this endpoint only supports the case:: "The user explicitly wishes to revoke the application’s access"
\nOBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"Revoke Consent for current user specified by CONSENT_ID\n\nThere are a few reasons you might need to revoke an application’s access to a user’s account:\n - The user explicitly wishes to revoke the application’s access\n - You as the service provider have determined an application is compromised or malicious, and want to disable it\n - etc.\n\nPlease note that this endpoint only supports the case:: \"The user explicitly wishes to revoke the application’s access\"\n\nOBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.\nThe status of the token is changed to \"REVOKED\" so the next time the revoked client makes a request, their token will fail to validate.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"REJECTED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAccountAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getAccountAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/account","summary":"Get Account Attribute Definition","description":"Get Account Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Account Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Account","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetAccountAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/account","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyOpenCorporatesUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Update Open Corporates Url of Counterparty","description":"Update open corporate url of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update open corporate url of other bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"open_corporates_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating an open corporate url","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"open_corporates_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAccountsMinimalByCustomerId","implemented_by":{"version":"OBPv4.0.0","function":"getAccountsMinimalByCustomerId"},"request_verb":"GET","request_url":"/obp/v4.0.0/customers/CUSTOMER_ID/accounts-minimal","summary":"Get Accounts Minimal for a Customer","description":"Get Accounts Minimal by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","description_markdown":"Get Accounts Minimal by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","success_response_body":{"accounts":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30002: Customer not found. Please specify a valid value for CUSTOMER_NUMBER.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAccountsMinimalForCustomerAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/accounts-minimal","connector_methods":[]},{"operation_id":"OBPv5.0.0-createBank","implemented_by":{"version":"OBPv5.0.0","function":"createBank"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks","summary":"Create Bank","description":"Create a new bank (Authenticated access).
\nThe user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
\nThus the User can manage the bank they create and assign Roles to other Users.
Only SANDBOX mode
\nThe settlement accounts are created specified by the bank in the POST body.
\nName and account id are created in accordance to the next rules:
\n- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
\n- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\nbank_code: CGHZ
\nscheme: OBP
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nwebsite: www.openbankproject.com
\nJSON response body fields:
\n\nbank_code: CGHZ
\nbank_routings: bank routing in form of (scheme, address)
\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Create a new bank (Authenticated access).\n\nThe user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.\nThus the User can manage the bank they create and assign Roles to other Users.\n\nOnly SANDBOX mode\nThe settlement accounts are created specified by the bank in the POST body.\nName and account id are created in accordance to the next rules:\n - Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)\n - Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[bank_routings](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[full_name](/glossary#full_name): full name string\n\n\n\n[id](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[logo](/glossary#logo): logo url\n\n\n\n[website](/glossary#website): www.openbankproject.com\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","example_request_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"full name string","logo":"logo url","website":"www.openbankproject.com","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}]},"success_response_body":{"id":"gh.29.uk","bank_code":"CGHZ","full_name":"bank fullName string","logo":"bank logoUrl string","website":"bank logoUrl string","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"full_name":{"type":"string"},"logo":{"type":"string"},"id":{"type":"string"},"bank_code":{"type":"string"},"website":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"logo":{"type":"string"},"bank_code":{"type":"string"},"full_name":{"type":"string"},"id":{"type":"string"}}},"roles":[{"role":"CanCreateBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateCustomerAttributeAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/customer","summary":"Create or Update Customer Attribute Definition","description":"Create or Update Customer Attribute Definition
\nThe category field must be one of: Customer
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Customer Attribute Definition\n\nThe category field must be one of: Customer\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Customer","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Customer","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/customer","connector_methods":[]},{"operation_id":"OBPv3.0.0-dataWarehouseSearch","implemented_by":{"version":"OBPv3.0.0","function":"dataWarehouseSearch"},"request_verb":"POST","request_url":"/obp/v3.0.0/search/warehouse/INDEX","summary":"Data Warehouse Search","description":"Search the data warehouse and get row level results.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanSearchWarehouse entitlement is required. You can request the Role below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
\nPOST /search/warehouse/INDEX1,INDEX2
\nPOST /search/warehouse/ALL
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\n\nJSON request body fields:
\n\n\nnone:
\nJSON response body fields:
\nnone:
\n","description_markdown":"Search the data warehouse and get row level results.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCanSearchWarehouse entitlement is required. You can request the Role below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\n\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE\n\nPOST /search/warehouse/INDEX1,INDEX2\n\nPOST /search/warehouse/ALL\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n[INDEX](/glossary#index): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**match_all**](/glossary#match_all): \n\n\n\n[**query**](/glossary#query): \n\n\n\n[none](/glossary#none): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[none](/glossary#none): \n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{},"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":["Data-Warehouse"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{}},"roles":[{"role":"CanSearchWarehouse","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/search/warehouse/INDEX","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateAtmAttribute","implemented_by":{"version":"OBPv5.1.0","function":"updateAtmAttribute"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","summary":"Update ATM Attribute","description":"Update ATM Attribute.
\nUpdate an ATM Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Update ATM Attribute.\n\nUpdate an ATM Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ATTRIBUTE_ID](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false},"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":["ATM"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}},"roles":[{"role":"CanUpdateAtmAttribute","requires_bank_id":true},{"role":"CanUpdateAtmAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getScopes","implemented_by":{"version":"OBPv4.0.0","function":"getScopes"},"request_verb":"GET","request_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","summary":"Get Scopes for Consumer","description":"Get all the scopes for an consumer specified by CONSUMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\nlist:
\n\n\n","description_markdown":"Get all the scopes for an consumer specified by CONSUMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**scope_id**](/glossary#scope_id): \n\n\n","success_response_body":{"list":[{"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f","role_name":"CanGetEntitlementsForAnyUserAtOneBank","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-50000: Unknown Error."],"tags":["Scope","Consumer"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumers/CONSUMER_ID/scopes","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserByUserId","implemented_by":{"version":"OBPv4.0.0","function":"getUserByUserId"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/user_id/USER_ID","summary":"Get User by USER_ID","description":"Get user by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
URL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","description_markdown":"Get user by USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nCanGetAnyUser entitlement is required,\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**is_deleted**](/glossary#): is_deleted\n\n\n\n[**is_locked**](/glossary#): is_locked\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**text**](/glossary#text): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[agreements](/glossary#): agreements\n\n\n\n[last_marketing_agreement_signed_date](/glossary#): last_marketing_agreement_signed_date\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"agreements":[{"type":"","text":""}],"is_deleted":false,"last_marketing_agreement_signed_date":"1099-12-31T21:00:00Z","is_locked":false},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/user_id/USER_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-getCoreTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getCoreTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/transactions","summary":"Get Transactions for Account (Core)","description":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\n\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\nposted: 2020-01-27
\nscheme: OBP
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nvalue: 5987953
\n","description_markdown":"Returns transactions list (Core info) of the account specified by ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:23.773Z. NOTE! The default value is now (2026-03-16T21:00:23.773Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transactions":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","this_account":{"id":"String","bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"details":{"type":"AC","description":"OBP","posted":"1099-12-31T21:00:00Z","completed":"1099-12-31T21:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!","OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!","OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!","OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!","OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction","Account Information Service (AIS)","Account","PSD2"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/banks/BANK_ID/accounts/ACCOUNT_ID/transactions","connector_methods":[]},{"operation_id":"OBPv5.1.0-revokeUserAccessToViewById","implemented_by":{"version":"OBPv5.1.0","function":"revokeUserAccessToViewById"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/revoke","summary":"Revoke User access to View","description":"Revoke the User identified by USER_ID access to the view identified.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated..
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n","description_markdown":"Revoke the User identified by USER_ID access to the view identified.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated..\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**revoked**](/glossary#revoked): \n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","view_id":"owner"},"success_response_body":{"revoked":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-20087: The current source view.can_revoke_access_to_custom_views is false.","OBP-20086: The current source view.can_revoke_access_to_views does not contains target view.","OBP-10001: Incorrect json format.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-30252: System view not found. Please specify a valid value for VIEW_ID","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30064: Cannot revoke account access.","OBP-30065: Cannot find account access.","OBP-50000: Unknown Error."],"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"view_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"revoked":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/revoke","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAtm","implemented_by":{"version":"OBPv5.1.0","function":"getAtm"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","summary":"Get Bank ATM","description":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","description_markdown":"Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:\n\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n* ATM Attributes\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_type**](/glossary#): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":"","attributes":[{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30009: ATM not found. Please specify a valid value for ATM_ID.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBanks","implemented_by":{"version":"OBPv4.0.0","function":"getBanks"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks","summary":"Get Banks","description":"Get banks on this API instance
\nReturns a list of banks supported on this server:
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\nbank_routings: bank routing in form of (scheme, address)
\n\nfull_name: full name string
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlogo: logo url
\nname: ACCOUNT_MANAGEMENT_FEE
\nscheme: OBP
\n\nvalue: 5987953
\nwebsite: www.openbankproject.com
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Get banks on this API instance\nReturns a list of banks supported on this server:\n\n* ID used as parameter in URLs\n* Short and full name of bank\n* Logo URL\n* Website\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routings":[{"scheme":"OBP","address":"gh.29.uk"}],"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"bank_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"website":{"type":"string"},"logo":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks","connector_methods":[]},{"operation_id":"OBPv3.1.0-getConsumersForCurrentUser","implemented_by":{"version":"OBPv3.1.0","function":"getConsumersForCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/users/current/consumers","summary":"Get Consumers (logged in User)","description":"Get the Consumers for logged in User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get the Consumers for logged in User.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumers**](/glossary#consumers): \n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"consumers":[{"consumer_id":"8e716299-4668-4efd-976a-67f57a9984ec","app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Consumer"],"typed_success_response_body":{"type":"object","properties":{"consumers":{"type":"array","items":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/users/current/consumers","connector_methods":[]},{"operation_id":"OBPv3.1.0-getAllEntitlements","implemented_by":{"version":"OBPv3.1.0","function":"getAllEntitlements"},"request_verb":"GET","request_url":"/obp/v3.1.0/entitlements","summary":"Get all Entitlements","description":"Login is required.
\nPossible filter on the role field:
\neg: /entitlements?role=CanGetCustomer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Login is required.\n\nPossible filter on the role field:\n\neg: /entitlements?role=CanGetCustomer\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Role","Entitlement"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/entitlements","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelEndpointMapping"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Update Bank Level Endpoint Mapping","description":"Update an Bank Level Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Update an Bank Level Endpoint Mapping.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}}},"success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanUpdateBankLevelEndpointMapping","requires_bank_id":true},{"role":"CanUpdateEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllBankLevelDynamicResourceDocs","implemented_by":{"version":"OBPv4.0.0","function":"getAllBankLevelDynamicResourceDocs"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-resource-docs","summary":"Get all Bank Level Dynamic Resource Docs","description":"Get all Bank Level Dynamic Resource Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Get all Bank Level Dynamic Resource Docs.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"dynamic-resource-docs":[{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}}]},"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-Resource-Doc"],"typed_success_response_body":{"type":"object","properties":{"dynamic-resource-docs":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllBankLevelDynamicResourceDocs","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-resource-docs","connector_methods":[]},{"operation_id":"OBPv5.1.0-accountCurrencyCheck","implemented_by":{"version":"OBPv5.1.0","function":"accountCurrencyCheck"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/system/integrity/banks/BANK_ID/account-currency-check","summary":"Check for Sensible Currencies","description":"Check for sensible currencies at Bank Account model
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","description_markdown":"Check for sensible currencies at Bank Account model\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**success**](/glossary#success): \n\n\n\n[debug_info](/glossary#): debug_info\n\n\n","success_response_body":{"success":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":["System-Integrity"],"typed_success_response_body":{"type":"object","properties":{"success":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemIntegrity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system/integrity/banks/BANK_ID/account-currency-check","connector_methods":[]},{"operation_id":"OBPv3.0.0-deleteScope","implemented_by":{"version":"OBPv3.0.0","function":"deleteScope"},"request_verb":"DELETE","request_url":"/obp/v3.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID","summary":"Delete Consumer Scope","description":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","description_markdown":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[SCOPE_ID](/glossary#scope_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-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Scope","Consumer"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumers/CONSUMER_ID/scope/SCOPE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-mtlsClientCertificateInfo","implemented_by":{"version":"OBPv5.1.0","function":"mtlsClientCertificateInfo"},"request_verb":"GET","request_url":"/obp/v5.1.0/my/mtls/certificate/current","summary":"Provide client's certificate info of a current call","description":"Provide client's certificate info of a current call specified by PSD2-CERT value at Request Header
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nsubject_domain_name: subject_domain_name
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Provide client's certificate info of a current call specified by PSD2-CERT value at Request Header\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","success_response_body":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/mtls/certificate/current","connector_methods":[]},{"operation_id":"OBPv1.4.0-getCrmEvents","implemented_by":{"version":"OBPv1.4.0","function":"getCrmEvents"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/crm-events","summary":"Get CRM Events","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nactual_date: 2020-01-27
\nbank_id: gh.29.uk
\n\n\n\n\ncustomer_number: 5987953
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nscheduled_date: 2020-01-27
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**actual_date**](/glossary#actual_date): 2020-01-27\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**channel**](/glossary#channel): \n\n\n\n[**crm_events**](/glossary#crm_events): \n\n\n\n[**customer_name**](/glossary#customer_name): \n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**result**](/glossary#result): \n\n\n\n[**scheduled_date**](/glossary#scheduled_date): 2020-01-27\n\n\n","success_response_body":{"crm_events":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","bank_id":"gh.29.uk","customer_name":"String","customer_number":"5987953","category":"String","detail":"String","channel":"String","scheduled_date":"1099-12-31T21:00:00Z","actual_date":"1099-12-31T21:00:00Z","result":"String"}]},"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.","No CRM Events available.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"crm_events":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"result":{"type":"string"},"customer_name":{"type":"string"},"category":{"type":"string"},"scheduled_date":{"type":"string","format":"date-time"},"detail":{"type":"string"},"channel":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/crm-events","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateProductAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Update Product Attribute","description":"Update Product Attribute.
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nUpdate one Product Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Update Product Attribute. \n\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nUpdate one Product Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"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":["Product"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-addTagForViewOnAccount","implemented_by":{"version":"OBPv4.0.0","function":"addTagForViewOnAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags","summary":"Create a tag on account","description":"Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a tag about an account ACCOUNT_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account-Metadata","Account"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateAccountApplicationStatus","implemented_by":{"version":"OBPv3.1.0","function":"updateAccountApplicationStatus"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications/ACCOUNT_APPLICATION_ID","summary":"Update Account Application Status","description":"Update an Account Application status
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","description_markdown":"Update an Account Application status\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_APPLICATION_ID](/glossary#account_application_id): \n\n\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[**account_application_id**](/glossary#account_application_id): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_application**](/glossary#date_of_application): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"status":"ACCEPTED"},"success_response_body":{"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763","product_code":"1234BW","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"date_of_application":"1099-12-31T21:00:00Z","status":"REQUESTED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account-Application","Account"],"typed_request_body":{"type":"object","properties":{"status":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_of_application":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"account_application_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-applications/ACCOUNT_APPLICATION_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserInvitation","implemented_by":{"version":"OBPv4.0.0","function":"getUserInvitation"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitations/SECRET_LINK","summary":"Get User Invitation","description":"Get User Invitation
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nSECRET_LINK: SECRET_LINK
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Get User Invitation\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SECRET_LINK](/glossary#): SECRET_LINK\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User-Invitation"],"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"roles":[{"role":"CanGetUserInvitation","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitations/SECRET_LINK","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAtmAttribute","implemented_by":{"version":"OBPv5.1.0","function":"getAtmAttribute"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","summary":"Get ATM Attribute By ATM_ATTRIBUTE_ID","description":"Get ATM Attribute By ATM_ATTRIBUTE_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get ATM Attribute By ATM_ATTRIBUTE_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ATTRIBUTE_ID](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}},"roles":[{"role":"CanGetAtmAttribute","requires_bank_id":true},{"role":"CanGetAtmAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/transaction","summary":"Get Transaction Attribute Definition","description":"Get Transaction Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Transaction Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Transaction","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/transaction","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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-getCounterpartyByIdForAnyAccount","implemented_by":{"version":"OBPv4.0.0","function":"getCounterpartyByIdForAnyAccount"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Get Counterparty by Id for any account (Explicit)","description":"This is a management endpoint that gets information about any single explicitly created Counterparty on an Account / View specified by its COUNTERPARTY_ID",
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"This is a management endpoint that gets information about any single explicitly created Counterparty on an Account / View specified by its COUNTERPARTY_ID\",\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Counterparty","Account"],"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"image_url":{"type":"string"}}},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"roles":[{"role":"CanGetCounterpartyAtAnyBank","requires_bank_id":false},{"role":"CanGetCounterparty","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"getDynamicResourceDoc"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Get Dynamic Resource Doc by Id","description":"Get a Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Get a Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanGetDynamicResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getMeeting","implemented_by":{"version":"OBPv3.1.0","function":"getMeeting"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings/MEETING_ID","summary":"Get Meeting","description":"Get Meeting specified by BANK_ID / MEETING_ID
\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Get Meeting specified by BANK_ID / MEETING_ID\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.\n\nThe actual conference/chats are handled by external services.\n\nLogin is required.\n\nThis call is **experimental** and will require further authorisation in the future.\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[MEETING_ID](/glossary#meeting_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","success_response_body":{"meeting_id":"UUID-String","provider_id":"Chris","purpose_id":"String, eg: onboarding","bank_id":"gh.29.uk","present":{"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"keys":{"session_id":"String","staff_token":"String","customer_token":"String"},"when":"1099-12-31T21:00:00Z","creator":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"invitees":[{"contact_details":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"status":"String, eg: Good"}]},"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-30104: Meeting not found.","OBP-50000: Unknown Error."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_success_response_body":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/meetings/MEETING_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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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![\"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
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].
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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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\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\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":[]},{"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
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\ndescription: Description of the object. 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\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. 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":[]},{"operation_id":"OBPv4.0.0-getProductFees","implemented_by":{"version":"OBPv4.0.0","function":"getProductFees"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees","summary":"Get Product Fees","description":"Get Product Fees
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nproduct_fees: product_fees
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Product Fees\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**product_fees**](/glossary#): product_fees\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"product_fees":[{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"product_fees":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/fees","connector_methods":[]},{"operation_id":"OBPv5.0.0-getMyCustomersAtBank","implemented_by":{"version":"OBPv5.0.0","function":"getMyCustomersAtBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/my/customers","summary":"Get My Customers at Bank","description":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Returns a list of Customers at the Bank that are linked to the currently authenticated User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z"}]},"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-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/customers","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyMoreInfo"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Add Counterparty More Info","description":"Add a description of the counter party from the perpestive of the account e.g. My dentist
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nmore_info: More information about this fee
\nJSON response body fields:
\n\n","description_markdown":"Add a description of the counter party from the perpestive of the account e.g. My dentist\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"more_info":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","the view ownerdoes not allow adding more info","More Info cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"more_info":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAccountOtp","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAccountOtp"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT_OTP/transaction-requests","summary":"Create Transaction Request (ACCOUNT_OTP)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using ACCOUNT, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ACCOUNT_OTP](/glossary#account_otp): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT_OTP/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-createSystemAccountNotificationWebhook","implemented_by":{"version":"OBPv4.0.0","function":"createSystemAccountNotificationWebhook"},"request_verb":"POST","request_url":"/obp/v4.0.0/web-hooks/account/notifications/on-create-transaction","summary":"Create system level Account Notification Webhook","description":"Create a notification Webhook that will fire for all accounts on the system.
\nWebhooks are used to call external web services when certain events happen.
\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.
\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.
\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.
\nThe webhook will POST the following structure to your service:
\n{
\n"event_name": "OnCreateTransaction",
\n"event_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"transaction_id": "7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"related_entities": [
\n{
\n"user_id": "8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
\n"customer_ids": ["3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"]
\n}
\n]
\n}
Thus, your service should accept the above POST body structure.
\nIn this way, your web service can be informed about an event on an account and act accordingly.
\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nhttp_method: GET
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\nhttp_method: GET
\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nwebhook_id: webhook_id
\n","description_markdown":"Create a notification Webhook that will fire for all accounts on the system.\n\n\nWebhooks are used to call external web services when certain events happen.\n\nFor instance, a webhook can be used to notify an external service if a transaction is created on an account.\n\n\n\n\nWhen an account notification webhook fires it will POST to the URL you specify during the creation of the webhook.\n\nInside the payload you will find account_id and transaction_id and also user_ids and customer_ids of the Users / Customers linked to the Account.\n |\nThe webhook will POST the following structure to your service:\n\n{\n \"event_name\": \"OnCreateTransaction\",\n \"event_id\": \"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"bank_id\": \"gh.29.uk\",\n \"account_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"transaction_id\": \"7ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"related_entities\": [\n {\n \"user_id\": \"8ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\",\n \"customer_ids\": [\"3ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\"]\n }\n ]\n}\n\nThus, your service should accept the above POST body structure.\n\nIn this way, your web service can be informed about an event on an account and act accordingly.\n\nFurther information about the account, transaction or related entities can then be retrieved using the standard REST APIs.\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**webhook_id**](/glossary#): webhook_id\n\n\n","example_request_body":{"url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1"},"success_response_body":{"webhook_id":"fc23a7e2-7dd2-4bdf-a0b4-ae31232a4762","trigger_name":"OnCreateTransaction","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"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":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"http_protocol":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"webhook_id":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateSystemAccountNotificationWebhook","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/web-hooks/account/notifications/on-create-transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-getPrivateAccountsAtOneBank","implemented_by":{"version":"OBPv4.0.0","function":"getPrivateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts","summary":"Get Accounts at Bank","description":"Returns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user..
\nEach account must have at least one private View.
optional request parameters for filter with attributes
\nURL params example: /banks/some-bank-id/accounts?&limit=50&offset=1
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","description_markdown":"Returns the list of accounts at BANK_ID that the user has access to.\nFor each account the API returns the account ID and the views available to the user..\nEach account must have at least one private View.\n\noptional request parameters for filter with attributes\nURL params example: /banks/some-bank-id/accounts?&limit=50&offset=1\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":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-50000: Unknown Error."],"tags":["Account","PrivateData","PublicData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts","connector_methods":[]},{"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.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n","description_markdown":"Get all Authentication Type Validations - public.\n\n\n\nUser Authentication is Optional. The User need not be logged in.\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":"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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-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:
\nUser Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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.","OBP-00014: Mandatory properties must be 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":"OBPv1.2.1-addCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyPublicAlias"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Add public alias to other bank account","description":"Creates the public alias for the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
\nthe public alias was deleted.
The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates the public alias for the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\nNote: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if\nthe public alias was deleted.\n\nThe VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","the view does not allow metadata access","the view does not allow adding a public alias","Alias cannot be added","public alias added"],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerAccountLinksByCustomerId","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerAccountLinksByCustomerId"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-account-links","summary":"Get Customer Account Links by CUSTOMER_ID","description":"Get Customer Account Links by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nlinks: links
\nrelationship_type: Owner
\n","description_markdown":"Get Customer Account Links by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_account_link_id**](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**links**](/glossary#): links\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n","success_response_body":{"links":[{"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"}]},"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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"links":{"type":"array","items":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAccountLinks","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-account-links","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankLevelDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelDynamicResourceDoc"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-resource-docs","summary":"Create Bank Level Dynamic Resource Doc","description":"Create a Bank Level Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Create a Bank Level Dynamic Resource Doc.\n\nThe connector_method_body is URL-encoded format String\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanCreateBankLevelDynamicResourceDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-resource-docs","connector_methods":[]},{"operation_id":"OBPv1.2.1-getCommentsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getCommentsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Get Transaction Comments","description":"Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID comments made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteProductFee","implemented_by":{"version":"OBPv4.0.0","function":"deleteProductFee"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Delete Product Fee","description":"Delete Product Fee
\nDelete one product fee by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\n","description_markdown":"Delete Product Fee\n\nDelete one product fee by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\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-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":["Product"],"roles":[{"role":"CanDeleteProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv3.1.0-createConsentImplicit","implemented_by":{"version":"OBPv3.1.0","function":"createConsentImplicit"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/IMPLICIT","summary":"Create Consent (IMPLICIT)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\",\"EMAIL\" or \"IMPLICIT\". \"EMAIL\" is used for testing purposes. OBP mapped mode \"IMPLICIT\" is \"EMAIL\".\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nExample 1: \n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n}\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[IMPLICIT](/glossary#): IMPLICIT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**everything**](/glossary#everything): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","valid_from":"2026-03-16T21:00:23Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"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-10001: Incorrect json format.","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/consents/IMPLICIT","connector_methods":[]},{"operation_id":"OBPv5.1.0-createRegulatedEntityAttribute","implemented_by":{"version":"OBPv5.1.0","function":"createRegulatedEntityAttribute"},"request_verb":"POST","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes","summary":"Create Regulated Entity Attribute","description":"Create a new Regulated Entity Attribute for a given REGULATED_ENTITY_ID.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or "DATE_WITH_DAY".
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON request body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Create a new Regulated Entity Attribute for a given REGULATED_ENTITY_ID.\n\n The type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or \"DATE_WITH_DAY\".\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_ID\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**regulated_entity_attribute_id**](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**regulated_entity_id**](/glossary#): regulated_entity_id\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"Attribute Name","attribute_type":"STRING","value":"1234","is_active":false},"success_response_body":{"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","attribute_type":"","value":"5987953","is_active":false},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Directory","API"],"typed_request_body":{"type":"object","properties":{"attribute_type":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanCreateRegulatedEntityAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes","connector_methods":[]},{"operation_id":"OBPv5.1.0-createRegulatedEntity","implemented_by":{"version":"OBPv5.1.0","function":"createRegulatedEntity"},"request_verb":"POST","request_url":"/obp/v5.1.0/regulated-entities","summary":"Create Regulated Entity","description":"Create Regulated Entity
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Create Regulated Entity\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**attributeType**](/glossary#): attributeType\n\n\n\n[**certificate_authority_ca_owner_id**](/glossary#certificate_authority_ca_owner_id): CY_CBC\n\n\n\n[**entity_address**](/glossary#entity_address): EXAMPLE COMPANY LTD, 5 SOME STREET\n\n\n\n[**entity_certificate_public_key**](/glossary#entity_certificate_public_key): MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==\n\n\n\n[**entity_code**](/glossary#entity_code): PSD_PICY_CBC!12345\n\n\n\n[**entity_country**](/glossary#entity_country): CY\n\n\n\n[**entity_name**](/glossary#entity_name): EXAMPLE COMPANY LTD\n\n\n\n[**entity_post_code**](/glossary#entity_post_code): 1060\n\n\n\n[**entity_town_city**](/glossary#entity_town_city): SOME CITY\n\n\n\n[**entity_type**](/glossary#entity_type): PSD_PI\n\n\n\n[**entity_web_site**](/glossary#entity_web_site): www.example.com\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attributeType**](/glossary#): attributeType\n\n\n\n[**certificate_authority_ca_owner_id**](/glossary#certificate_authority_ca_owner_id): CY_CBC\n\n\n\n[**entity_address**](/glossary#entity_address): EXAMPLE COMPANY LTD, 5 SOME STREET\n\n\n\n[**entity_certificate_public_key**](/glossary#entity_certificate_public_key): MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==\n\n\n\n[**entity_code**](/glossary#entity_code): PSD_PICY_CBC!12345\n\n\n\n[**entity_country**](/glossary#entity_country): CY\n\n\n\n[**entity_id**](/glossary#entity_id): 0af807d7-3c39-43ef-9712-82bcfde1b9ca\n\n\n\n[**entity_name**](/glossary#entity_name): EXAMPLE COMPANY LTD\n\n\n\n[**entity_post_code**](/glossary#entity_post_code): 1060\n\n\n\n[**entity_town_city**](/glossary#entity_town_city): SOME CITY\n\n\n\n[**entity_type**](/glossary#entity_type): PSD_PI\n\n\n\n[**entity_web_site**](/glossary#entity_web_site): www.example.com\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","example_request_body":{"certificate_authority_ca_owner_id":"CY_CBC","entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==","entity_name":"EXAMPLE COMPANY LTD","entity_code":"PSD_PICY_CBC!12345","entity_type":"PSD_PI","entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET","entity_town_city":"SOME CITY","entity_post_code":"1060","entity_country":"CY","entity_web_site":"www.example.com","services":[{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}],"attributes":[{"attributeType":"STRING","name":"STATUS","value":"closed"}]},"success_response_body":{"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","certificate_authority_ca_owner_id":"CY_CBC","entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==","entity_name":"EXAMPLE COMPANY LTD","entity_code":"PSD_PICY_CBC!12345","entity_type":"PSD_PI","entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET","entity_town_city":"SOME CITY","entity_post_code":"1060","entity_country":"CY","entity_web_site":"www.example.com","services":[{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}],"attributes":[{"attributeType":"STRING","name":"STATUS","value":"closed"}]},"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":["Directory","API"],"typed_request_body":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}},"roles":[{"role":"CanCreateRegulatedEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities","connector_methods":[]},{"operation_id":"OBPv4.0.0-getPrivateAccountByIdFull","implemented_by":{"version":"OBPv4.0.0","function":"getPrivateAccountByIdFull"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account","summary":"Get Account by Id (Full)","description":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
\nMore details about the data moderation by the view here.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","description_markdown":"Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):\n\n* Number\n* Owners\n* Type\n* Balance\n* IBAN\n* Available views (sorted by short_name)\n\nMore details about the data moderation by the view [here](#1_2_1-getViewsForBankAccount).\n\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.\nThis call provides balance and other account information via delegated authentication using OAuth.\n\nAuthentication is required if the 'is_public' field in view (VIEW_ID) is not set to `true`.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NoneLabel","number":"123","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account","connector_methods":[]},{"operation_id":"OBPv5.1.0-createConsumerDynamicRegistration","implemented_by":{"version":"OBPv5.1.0","function":"createConsumerDynamicRegistration"},"request_verb":"POST","request_url":"/obp/v5.1.0/dynamic-registration/consumers","summary":"Create a Consumer(Dynamic Registration)","description":"Create a Consumer (mTLS access).
\nJWT payload:
\n- minimal
\n{ "description":"Description" }
\n- full
\n{
\n"description": "Description",
\n"app_name": "Tesobe GmbH",
\n"app_type": "Sofit",
\n"developer_email": "marko@tesobe.com",
\n"redirect_url": "http://localhost:8082"
\n}
\nPlease note that JWT must be signed with the counterpart private key of the public key used to establish mTLS
User Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Create a Consumer (mTLS access).\n\n JWT payload:\n - minimal\n { \"description\":\"Description\" }\n - full\n {\n \"description\": \"Description\",\n \"app_name\": \"Tesobe GmbH\",\n \"app_type\": \"Sofit\",\n \"developer_email\": \"marko@tesobe.com\",\n \"redirect_url\": \"http://localhost:8082\"\n }\n Please note that JWT must be signed with the counterpart private key of the public key used to establish mTLS\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON request body fields:**\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"jwt":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJkZXNjcmlwdGlvbiI6IlRQUCBkZXNjcmlwdGlvbiJ9.c5gPPsyUmnVW774y7h2xyLXg0wdtu25nbU2AvOmyzcWa7JTdCKuuy3CblxueGwqYkQDDQIya1Qny4blyAvh_a1Q28LgzEKBcH7Em9FZXerhkvR9v4FWbCC5AgNLdQ7sR8-rUQdShmJcGDKdVmsZjuO4XhY2Zx0nFnkcvYfsU9bccoAvkKpVJATXzwBqdoEOuFlplnbxsMH1wWbAd3hbcPPWTdvO43xavNZTB5ybgrXVDEYjw8D-98_ZkqxS0vfvhJ4cGefHViaFzp6zXm7msdBpcE__O9rFbdl9Gvup_bsMbrHJioIrmc2d15Yc-tTNTF9J4qjD_lNxMRlx5o2TZEw"},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Directory","Consumer"],"typed_request_body":{"type":"object","properties":{"jwt":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/dynamic-registration/consumers","connector_methods":[]},{"operation_id":"OBPv3.1.0-createConsentSms","implemented_by":{"version":"OBPv3.1.0","function":"createConsentSms"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/SMS","summary":"Create Consent (SMS)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"email": "eveline@example.com"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\nSMS:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\",\"EMAIL\" or \"IMPLICIT\". \"EMAIL\" is used for testing purposes. OBP mapped mode \"IMPLICIT\" is \"EMAIL\".\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nExample 1: \n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"email\": \"eveline@example.com\"\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SMS](/glossary#sms): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**everything**](/glossary#everything): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","phone_number":"+44 07972 444 876","valid_from":"2026-03-16T21:00:23Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"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-10001: Incorrect json format.","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"phone_number":{"type":"string"},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/consents/SMS","connector_methods":[]},{"operation_id":"OBPv3.0.0-getAccountsHeld","implemented_by":{"version":"OBPv3.0.0","function":"getAccountsHeld"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts-held","summary":"Get Accounts Held","description":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","description_markdown":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.\n\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n","success_response_body":{"accounts":[{"id":"7b97bd26-583b-4c3b-8282-55ea9d934aad","label":"My Account","bank_id":"123","number":"123","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","View-Custom","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts-held","connector_methods":[]},{"operation_id":"OBPv2.0.0-createUser","implemented_by":{"version":"OBPv2.0.0","function":"createUser"},"request_verb":"POST","request_url":"/obp/v2.0.0/users","summary":"Create User","description":"Creates OBP user.
\nNo authorisation (currently) required.
Mimics current webform to Register.
\nRequires username(email) and password.
\nReturns 409 error if username not unique.
\nMay require validation of email address.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\nfirst_name: Tom
\nlast_name: Smith
\npassword: password
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Creates OBP user.\n No authorisation (currently) required.\n\n Mimics current webform to Register.\n\n Requires username(email) and password.\n\n Returns 409 error if username not unique.\n\n May require validation of email address.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**password**](/glossary#): password\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"email":"felixsmith@example.com","username":"felixsmith","password":"String","first_name":"Simon","last_name":"Redfern"},"success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR the length should be > 16 and <= 512.","Error occurred during user creation.","User with the same username already exists.","OBP-50000: Unknown Error."],"tags":["User","Onboarding"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"password":{"type":"string"},"username":{"type":"string"},"last_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateBankAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateBankAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/bank","summary":"Create or Update Bank Attribute Definition","description":"Create or Update Bank Attribute Definition
\nThe category field must be Bank
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Bank Attribute Definition\n\nThe category field must be Bank\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Bank","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateBankAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/bank","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerData","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerData"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/data","summary":"Update the other data of a Customer","description":"Update the other data of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the other data of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"relationship_status":"single","dependants":1,"highest_education_attained":"Master","employment_status":"worker"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"dependants":{"type":"integer"},"employment_status":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"highest_education_attained":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerIdentity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/data","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get all my Dynamic Entities.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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.1.0-getBankAccountBalanceById","implemented_by":{"version":"OBPv5.1.0","function":"getBankAccountBalanceById"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","summary":"Get Bank Account Balance By ID","description":"Get a specific Bank Account Balance by its BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","description_markdown":"Get a specific Bank Account Balance by its BALANCE_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BALANCE_ID](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**balance_amount**](/glossary#): 50.89\n\n\n\n[**balance_id**](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**balance_type**](/glossary#balance_type): openingBooked\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n","success_response_body":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","balance_type":"openingBooked","balance_amount":"50.89"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Balance"],"typed_success_response_body":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-getPermissionsForBankAccount","implemented_by":{"version":"OBPv2.0.0","function":"getPermissionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions","summary":"Get access","description":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nand the user needs to have access to the owner view.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nprovider: ETHEREUM
\n\nuser:
\n\n","description_markdown":"Returns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nand the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**permissions**](/glossary#permissions): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**views**](/glossary#views): \n\n\n","success_response_body":{"permissions":[{"user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"},"views":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account","User","Entitlement"],"typed_success_response_body":{"type":"object","properties":{"permissions":{"type":"array","items":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":[]},{"operation_id":"OBPv5.1.0-updateConsumerLogoURL","implemented_by":{"version":"OBPv5.1.0","function":"updateConsumerLogoURL"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/logo_url","summary":"Update Consumer LogoURL","description":"Update an existing logoURL for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Update an existing logoURL for a Consumer specified by CONSUMER_ID.\n\n Please note: Your consumer may be disabled as a result of this action.\n\n CONSUMER_ID can be obtained after you register the application.\n\n Or use the endpoint 'Get Consumers' to get it\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"logo_url":"http://localhost:8888"},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"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":["Consumer"],"typed_request_body":{"type":"object","properties":{"logo_url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"roles":[{"role":"CanUpdateConsumerLogoUrl","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/logo_url","connector_methods":[]},{"operation_id":"OBPv4.0.0-createHistoricalTransactionAtBank","implemented_by":{"version":"OBPv4.0.0","function":"createHistoricalTransactionAtBank"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/management/historical/transactions","summary":"Create Historical Transactions ","description":"Create historical transactions at one Bank
\nUse this endpoint to create transactions between any two accounts at the same bank.
\nFrom account and to account must be at the same bank.
\nExample:
\n{
\n"from_account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"to_account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom_account_id: from_account_id
\nposted: 2020-01-27
\nto_account_id: to_account_id
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nfrom:
\nposted: 2020-01-27
\nto:
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n","description_markdown":"Create historical transactions at one Bank\n\nUse this endpoint to create transactions between any two accounts at the same bank. \nFrom account and to account must be at the same bank.\nExample:\n{\n \"from_account_id\": \"1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"to_account_id\": \"2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\",\n \"value\": {\n \"currency\": \"GBP\",\n \"amount\": \"10\"\n },\n \"description\": \"this is for work\",\n \"posted\": \"2017-09-19T02:31:05Z\",\n \"completed\": \"2017-09-19T02:31:05Z\",\n \"type\": \"SANDBOX_TAN\",\n \"charge_policy\": \"SHARED\"\n}\n\nThis call is experimental.\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from_account_id**](/glossary#): from_account_id\n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to_account_id**](/glossary#): to_account_id\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**from**](/glossary#from): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request_type**](/glossary#): SEPA\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_id](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n[counterparty_id](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n","example_request_body":{"from_account_id":"","to_account_id":"","value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1100-01-01T01:01:01Z","completed":"1100-01-01T01:01:01Z","type":"SANDBOX_TAN","charge_policy":"SHARED"},"success_response_body":{"transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work","posted":"1099-12-31T22:01:01Z","completed":"1099-12-31T22:01:01Z","transaction_request_type":"SANDBOX_TAN","charge_policy":"SHARED"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"from_account_id":{"type":"string"},"completed":{"type":"string"},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"posted":{"type":"string"},"to_account_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"description":{"type":"string"},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"transaction_request_type":{"type":"string"},"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"},"counterparty_id":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"transaction_id":{"type":"string"},"completed":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateHistoricalTransactionAtBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/management/historical/transactions","connector_methods":[]},{"operation_id":"OBPv3.0.0-getAllEntitlementRequests","implemented_by":{"version":"OBPv3.0.0","function":"getAllEntitlementRequests"},"request_verb":"GET","request_url":"/obp/v3.0.0/entitlement-requests","summary":"Get all Entitlement Requests","description":"Get all Entitlement Requests
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get all Entitlement Requests\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlement_request_id**](/glossary#entitlement_request_id): \n\n\n\n[**entitlement_requests**](/glossary#entitlement_requests): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"entitlement_requests":[{"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"role_name":"CanQueryOtherUser","bank_id":"gh.29.uk","created":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"entitlement_requests":{"type":"array","items":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}}}}},"roles":[{"role":"CanGetEntitlementRequestsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/entitlement-requests","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "50f5a547-cc13-4cbc-9678-20dd3ce0faa8"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&branchId=0684aa04-72ee-492b-8de8-c8ad40f27295"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&atmId=0684aa04-72ee-492b-8de8-c8ad40f27295"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&accountId=0684aa04-72ee-492b-8de8-c8ad40f27295"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&productCode=0684aa04-72ee-492b-8de8-c8ad40f27295"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&cardId=0684aa04-72ee-492b-8de8-c8ad40f27295"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&accountId=0684aa04-72ee-492b-8de8-c8ad40f27295&transactionId=7f8e6bcb-9ecf-4b53-acd3-05b13473d6b9"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=50f5a547-cc13-4cbc-9678-20dd3ce0faa8&accountId=0684aa04-72ee-492b-8de8-c8ad40f27295&counterpartyId=7f8e6bcb-9ecf-4b53-acd3-05b13473d6b9"\n}\n\nNote: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.
Update Endpoint Tag, you can only update the tag_name here, operation_id can not be updated.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nNote: Resource Docs are cached, TTL is 3600 seconds\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv1.2.1-addCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"addCounterpartyUrl"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Add url to other bank account","description":"A url which represents the counterparty (home page url etc.)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\n\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a url","URL cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTagForViewOnAccount","implemented_by":{"version":"OBPv4.0.0","function":"deleteTagForViewOnAccount"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags/TAG_ID","summary":"Delete a tag on account","description":"Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the tag TAG_ID about the account ACCOUNT_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TAG_ID](/glossary#tag_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account-Metadata","Account"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags/TAG_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-systemViewNamesCheck","implemented_by":{"version":"OBPv5.1.0","function":"systemViewNamesCheck"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/system/integrity/system-view-names-check","summary":"Check System View Names","description":"Check system view names.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","description_markdown":"Check system view names.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n\n[debug_info](/glossary#): debug_info\n\n\n","success_response_body":{"success":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":["System-Integrity"],"typed_success_response_body":{"type":"object","properties":{"success":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemIntegrity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system/integrity/system-view-names-check","connector_methods":[]},{"operation_id":"OBPv4.0.0-getScannedApiVersions","implemented_by":{"version":"OBPv4.0.0","function":"getScannedApiVersions"},"request_verb":"GET","request_url":"/obp/v4.0.0/api/versions","summary":"Get scanned API Versions","description":"Get all the scanned API Versions.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n","description_markdown":"Get all the scanned API Versions.\n\nUser Authentication is Optional. The User need not be logged in.\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":"OBPv1.2.1-getTransactionNarrative","implemented_by":{"version":"OBPv1.2.1","function":"getTransactionNarrative"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","summary":"Get a Transaction Narrative","description":"Returns the account owner description of the transaction moderated by the view.
\nAuthentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the account owner description of the transaction [moderated](#1_2_1-getViewsForBankAccount) by the view.\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n","success_response_body":{"narrative":"narative"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_success_response_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomersAtAnyBank","implemented_by":{"version":"OBPv4.0.0","function":"getCustomersAtAnyBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/customers","summary":"Get Customers at Any Bank","description":"Get Customers at Any Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Get Customers at Any Bank.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**customers**](/glossary#customers): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"19900101","relationship_status":"single","dependants":1,"dob_of_dependants":["19900101"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:25Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"dependants":{"type":"integer"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"date_of_birth":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string"}},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}}},"roles":[{"role":"CanGetCustomersAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers","connector_methods":[]},{"operation_id":"OBPv5.0.0-createSystemView","implemented_by":{"version":"OBPv5.0.0","function":"createSystemView"},"request_verb":"POST","request_url":"/obp/v5.0.0/system-views","summary":"Create System View","description":"Create a system view
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the CanCreateSystemView entitlement.
\nThe 'allowed_actions' field is a list containing the names of the actions allowed through this view.
\nAll the actions contained in the list will be set to true on the view creation, the rest will be set to false.
The 'alias' field in the JSON can take one of three values:
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
System views cannot be public. In case you try to set it you will get the error OBP-30258: System view cannot be public
\nJSON request body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_revoke_access_to_views: can_revoke_access_to_views
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Create a system view\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the CanCreateSystemView entitlement.\n\n The 'allowed_actions' field is a list containing the names of the actions allowed through this view.\n All the actions contained in the list will be set to `true` on the view creation, the rest will be set to `false`.\n\n The 'alias' field in the JSON can take one of three values:\n\n * _public_: to use the public alias if there is one specified for the other account.\n * _private_: to use the private alias if there is one specified for the other account.\n * _''(empty string)_: to use no alias; the view shows the real name of the other account.\n\n The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to `true` and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.\n\n System views cannot be public. In case you try to set it you will get the error OBP-30258: System view cannot be public\n\n\n**JSON request body fields:**\n\n\n\n[**allowed_actions**](/glossary#allowed_actions): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**which_alias_to_use**](/glossary#which_alias_to_use): public\n\n\n\n[can_grant_access_to_views](/glossary#): can_grant_access_to_views\n\n\n\n[can_revoke_access_to_views](/glossary#): can_revoke_access_to_views\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_grant_access_to_views**](/glossary#): can_grant_access_to_views\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_revoke_access_to_views**](/glossary#): can_revoke_access_to_views\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","example_request_body":{"name":"owner","description":"This view is for the owner for the account.","metadata_view":"This view is for the owner for the account.","is_public":false,"which_alias_to_use":"public","hide_metadata_if_alias_used":false,"allowed_actions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"],"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"],"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"typed_request_body":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"which_alias_to_use":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}},"metadata_view":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"roles":[{"role":"CanCreateSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankLevelDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelDynamicResourceDoc"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Delete Bank Level Dynamic Resource Doc","description":"Delete a Bank Level Dynamic Resource Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete a Bank Level Dynamic Resource Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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-Resource-Doc"],"roles":[{"role":"CanDeleteBankLevelDynamicResourceDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionRequestAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionRequestAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction-request","summary":"Delete Transaction Request Attribute Definition","description":"Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Transaction Request Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"boolean"}}},"roles":[{"role":"CanDeleteTransactionRequestAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/transaction-request","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPublicAlias"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Delete Counterparty Public Alias","description":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting the public alias","Alias cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateAccount","implemented_by":{"version":"OBPv3.1.0","function":"updateAccount"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account","description":"Update the account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","description_markdown":"Update the account. \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"label":"Label","type":"CURRENT","branch_id":"1234","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]},"success_response_body":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"Label","type":"CURRENT","branch_id":"1234","account_routings":[{"scheme":"IBAN","address":"DE91 1000 0000 0123 4567 89"}]},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"branch_id":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"roles":[{"role":"CanUpdateAccount","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateConsentStatusByConsent","implemented_by":{"version":"OBPv5.1.0","function":"updateConsentStatusByConsent"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/banks/BANK_ID/consents/CONSENT_ID","summary":"Update Consent Status by CONSENT_ID","description":"This endpoint is used to update the Status of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint is used to update the Status of Consent.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"status":"AUTHORISED"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"AUTHORISED"},"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-10001: Incorrect json format.","OBP-35001: Consent not found by CONSENT_ID. ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)"],"typed_request_body":{"type":"object","properties":{"status":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"roles":[{"role":"CanUpdateConsentStatusAtOneBank","requires_bank_id":true},{"role":"CanUpdateConsentStatusAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateConsentUserIdByConsentId","implemented_by":{"version":"OBPv5.1.0","function":"updateConsentUserIdByConsentId"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/banks/BANK_ID/consents/CONSENT_ID/created-by-user","summary":"Update Created by User of Consent by CONSENT_ID","description":"This endpoint is used to Update the User bound to a consent.
\nIn general we would not expect for a management user to set the User bound to a consent, but there may be
\nsome use cases where this workflow is useful.
If successful, the "Created by User ID" field in the OBP Consent table will be updated.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint is used to Update the User bound to a consent.\n\nIn general we would not expect for a management user to set the User bound to a consent, but there may be\nsome use cases where this workflow is useful.\n\nIf successful, the \"Created by User ID\" field in the OBP Consent table will be updated.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"user_id":"ed7a7c01-db37-45cc-ba12-0ae8891c195c"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"AUTHORISED"},"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-10001: Incorrect json format.","OBP-35001: Consent not found by CONSENT_ID. ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"roles":[{"role":"CanUpdateConsentUserAtOneBank","requires_bank_id":true},{"role":"CanUpdateConsentUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/consents/CONSENT_ID/created-by-user","connector_methods":[]},{"operation_id":"OBPv4.0.0-getExplicitCounterpartiesForAccount","implemented_by":{"version":"OBPv4.0.0","function":"getExplicitCounterpartiesForAccount"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Get Counterparties (Explicit)","description":"Get the Counterparties that have been explicitly created on the specified Account / View.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\n\nvalue: 5987953
\n","description_markdown":"Get the Counterparties that have been explicitly created on the specified Account / View.\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**counterparties**](/glossary#Counterparties): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"counterparties":[{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Account"],"typed_success_response_body":{"type":"object","properties":{"counterparties":{"type":"array","items":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelDynamicResourceDoc"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Update Bank Level Dynamic Resource Doc","description":"Update a Bank Level Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Update a Bank Level Dynamic Resource Doc.\n\nThe connector_method_body is URL-encoded format String\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanUpdateBankLevelDynamicResourceDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","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 is reachable. (WIP)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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 is reachable. (WIP)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"rest_vMar2019","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":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get a Bank Level Dynamic Endpoint.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv1.3.0-getCards","implemented_by":{"version":"OBPv1.3.0","function":"getCards"},"request_verb":"GET","request_url":"/obp/v1.3.0/cards","summary":"Get cards for the current user","description":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\n\ncollected: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_card_number**](/glossary#): 364435172576215\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**cancelled**](/glossary#cancelled): false\n\n\n\n[**cards**](/glossary#cards): \n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"cards":[{"bank_id":"gh.29.uk","bank_card_number":"364435172576215","name_on_card":"String","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"String","networks":["String"],"allows":["String"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Card"],"typed_success_response_body":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"technology":{"type":"string"},"name_on_card":{"type":"string"},"enabled":{"type":"boolean"},"on_hot_list":{"type":"boolean"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"valid_from_date":{"type":"string","format":"date-time"},"networks":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"bank_card_number":{"type":"string"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"serial_number":{"type":"string"},"collected":{"type":"string","format":"date-time"},"cancelled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/cards","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAtmLocationCategories","implemented_by":{"version":"OBPv4.0.0","function":"updateAtmLocationCategories"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/atms/ATM_ID/location-categories","summary":"Update ATM Location Categories","description":"Update ATM Location Categories.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nlocation_categories: location_categories
\n","description_markdown":"Update ATM Location Categories.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n","example_request_body":{"location_categories":["ATBI","ATBE"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","location_categories":["ATBI","ATBE"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"location_categories":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"atm_id":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/location-categories","connector_methods":[]},{"operation_id":"OBPv1.2.1-addWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addWhereTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Add a Transaction where Tag","description":"Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**where**](/glossary#where): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission:","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteUserCustomerLink","implemented_by":{"version":"OBPv4.0.0","function":"deleteUserCustomerLink"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/user_customer_links/USER_CUSTOMER_LINK_ID","summary":"Delete User Customer Link","description":"Delete User Customer Link by USER_CUSTOMER_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n","description_markdown":"Delete User Customer Link by USER_CUSTOMER_LINK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[USER_CUSTOMER_LINK_ID](/glossary#user_customer_link_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-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":["Customer"],"roles":[{"role":"CanDeleteUserCustomerLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user_customer_links/USER_CUSTOMER_LINK_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAccountLabel","implemented_by":{"version":"OBPv4.0.0","function":"updateAccountLabel"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account Label","description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nlabel: My Account
\nJSON response body fields:
\n\n","description_markdown":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"label":"updated label"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","user does not have access to owner view on account"],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getProductTree","implemented_by":{"version":"OBPv3.1.0","function":"getProductTree"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-tree/PRODUCT_CODE","summary":"Get Product Tree","description":"Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE
\nand it's parent product(s) recursively as specified by parent_product_code.
Each product includes the following information.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\ncode: 125
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n","description_markdown":"Returns information about a particular financial product specified by BANK_ID and PRODUCT_CODE\nand it's parent product(s) recursively as specified by parent_product_code.\n\nEach product includes the following information.\n\n* Name\n* Code\n* Parent Product Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License: The licence under which this product data is released. Licence can be an Open Data licence such as Open Data Commons Public Domain Dedication and License (PDDL) or Copyright etc.\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**family**](/glossary#family): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[parent_product](/glossary#parent_product): \n\n\n","success_response_body":{"bank_id":"testBank2","code":"PRODUCT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"parent_product":{"bank_id":"testBank2","code":"PARENT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"parent_product":{"bank_id":"testBank2","code":"GRANDPARENT_CODE","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}}}}},"error_response_bodies":["OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"parent_product":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"code":{"type":"string"},"more_info_url":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"family":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"}}},"name":{"type":"string"},"category":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/product-tree/PRODUCT_CODE","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPrivateAlias"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Update Counterparty Private Alias","description":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating the private alias","Alias cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv3.1.0-createProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"createProductCollection"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Create Product Collection","description":"Create or Update a Product Collection at the Bank.
\nUse Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
\nThere is a many to many relationship between Products and Product Collections:
\nA Product can exist in many Collections
\nA Collection can contain many Products.
\nA collection has collection code, one parent Product and one or more child Products.
\nProduct hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n\n\n\nproduct_code: 1234BW
\n\n","description_markdown":"Create or Update a Product Collection at the Bank.\n\nUse Product Collections to create Product \"Baskets\", \"Portfolios\", \"Indices\", \"Collections\", \"Underlyings-lists\", \"Buckets\" etc. etc.\n\nThere is a many to many relationship between Products and Product Collections:\n\n* A Product can exist in many Collections\n\n* A Collection can contain many Products.\n\nA collection has collection code, one parent Product and one or more child Products.\n\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COLLECTION_CODE](/glossary#collection_code): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**collection_code**](/glossary#collection_code): \n\n\n\n[**items**](/glossary#items): \n\n\n\n[**member_product_code**](/glossary#member_product_code): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_collection**](/glossary#product_collection): \n\n\n","example_request_body":{"parent_product_code":"A","children_product_codes":["B","C","D"]},"success_response_body":{"product_collection":[{"collection_code":"C","product_code":"1234BW","items":[{"member_product_code":"A"},{"member_product_code":"B"}]}]},"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":["Product-Collection","Product"],"typed_request_body":{"type":"object","properties":{"parent_product_code":{"type":"string"},"children_product_codes":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"product_collection":{"type":"array","items":{"type":"object","properties":{"collection_code":{"type":"string"},"product_code":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"member_product_code":{"type":"string"}}}}}}}}},"roles":[{"role":"CanMaintainProductCollection","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomerAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getCustomerAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/customer","summary":"Get Customer Attribute Definition","description":"Get Customer Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Customer Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Customer","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomerAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/customer","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsentByConsentIdViaConsumer","implemented_by":{"version":"OBPv5.1.0","function":"getConsentByConsentIdViaConsumer"},"request_verb":"GET","request_url":"/obp/v5.1.0/consumer/current/consents/CONSENT_ID","summary":"Get Consent By Consent Id via Consumer","description":"This endpoint gets the Consent By consent id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","description_markdown":"This endpoint gets the Consent By consent id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[account_access](/glossary#): account_access\n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_access":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/current/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"createAccountWebhook"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Create an Account Webhook","description":"Create an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\n\nhttp_method: GET
\n\nis_active: false
\n\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Create an Account Webhook\n\nWebhooks are used to call external URLs when certain events happen.\n\nAccount Webhooks focus on events around accounts.\n\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.\n\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_webhook_id**](/glossary#account_webhook_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**http_method**](/glossary#http_method): GET\n\n\n\n[**http_protocol**](/glossary#http_protocol): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**trigger_name**](/glossary#trigger_name): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","is_active":"true"},"success_response_body":{"account_webhook_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","trigger_name":"OnBalanceChange","url":"https://localhost.openbankproject.com","http_method":"POST","http_protocol":"HTTP/1.1","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","is_active":true},"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":["Webhook","Bank"],"typed_request_body":{"type":"object","properties":{"http_method":{"type":"string"},"is_active":{"type":"string"},"http_protocol":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"http_method":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"http_protocol":{"type":"string"},"account_webhook_id":{"type":"string"},"trigger_name":{"type":"string"},"account_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanCreateWebhook","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-web-hooks","connector_methods":[]},{"operation_id":"OBPv5.0.0-headAtms","implemented_by":{"version":"OBPv5.0.0","function":"headAtms"},"request_verb":"HEAD","request_url":"/obp/v5.0.0/banks/BANK_ID/atms","summary":"Head Bank ATMS","description":"Head Bank ATMS.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natms:
\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n","description_markdown":"Head Bank ATMS.\n\nUser Authentication is Optional. The User need not be logged in.\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[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n","success_response_body":{"atms":[{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":""}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_success_response_body":{"type":"object","properties":{"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms","connector_methods":[]},{"operation_id":"OBPv3.0.0-getPublicAccountById","implemented_by":{"version":"OBPv3.0.0","function":"getPublicAccountById"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/public/accounts/ACCOUNT_ID/VIEW_ID/account","summary":"Get Public Account by Id","description":"Returns information about an account that has a public view.
\nThe account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\ntype:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","description_markdown":"Returns information about an account that has a public view.\n\nThe account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.\n\n* Number\n* Owners\n* Type\n* Balance\n* Routing\n\n\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.\nThis call provides balance and other account information via delegated authentication using OAuth.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**account_rules**](/glossary#account_rules): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[account_attributes](/glossary#account_attributes): \n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","success_response_body":{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","bank_id":"gh.29.uk","label":"My Account","number":"","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"type":"","balance":{"currency":"EUR","amount":"0"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_rules":[{"scheme":"OVERDRAFT","value":"10"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Account-Public","Account"],"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"type":{"type":"string"},"account_rules":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"value":{"type":"string"}}}},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/public/accounts/ACCOUNT_ID/VIEW_ID/account","connector_methods":[]},{"operation_id":"OBPv3.0.0-privateAccountsAtOneBank","implemented_by":{"version":"OBPv3.0.0","function":"privateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/private","summary":"Get Accounts at Bank (Minimal)","description":"Returns the minimal list of private accounts at BANK_ID that the user has access to.
\nFor each account, the API returns the ID, routing addresses and the views available to the current user.
If you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\naccount_type: AC
\n\n\nbank_id: gh.29.uk
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nscheme: OBP
\n\n\n","description_markdown":"Returns the minimal list of private accounts at BANK_ID that the user has access to.\nFor each account, the API returns the ID, routing addresses and the views available to the current user.\n\nIf you want to see more information on the Views, use the Account Detail call.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**account_type**](/glossary#): AC\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n","success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"String","bank_id":"gh.29.uk","account_type":"330","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"views":[{"id":"owner","short_name":"owner","description":"This view is for the owner for the account.","is_public":false}]}]},"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-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"account_type":{"type":"string"},"bank_id":{"type":"string"},"id":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"is_public":{"type":"boolean"},"short_name":{"type":"string"},"id":{"type":"string"}}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/private","connector_methods":[]},{"operation_id":"OBPv3.0.0-getOtherAccountsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getOtherAccountsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","summary":"Get Other Accounts of one Account","description":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.
\nUser Authentication is Optional. The User need not be logged in.
Authentication is required if the view VIEW_ID is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\n\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nprovider: ETHEREUM
\n\nscheme: OBP
\nuser:
\n","description_markdown":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.\nUser Authentication is Optional. The User need not be logged in.\n\nAuthentication is required if the view VIEW_ID is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_accounts**](/glossary#other_accounts): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**user**](/glossary#User): \n\n\n","success_response_body":{"other_accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}}]},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"typed_success_response_body":{"type":"object","properties":{"other_accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCardAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getCardAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/card","summary":"Get Card Attribute Definition","description":"Get Card Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Card Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Card","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Card"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"category":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetCardAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/card","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBalancingTransaction","implemented_by":{"version":"OBPv4.0.0","function":"getBalancingTransaction"},"request_verb":"GET","request_url":"/obp/v4.0.0/transactions/TRANSACTION_ID/balancing-transaction","summary":"Get Balancing Transaction","description":"Get Balancing Transaction
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","description_markdown":"Get Balancing Transaction\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**credit_transaction**](/glossary#): credit_transaction\n\n\n\n[**debit_transaction**](/glossary#): debit_transaction\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request**](/glossary#): transaction_request\n\n\n\n[**transaction_request_id**](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n","success_response_body":{"transaction_request":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"},"debit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"credit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/transactions/TRANSACTION_ID/balancing-transaction","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserInvitationAnonymous","implemented_by":{"version":"OBPv4.0.0","function":"getUserInvitationAnonymous"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/user-invitations","summary":"Get User Invitation Information","description":"Get User Invitation Information.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nsecret_key: secret_key
\nJSON response body fields:
\ncompany: Tesobe GmbH
\ncountry: Germany
\n\nfirst_name: Tom
\nlast_name: Smith
\npurpose: DEVELOPER
\n\n","description_markdown":"Get User Invitation Information.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**secret_key**](/glossary#): secret_key\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**first_name**](/glossary#first_name): Tom\n\n\n\n[**last_name**](/glossary#last_name): Smith\n\n\n\n[**purpose**](/glossary#purpose): DEVELOPER\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"secret_key":5819479115482092878},"success_response_body":{"first_name":"Tom","last_name":"Smith","email":"felixsmith@example.com","company":"Tesobe GmbH","country":"Germany","purpose":"DEVELOPER","status":""},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30008: User Customer Link not found by USER_ID","OBP-37882: Cannot get user invitation.","OBP-37883: Cannot find user invitation.","OBP-50000: Unknown Error."],"tags":["User-Invitation","KYC"],"typed_request_body":{"type":"object","properties":{"secret_key":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"email":{"type":"string"},"purpose":{"type":"string"},"first_name":{"type":"string"},"country":{"type":"string"},"status":{"type":"string"},"company":{"type":"string"},"last_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user-invitations","connector_methods":[]},{"operation_id":"OBPv1.2.1-getCounterpartyPublicAlias","implemented_by":{"version":"OBPv1.2.1","function":"getCounterpartyPublicAlias"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","summary":"Get public alias of other bank account","description":"Returns the public alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the public alias of the other account OTHER_ACCOUNT_ID.\nUser Authentication is Optional. The User need not be logged in.\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n","success_response_body":{"alias":"String"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","the view does not allow metadata access","the view does not allow public alias access","OBP-20001: User not logged in. Authentication is required!"],"tags":["Counterparty-Metadata","Counterparty"],"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":[]},{"operation_id":"OBPv5.1.0-createAtmAttribute","implemented_by":{"version":"OBPv5.1.0","function":"createAtmAttribute"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes","summary":"Create ATM Attribute","description":"Create ATM Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Create ATM Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"TAX_ID","type":"INTEGER","value":"12345678","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}},"roles":[{"role":"CanCreateAtmAttribute","requires_bank_id":true},{"role":"CanCreateAtmAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsentsAtBank","implemented_by":{"version":"OBPv5.1.0","function":"getConsentsAtBank"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/consents/banks/BANK_ID","summary":"Get Consents at Bank","description":"This endpoint gets the Consents at Bank by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n1 limit (for pagination: defaults to 50) eg:limit=200
\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n3 consumer_id (ignore if omitted)
\n4 user_id (ignore if omitted)
\n5 status (ignore if omitted)
\neg: /management/consents/banks/BANK_ID?&consumer_id=78&limit=10&offset=10
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nnote: note
\nnumber_of_rows: number_of_rows
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nfrequency_per_day: frequency_per_day
\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\nprovider: ETHEREUM
\n\nremaining_requests: remaining_requests
\n\n","description_markdown":"This endpoint gets the Consents at Bank by BANK_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n1 limit (for pagination: defaults to 50) eg:limit=200\n\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\n3 consumer_id (ignore if omitted)\n\n4 user_id (ignore if omitted)\n\n5 status (ignore if omitted)\n\neg: /management/consents/banks/BANK_ID?&consumer_id=78&limit=10&offset=10\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**aud**](/glossary#): String\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_reference_id**](/glossary#): 123456\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**createdByUserId**](/glossary#): createdByUserId\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**exp**](/glossary#): 60\n\n\n\n[**iat**](/glossary#): 60\n\n\n\n[**iss**](/glossary#): String\n\n\n\n[**jti**](/glossary#): String\n\n\n\n[**jwt_payload**](/glossary#): jwt_payload\n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nbf**](/glossary#): 60\n\n\n\n[**note**](/glossary#): note\n\n\n\n[**number_of_rows**](/glossary#): number_of_rows\n\n\n\n[**request_headers**](/glossary#): request_headers\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**sub**](/glossary#): felixsmith\n\n\n\n[**values**](/glossary#): values\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[access](/glossary#): access\n\n\n\n[accounts](/glossary#accounts): \n\n\n\n[allPsd2](/glossary#): allPsd2\n\n\n\n[availableAccounts](/glossary#): availableAccounts\n\n\n\n[balances](/glossary#): balances\n\n\n\n[bban](/glossary#): bban\n\n\n\n[currency](/glossary#): EUR\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[frequency_per_day](/glossary#): frequency_per_day\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n\n[iban](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[maskedPan](/glossary#): maskedPan\n\n\n\n[msisdn](/glossary#): msisdn\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[pan](/glossary#): pan\n\n\n\n[provider](/glossary#provider): ETHEREUM\n\n\n\n[provider_id](/glossary#provider_id): \n\n\n\n[remaining_requests](/glossary#): remaining_requests\n\n\n\n[transactions](/glossary#transactions): \n\n\n","success_response_body":{"number_of_rows":1,"consents":[{"consent_reference_id":"123456","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","provider":"http://127.0.0.1:8080","provider_id":"","status":"INITIATED","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","jwt_payload":{"createdByUserId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","sub":"felixsmith","iss":"String","aud":"String","jti":"String","iat":60,"nbf":60,"exp":60,"request_headers":[{"name":"tags","values":["static"]}],"name":"ACCOUNT_MANAGEMENT_FEE","email":"felixsmith@example.com","entitlements":[{"role_name":"","bank_id":"gh.29.uk"}],"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}],"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"balances":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"transactions":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"availableAccounts":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"api_standard":"Berlin Group","api_version":"v1.3","note":"Tue, 15 Jul 2025 19:16:22\n|---> Changed status from received to rejected for consent ID: 398"}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"number_of_rows":{"type":"integer"},"consents":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"note":{"type":"string"},"provider_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}},"roles":[{"role":"CanGetConsentsAtOneBank","requires_bank_id":true},{"role":"CanGetConsentsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consents/banks/BANK_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCurrentUserId","implemented_by":{"version":"OBPv4.0.0","function":"getCurrentUserId"},"request_verb":"GET","request_url":"/obp/v4.0.0/users/current/user_id","summary":"Get User Id (Current)","description":"Get the USER_ID of the logged in user
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get the USER_ID of the logged in user\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/current/user_id","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"updateDynamicResourceDoc"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Update Dynamic Resource Doc","description":"Update a Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Update a Dynamic Resource Doc.\n\nThe connector_method_body is URL-encoded format String\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanUpdateDynamicResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"getDynamicMessageDoc"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Get Dynamic Message Doc","description":"Get a Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Get a Dynamic Message Doc by DYNAMIC_MESSAGE_DOC_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","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":["Dynamic-Message-Doc"],"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanGetDynamicMessageDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-createConsentEmail","implemented_by":{"version":"OBPv3.1.0","function":"createConsentEmail"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/EMAIL","summary":"Create Consent (EMAIL)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"phone_number": "+49 170 1234567"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"phone_number": "+49 170 1234567"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"phone_number": "+49 170 1234567"
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\",\"EMAIL\" or \"IMPLICIT\". \"EMAIL\" is used for testing purposes. OBP mapped mode \"IMPLICIT\" is \"EMAIL\".\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nExample 1: \n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"phone_number\": \"+49 170 1234567\"\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"phone_number\": \"+49 170 1234567\"\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"phone_number\": \"+49 170 1234567\"\n}\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[EMAIL](/glossary#): felixsmith@example.com\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**everything**](/glossary#everything): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","email":"felixsmith@example.com","valid_from":"2026-03-16T21:00:23Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"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-10001: Incorrect json format.","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/consents/EMAIL","connector_methods":[]},{"operation_id":"OBPv3.0.0-getTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","summary":"Get Transactions for Account (Full)","description":"Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Returns transactions list of the account specified by ACCOUNT_ID and [moderated](#1_2_1-getViewsForBankAccount) by the view (VIEW_ID).\n\nUser Authentication is Optional. The User need not be logged in.\n\nAuthentication is required if the view is not public.\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:23.773Z. NOTE! The default value is now (2026-03-16T21:00:23.773Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"transactions":[{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"details":{"type":"AC","description":"this is for family","posted":"1099-12-31T21:00:00Z","completed":"1099-12-31T21:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!","OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!","OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!","OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction","Account"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"where":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"images":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"id":{"type":"string"},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"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.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Update dynamic endpoint Host.\nThe value can be obp_mock, dynamic_entity, or some service url.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-addScope","implemented_by":{"version":"OBPv4.0.0","function":"addScope"},"request_verb":"POST","request_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","summary":"Create Scope for a Consumer","description":"Create Scope. Grant Role to Consumer.
\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","description_markdown":"Create Scope. Grant Role to Consumer.\n\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**scope_id**](/glossary#scope_id): \n\n\n","example_request_body":{"bank_id":"gh.29.uk","role_name":"CanGetEntitlementsForAnyUserAtOneBank"},"success_response_body":{"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f","role_name":"CanGetEntitlementsForAnyUserAtOneBank","bank_id":"gh.29.uk"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20024: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-10001: Incorrect json format.","OBP-10007: Incorrect Role name:","OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.","OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.","OBP-30216: Entitlement already exists for the user.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Scope","Consumer"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"roles":[{"role":"CanCreateScopeAtAnyBank","requires_bank_id":false},{"role":"CanCreateScopeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumers/CONSUMER_ID/scopes","connector_methods":[]},{"operation_id":"OBPv1.2.1-addOtherAccountPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"addOtherAccountPrivateAlias"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Create Other Account Private Alias","description":"Creates a private alias for the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Creates a private alias for the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"alias":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow adding a private alias","Alias cannot be added","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv5.0.0-getConsentByConsentRequestId","implemented_by":{"version":"OBPv5.0.0","function":"getConsentByConsentRequestId"},"request_verb":"GET","request_url":"/obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/consents","summary":"Get Consent By Consent Request Id via Consumer","description":"This endpoint gets the Consent By consent request id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","description_markdown":"This endpoint gets the Consent By consent request id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_REQUEST_ID](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[account_access](/glossary#): account_access\n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_access":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllEndpointMappings","implemented_by":{"version":"OBPv4.0.0","function":"getAllEndpointMappings"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/endpoint-mappings","summary":"Get all Endpoint Mappings","description":"Get all Endpoint Mappings.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Get all Endpoint Mappings.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","success_response_body":{"endpoint-mappings":[{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}]},"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":["Endpoint-Mapping"],"typed_success_response_body":{"type":"object","properties":{"endpoint-mappings":{"type":"array","items":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllEndpointMappings","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoint-mappings","connector_methods":[]},{"operation_id":"OBPv4.0.0-getConsentInfos","implemented_by":{"version":"OBPv4.0.0","function":"getConsentInfos"},"request_verb":"GET","request_url":"/obp/v4.0.0/my/consent-infos","summary":"Get My Consents Info","description":"This endpoint gets the Consents that the current User created.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napi_standard: api_standard
\n\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\n\n","description_markdown":"This endpoint gets the Consents that the current User created.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"consents":[{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","status":"INITIATED","api_standard":"Berlin Group","api_version":"v1.3"}]},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consent-infos","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCardsForBank","implemented_by":{"version":"OBPv3.1.0","function":"getCardsForBank"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards","summary":"Get Cards for the specified bank","description":"Should be able to filter on the following fields
\neg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
\n1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
\n2 account_id should be valid account_id , otherwise, it will return an empty card list.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\n\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Should be able to filter on the following fields\n\neg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0\n\n1 customer_id should be valid customer_id, otherwise, it will return an empty card list. \n\n2 account_id should be valid account_id , otherwise, it will return an empty card list. \n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**cancelled**](/glossary#cancelled): false\n\n\n\n[**card_id**](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**cards**](/glossary#cards): \n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"cards":[{"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","bank_id":"gh.29.uk","card_number":"364435172576215","card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"technologyString1","networks":["networks1"],"allows":["credit","debit"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}]},"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-50000: Unknown Error."],"tags":["Card"],"typed_success_response_body":{"type":"object","properties":{"cards":{"type":"array","items":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"technology":{"type":"string"},"customer_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"card_id":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"serial_number":{"type":"string"},"collected":{"type":"string","format":"date-time"},"cancelled":{"type":"boolean"},"networks":{"type":"array","items":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankLevelDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelDynamicMessageDoc"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Delete Bank Level Dynamic Message Doc","description":"Delete a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\n","description_markdown":"Delete a Bank Level Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":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-Message-Doc"],"roles":[{"role":"CanDeleteBankLevelDynamicMessageDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv5.1.0-getAccountAccessByUserId","implemented_by":{"version":"OBPv5.1.0","function":"getAccountAccessByUserId"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/USER_ID/account-access","summary":"Get Account Access by USER_ID","description":"Get Account Access by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nbank_id: gh.29.uk
\nview_id: owner
\n","description_markdown":"Get Account Access by USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","success_response_body":{"accounts":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"roles":[{"role":"CanSeeAccountAccessForAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/account-access","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAllBankAccountBalances","implemented_by":{"version":"OBPv5.1.0","function":"getAllBankAccountBalances"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances","summary":"Get All Bank Account Balances","description":"Get all Balances for a Bank Account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbalances: balances
\nbank_id: gh.29.uk
\n","description_markdown":"Get all Balances for a Bank Account.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**balance_amount**](/glossary#): 50.89\n\n\n\n[**balance_id**](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**balance_type**](/glossary#balance_type): openingBooked\n\n\n\n[**balances**](/glossary#): balances\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n","success_response_body":{"balances":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","balance_type":"openingBooked","balance_amount":"50.89"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Balance"],"typed_success_response_body":{"type":"object","properties":{"balances":{"type":"array","items":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances","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.
\nUser Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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":"OBPv3.1.0-updateCustomerIdentity","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerIdentity"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/identity","summary":"Update the identity data of a Customer","description":"Update the identity data of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the identity data of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"legal_name":"Eveline Tripman","date_of_birth":"1099-12-31T21:00:00Z","title":"Dr.","name_suffix":"Sr"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"date_of_birth":{"type":"string","format":"date-time"},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"title":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerIdentity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/identity","connector_methods":[]},{"operation_id":"OBPv3.0.0-createBranch","implemented_by":{"version":"OBPv3.0.0","function":"createBranch"},"request_verb":"POST","request_url":"/obp/v3.0.0/banks/BANK_ID/branches","summary":"Create Branch","description":"Create Branch for the Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","description_markdown":"Create Branch for the Bank.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n","example_request_body":{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"},"success_response_body":{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"},"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-30209: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Branch"],"typed_request_body":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}},"typed_success_response_body":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}},"roles":[{"role":"CanCreateBranch","requires_bank_id":true},{"role":"CanCreateBranchAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches","connector_methods":[]},{"operation_id":"OBPv5.1.0-createAgent","implemented_by":{"version":"OBPv5.1.0","function":"createAgent"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/agents","summary":"Create Agent","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nagent_number: 5987953
\ncurrency: EUR
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**agent_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**is_confirmed_agent**](/glossary#): is_confirmed_agent\n\n\n\n[**is_pending_agent**](/glossary#): is_pending_agent\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n","example_request_body":{"legal_name":"Eveline Tripman","mobile_phone_number":"+49 30 901820","agent_number":"5987953","currency":"EUR"},"success_response_body":{"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","legal_name":"Eveline Tripman","mobile_phone_number":"+49 30 901820","agent_number":"5987953","currency":"EUR","is_confirmed_agent":false,"is_pending_agent":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-10001: Incorrect json format.","OBP-30328: Agent Number already exists. Please specify a different value for BANK_ID or AGENT_NUMBER.","OBP-30202: Could not create Agent.","OBP-50000: Unknown Error."],"tags":["Customer","Person"],"typed_request_body":{"type":"object","properties":{"currency":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents","connector_methods":[]},{"operation_id":"OBPv3.0.0-getOtherAccountByIdForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getOtherAccountByIdForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","summary":"Get Other Account by Id","description":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
\nUser Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\n\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nprovider: ETHEREUM
\n\nscheme: OBP
\nuser:
\n","description_markdown":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.\nUser Authentication is Optional. The User need not be logged in.\n\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**user**](/glossary#User): \n\n\n","success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestSimple","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestSimple"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SIMPLE/transaction-requests","summary":"Create Transaction Request (SIMPLE)","description":"Special instructions for SIMPLE:
\nYou can transfer money to the Bank Account Number or IBAN directly.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSIMPLE: SIMPLE
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nto:
\nvalue: 5987953
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for SIMPLE:\n\nYou can transfer money to the Bank Account Number or IBAN directly.\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SIMPLE](/glossary#): SIMPLE\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"name":"John Smith Ltd.","description":"The piano lession-Invoice No:68","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e"},"value":{"currency":"EUR","amount":"0"},"description":"Description of the object. Maximum length is 2000. It can be any characters here.","charge_policy":"SHARED","future_date":"20200127"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"description":{"type":"string"},"to":{"type":"object","properties":{"other_account_routing_address":{"type":"string"},"description":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"name":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"other_branch_routing_address":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SIMPLE/transaction-requests","connector_methods":[]},{"operation_id":"OBPv5.1.0-addSystemViewPermission","implemented_by":{"version":"OBPv5.1.0","function":"addSystemViewPermission"},"request_verb":"POST","request_url":"/obp/v5.1.0/system-views/VIEW_ID/permissions","summary":"Add Permission to a System View","description":"Add Permission to a System View.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON request body fields:
\npermission_name: permission_name
\nextra_data: extra_data
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","description_markdown":"Add Permission to a System View.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**permission_name**](/glossary#): permission_name\n\n\n\n[extra_data](/glossary#): extra_data\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"permission_name":"can_grant_access_to_views","extra_data":["accountant","auditor"]},"success_response_body":{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-10007: Incorrect Role name:","OBP-30216: Entitlement already exists for the user.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"typed_request_body":{"type":"object","properties":{"extra_data":{"type":"array","items":{"type":"string"}},"permission_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}},"roles":[{"role":"CanCreateSystemViewPermission","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views/VIEW_ID/permissions","connector_methods":[]},{"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
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nNote: Resource Docs are cached, TTL is 3600 seconds\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv4.0.0-getAllJsonSchemaValidationsPublic","implemented_by":{"version":"OBPv4.0.0","function":"getAllJsonSchemaValidationsPublic"},"request_verb":"GET","request_url":"/obp/v4.0.0/endpoints/json-schema-validations","summary":"Get all JSON Schema Validations - public","description":"Get all JSON Schema Validations - public.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. 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\nUser Authentication is Optional. The User need not be logged in.\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): Description of the object. 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-createTransactionRequestSepa","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestSepa"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","summary":"Create Transaction Request (SEPA)","description":"Special instructions for SEPA:
\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
For an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nSEPA:
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncharge_policy: SHARED
\ncode: 125
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\niban: DE91 1000 0000 0123 4567 89
\nto:
\nvalue: 5987953
\namount: 10.12
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nfuture_date: 20200127
\n\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Special instructions for SEPA:\n\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SEPA](/glossary#sepa): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[document_number](/glossary#document_number): \n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n[reasons](/glossary#reasons): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"value":{"currency":"EUR","amount":"0"},"to":{"iban":"123"},"description":"This is a SEPA Transaction Request","charge_policy":"SHARED","future_date":"20200127","reasons":[{"code":"410","document_number":"2020/154","amount":"100","currency":"EUR","description":"SEPA payment"}]},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"future_date":{"type":"string"},"reasons":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"code":{"type":"string"},"amount":{"type":"string"},"document_number":{"type":"string"},"currency":{"type":"string"}}}},"to":{"type":"object","properties":{"iban":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SEPA/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTransactionRequest","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequest"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests/TRANSACTION_REQUEST_ID","summary":"Get Transaction Request","description":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction request for transaction specified by TRANSACTION_REQUEST_ID and for account specified by ACCOUNT_ID at bank specified by BANK_ID.\n\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.\n\nVersion 2.0.0 now returns charge information.\n\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:\n\n* Transaction Request Id\n* Type\n* Status (INITIATED, COMPLETED)\n* Challenge (in order to confirm the request)\n* From Bank / Account\n* Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)\n* Related Transactions\n\nPSD2 Context: PSD2 requires transparency of charges to the customer.\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.\nThe customer can proceed with the Transaction by answering the security challenge.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-60010: Get Transaction Requests Exception. ","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests/TRANSACTION_REQUEST_ID","connector_methods":[]},{"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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv1.2.1-updateWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"updateWhereTagForViewOnTransaction"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Update a Transaction where Tag","description":"Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Updates the \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission:","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv5.1.0-orphanedAccountCheck","implemented_by":{"version":"OBPv5.1.0","function":"orphanedAccountCheck"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/system/integrity/banks/BANK_ID/orphaned-account-check","summary":"Check for Orphaned Accounts","description":"Check for orphaned accounts at Bank Account model
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\ndebug_info: debug_info
\n","description_markdown":"Check for orphaned accounts at Bank Account model\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**success**](/glossary#success): \n\n\n\n[debug_info](/glossary#): debug_info\n\n\n","success_response_body":{"success":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":["System-Integrity"],"typed_success_response_body":{"type":"object","properties":{"success":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemIntegrity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/system/integrity/banks/BANK_ID/orphaned-account-check","connector_methods":[]},{"operation_id":"OBPv5.1.0-grantUserAccessToViewById","implemented_by":{"version":"OBPv5.1.0","function":"grantUserAccessToViewById"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/grant","summary":"Grant User access to View","description":"Grants the User identified by USER_ID access to the view on a bank account identified by VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nPermission Requirements:
\nThe requesting user must have access to the source VIEW_ID and must possess specific grant permissions:
For System Views (e.g., owner, accountant, auditor, public etc.):
\n- The user's current view must have the target view listed in its canGrantAccessToViews field
\n- Example: If granting access to "accountant" view, the user's view must include "accountant" in canGrantAccessToViews
For Custom Views (account-specific views):
\n- The user's current view must have the can_grant_access_to_custom_views permission in its allowed_actions field
\n- This permission allows granting access to any custom view on the account
Security Checks Performed:
\n1. User authentication validation
\n2. JSON format validation (USER_ID and VIEW_ID required)
\n3. Permission authorization via APIUtil.canGrantAccessToView()
\n4. Target user existence verification
\n5. Target view existence and type validation (system vs custom)
\n6. Final access grant operation in database
Final Database Operation:
\nThe system creates an AccountAccess record linking the user to the view if one doesn't already exist.
\nThis operation includes:
\n- Duplicate check: Prevents creating duplicate access records (idempotent operation)
\n- Public view restriction: Blocks access to public views if disabled instance-wide
\n- Database constraint validation: Ensures referential integrity
Note: The permission model ensures users can only delegate access rights they themselves possess or are explicitly authorized to grant.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nview_id: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Grants the User identified by USER_ID access to the view on a bank account identified by VIEW_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n**Permission Requirements:**\nThe requesting user must have access to the source VIEW_ID and must possess specific grant permissions:\n\n**For System Views (e.g., owner, accountant, auditor, public etc.):**\n- The user's current view must have the target view listed in its `canGrantAccessToViews` field\n- Example: If granting access to \"accountant\" view, the user's view must include \"accountant\" in `canGrantAccessToViews`\n\n**For Custom Views (account-specific views):**\n- The user's current view must have the `can_grant_access_to_custom_views` permission in its `allowed_actions` field\n- This permission allows granting access to any custom view on the account\n\n**Security Checks Performed:**\n1. User authentication validation\n2. JSON format validation (USER_ID and VIEW_ID required)\n3. Permission authorization via `APIUtil.canGrantAccessToView()`\n4. Target user existence verification\n5. Target view existence and type validation (system vs custom)\n6. Final access grant operation in database\n\n**Final Database Operation:**\nThe system creates an `AccountAccess` record linking the user to the view if one doesn't already exist.\nThis operation includes:\n- Duplicate check: Prevents creating duplicate access records (idempotent operation)\n- Public view restriction: Blocks access to public views if disabled instance-wide\n- Database constraint validation: Ensures referential integrity\n\n**Note:** The permission model ensures users can only delegate access rights they themselves possess or are explicitly authorized to grant.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","view_id":"owner"},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-20084: The current source view.can_grant_access_to_views does not contains target view.","OBP-20085: The current source view.can_grant_access_to_custom_views is false.","OBP-10001: Incorrect json format.","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-30252: System view not found. Please specify a valid value for VIEW_ID","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30063: Cannot grant account access.","OBP-50000: Unknown Error."],"tags":["Account-Access","View-Custom","Account","User","OwnerViewRequired"],"typed_request_body":{"type":"object","properties":{"view_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/account-access/grant","connector_methods":[]},{"operation_id":"OBPv4.0.0-createStandingOrder","implemented_by":{"version":"OBPv4.0.0","function":"createStandingOrder"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/standing-order","summary":"Create Standing Order","description":"Create standing order for an account.
\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\n","description_markdown":"Create standing order for an account.\n\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n\n[date_expires](/glossary#): 2021-01-27\n\n\n\n[date_signed](/glossary#): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**active**](/glossary#active): false\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_cancelled**](/glossary#): 2020-01-27\n\n\n\n[**date_expires**](/glossary#): 2021-01-27\n\n\n\n[**date_signed**](/glossary#): 2020-01-27\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**standing_order_id**](/glossary#standing_order_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","example_request_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","amount":{"currency":"EUR","amount":"0"},"when":{"frequency":"YEARLY","detail":"LAST_DAY"},"date_signed":"1099-12-31T21:00:00Z","date_starts":"1099-12-31T21:00:00Z","date_expires":"1099-12-31T21:00:00Z"},"success_response_body":{"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","amount":{"currency":"EUR","amount":"0"},"when":{"frequency":"WEEKLY","detail":"FIRST_DAY"},"date_signed":"2026-03-16T21:00:25Z","date_starts":"2026-03-16T21:00:25Z","date_expires":"2026-03-16T21:00:25Z","date_cancelled":"2026-03-16T21:00:25Z","active":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20057: User not found by userId.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Standing-Order","Account"],"typed_request_body":{"type":"object","properties":{"date_signed":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"date_starts":{"type":"string","format":"date-time"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"bank_id":{"type":"string"},"standing_order_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"date_starts":{"type":"string","format":"date-time"},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"date_signed":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/standing-order","connector_methods":[]},{"operation_id":"OBPv5.0.0-createUserAuthContext","implemented_by":{"version":"OBPv5.0.0","function":"createUserAuthContext"},"request_verb":"POST","request_url":"/obp/v5.0.0/users/USER_ID/auth-context","summary":"Create User Auth Context","description":"Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
\nBank User/Customer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\ntime_stamp: 1100-01-01T01:01:01.000Z
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","description_markdown":"Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and \n Bank User/Customer. \nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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 request body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**time_stamp**](/glossary#): 1100-01-01T01:01:01.000Z\n\n\n\n[**user_auth_context_id**](/glossary#user_auth_context_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"key":"CUSTOMER_NUMBER","value":"78987432"},"success_response_body":{"user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","time_stamp":"1099-12-31T21:00:00Z","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30053: Could not insert the UserAuthContext","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User"],"typed_request_body":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"consumer_id":{"type":"string"},"time_stamp":{"type":"string","format":"date-time"},"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/auth-context","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAccountsHeldByUserAtBank","implemented_by":{"version":"OBPv5.1.0","function":"getAccountsHeldByUserAtBank"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/USER_ID/banks/BANK_ID/accounts-held","summary":"Get Accounts Held By User","description":"Get Accounts held by the User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/users/USER_ID/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n\n\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nscheme: OBP
\n","description_markdown":"Get Accounts held by the User if even the User has not been assigned the owner View yet.\n\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/users/USER_ID/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\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[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n","success_response_body":{"accounts":[{"id":"7b97bd26-583b-4c3b-8282-55ea9d934aad","label":"My Account","bank_id":"123","number":"123","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}]}]},"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-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"number":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAccountsHeldAtOneBank","requires_bank_id":true},{"role":"CanGetAccountsHeldAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/banks/BANK_ID/accounts-held","connector_methods":[]},{"operation_id":"OBPv5.1.0-logCacheEndpoint","implemented_by":{"version":"OBPv5.1.0","function":"logCacheEndpoint"},"request_verb":"GET","request_url":"/obp/v5.1.0/dev-ops/log-cache/LOG_LEVEL","summary":"Get Log Cache","description":"Returns information about:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Returns information about:\n\n* Log Cache\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[LOG_LEVEL](/glossary#log_level): \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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["API"],"roles":[{"role":"CanGetAllLevelLogsAtAllBanks","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/dev-ops/log-cache/LOG_LEVEL","connector_methods":[]},{"operation_id":"OBPv5.1.0-validateUserByUserId","implemented_by":{"version":"OBPv5.1.0","function":"validateUserByUserId"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/users/USER_ID","summary":"Validate a user","description":"Validate the User by USER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nlast_lock_date: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Validate the User by USER_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**last_lock_date**](/glossary#last_lock_date): 2020-01-27\n\n\n\n[**type_of_lock**](/glossary#type_of_lock): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","type_of_lock":"lock_via_api","last_lock_date":"1099-12-31T22:01:01Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"type_of_lock":{"type":"string"},"last_lock_date":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}},"roles":[{"role":"CanValidateUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/users/USER_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-deleteEntitlementRequest","implemented_by":{"version":"OBPv3.0.0","function":"deleteEntitlementRequest"},"request_verb":"DELETE","request_url":"/obp/v3.0.0/entitlement-requests/ENTITLEMENT_REQUEST_ID","summary":"Delete Entitlement Request","description":"Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ENTITLEMENT_REQUEST_ID](/glossary#entitlement_request_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-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User"],"roles":[{"role":"CanDeleteEntitlementRequestsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/entitlement-requests/ENTITLEMENT_REQUEST_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateAccountAttribute","implemented_by":{"version":"OBPv3.1.0","function":"updateAccountAttribute"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attributes/ACCOUNT_ATTRIBUTE_ID","summary":"Update Account Attribute","description":"Update Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Update Account Attribute\n\n\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Account Attribute is linked to its Account by ACCOUNT_ID\n\n\n \n\nTypical account attributes might be:\n\nISIN (for International bonds)\nVKN (for German bonds)\nREDCODE (markit short code for credit derivative)\nLOAN_ID (e.g. used for Anacredit reporting)\n\nISSUE_DATE (When the bond was issued in the market)\nMATURITY_DATE (End of life time of a product)\nTRADABLE\n\nSee [FPML](http://www.fpml.org/) for more examples.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ATTRIBUTE_ID](/glossary#account_attribute_id): \n\n\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"},"success_response_body":{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"roles":[{"role":"CanUpdateAccountAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attributes/ACCOUNT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsents","implemented_by":{"version":"OBPv5.1.0","function":"getConsents"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/consents","summary":"Get Consents","description":"This endpoint gets the Consents.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n1 limit (for pagination: defaults to 50) eg:limit=200
\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n3 consumer_id (ignore if omitted)
\n4 consent_id (ignore if omitted)
\n5 user_id (ignore if omitted)
\n6 status (ignore if omitted)
\n7 bank_id (ignore if omitted)
\n8 provider_provider_id (ignore if omitted)
\nprovider and provider_id values are separated by pipe char
\neg: provider_provider_id=http%3A%2F%2Flocalhost%3A7070%2Frealms%2Fmaster|7837ee9c-3446-4d8c-9b90-301a52b4851d
eg:/management/consents?consumer_id=78&limit=10&offset=10
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nnote: note
\nnumber_of_rows: number_of_rows
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nfrequency_per_day: frequency_per_day
\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\nprovider: ETHEREUM
\n\nremaining_requests: remaining_requests
\n\n","description_markdown":"This endpoint gets the Consents.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n1 limit (for pagination: defaults to 50) eg:limit=200\n\n2 offset (for pagination: zero index, defaults to 0) eg: offset=10\n\n3 consumer_id (ignore if omitted)\n\n4 consent_id (ignore if omitted)\n\n5 user_id (ignore if omitted)\n\n6 status (ignore if omitted)\n\n7 bank_id (ignore if omitted)\n\n8 provider_provider_id (ignore if omitted)\nprovider and provider_id values are separated by pipe char\neg: provider_provider_id=http%3A%2F%2Flocalhost%3A7070%2Frealms%2Fmaster|7837ee9c-3446-4d8c-9b90-301a52b4851d\n\neg:/management/consents?consumer_id=78&limit=10&offset=10\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**aud**](/glossary#): String\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_reference_id**](/glossary#): 123456\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**createdByUserId**](/glossary#): createdByUserId\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**exp**](/glossary#): 60\n\n\n\n[**iat**](/glossary#): 60\n\n\n\n[**iss**](/glossary#): String\n\n\n\n[**jti**](/glossary#): String\n\n\n\n[**jwt_payload**](/glossary#): jwt_payload\n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nbf**](/glossary#): 60\n\n\n\n[**note**](/glossary#): note\n\n\n\n[**number_of_rows**](/glossary#): number_of_rows\n\n\n\n[**request_headers**](/glossary#): request_headers\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**sub**](/glossary#): felixsmith\n\n\n\n[**values**](/glossary#): values\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[access](/glossary#): access\n\n\n\n[accounts](/glossary#accounts): \n\n\n\n[allPsd2](/glossary#): allPsd2\n\n\n\n[availableAccounts](/glossary#): availableAccounts\n\n\n\n[balances](/glossary#): balances\n\n\n\n[bban](/glossary#): bban\n\n\n\n[currency](/glossary#): EUR\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[frequency_per_day](/glossary#): frequency_per_day\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n\n[iban](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[maskedPan](/glossary#): maskedPan\n\n\n\n[msisdn](/glossary#): msisdn\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[pan](/glossary#): pan\n\n\n\n[provider](/glossary#provider): ETHEREUM\n\n\n\n[provider_id](/glossary#provider_id): \n\n\n\n[remaining_requests](/glossary#): remaining_requests\n\n\n\n[transactions](/glossary#transactions): \n\n\n","success_response_body":{"number_of_rows":1,"consents":[{"consent_reference_id":"123456","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","provider":"http://127.0.0.1:8080","provider_id":"","status":"INITIATED","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","jwt_payload":{"createdByUserId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","sub":"felixsmith","iss":"String","aud":"String","jti":"String","iat":60,"nbf":60,"exp":60,"request_headers":[{"name":"tags","values":["static"]}],"name":"ACCOUNT_MANAGEMENT_FEE","email":"felixsmith@example.com","entitlements":[{"role_name":"","bank_id":"gh.29.uk"}],"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}],"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"balances":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"transactions":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"availableAccounts":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"api_standard":"Berlin Group","api_version":"v1.3","note":"Tue, 15 Jul 2025 19:16:22\n|---> Changed status from received to rejected for consent ID: 398"}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"number_of_rows":{"type":"integer"},"consents":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"note":{"type":"string"},"provider_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}},"roles":[{"role":"CanGetConsentsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAtmSupportedCurrencies","implemented_by":{"version":"OBPv4.0.0","function":"updateAtmSupportedCurrencies"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/atms/ATM_ID/supported-currencies","summary":"Update ATM Supported Currencies","description":"Update ATM Supported Currencies.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nsupported_currencies: ["EUR","MXN","USD"]
\n","description_markdown":"Update ATM Supported Currencies.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n","example_request_body":{"supported_currencies":["EUR","MXN","USD"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","supported_currencies":["EUR","MXN","USD"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"supported_currencies":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"supported_currencies":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/supported-currencies","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountMetadata","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountMetadata"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata","summary":"Get Other Account Metadata","description":"Get metadata of one other account.
\nReturns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.
Authentication via OAuth is required if the view is not public.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlatitude: 38.8951
\nlongitude: -77.0364
\nmore_info: More information about this fee
\n\n\n\nprovider: ETHEREUM
\n\nuser:
\n","description_markdown":"Get metadata of one other account.\nReturns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**user**](/glossary#User): \n\n\n","success_response_body":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","the view does not allow metadata access"],"tags":["Counterparty-Metadata","Counterparty"],"typed_success_response_body":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata","connector_methods":[]},{"operation_id":"OBPv5.1.0-unlockUserByProviderAndUsername","implemented_by":{"version":"OBPv5.1.0","function":"unlockUserByProviderAndUsername"},"request_verb":"PUT","request_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/lock-status","summary":"Unlock the user","description":"Unlock a User.
\n(Perhaps the user was locked due to multiple failed login attempts)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\nbad_attempts_since_last_success_or_reset:
\nlast_failure_date: 2020-01-27
\nusername: felixsmith
\n","description_markdown":"Unlock a User.\n\n(Perhaps the user was locked due to multiple failed login attempts)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[USERNAME](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bad_attempts_since_last_success_or_reset**](/glossary#bad_attempts_since_last_success_or_reset): \n\n\n\n[**last_failure_date**](/glossary#last_failure_date): 2020-01-27\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"username":"felixsmith","bad_attempts_since_last_success_or_reset":0,"last_failure_date":"1099-12-31T22:01:01Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20027: User not found by provider and username.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"bad_attempts_since_last_success_or_reset":{"type":"integer"},"last_failure_date":{"type":"string","format":"date-time"},"username":{"type":"string"}}},"roles":[{"role":"CanUnlockUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/lock-status","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCorrelatedUsersInfoByCustomerId","implemented_by":{"version":"OBPv4.0.0","function":"getCorrelatedUsersInfoByCustomerId"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/correlated-users","summary":"Get Correlated User Info by Customer","description":"Get Correlated User Info by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\ninsert_date: 2020-01-27
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_attributes: user_attributes
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nusers: user list
\nvalue: 5987953
\n\n\n","description_markdown":"Get Correlated User Info by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_attributes**](/glossary#): user_attributes\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"users":[{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","user_attributes":[{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"}]}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}}},"user_id":{"type":"string"}}}},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}}}},"roles":[{"role":"CanGetCorrelatedUsersInfoAtAnyBank","requires_bank_id":false},{"role":"CanGetCorrelatedUsersInfo","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/correlated-users","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateTransactionAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateTransactionAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ACCOUNT_ATTRIBUTE_ID","summary":"Update Transaction Attribute","description":"Update Transaction Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Transaction Attribute\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ATTRIBUTE_ID](/glossary#account_attribute_id): \n\n\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanUpdateTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ACCOUNT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-deleteCustomerAccountLinkById","implemented_by":{"version":"OBPv5.0.0","function":"deleteCustomerAccountLinkById"},"request_verb":"DELETE","request_url":"/obp/v5.0.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","summary":"Delete Customer Account Link","description":"Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ACCOUNT_LINK_ID](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\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-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":["Customer"],"roles":[{"role":"CanDeleteCustomerAccountLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getMyConsentsByBank","implemented_by":{"version":"OBPv5.1.0","function":"getMyConsentsByBank"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/my/consents","summary":"Get My Consents at Bank","description":"This endpoint gets the Consents created by a current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\napi_standard: api_standard
\n\naud: String
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsent_reference_id: 123456
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_ids: counterparty_ids
\ncreatedByUserId: createdByUserId
\n\n\nexp: 60
\niat: 60
\niss: String
\njti: String
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\njwt_payload: jwt_payload
\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\nname: ACCOUNT_MANAGEMENT_FEE
\nnbf: 60
\nrequest_headers: request_headers
\n\n\nsub: felixsmith
\nvalues: values
\nview_id: owner
\n\naccess: access
\n\nallPsd2: allPsd2
\navailableAccounts: availableAccounts
\nbalances: balances
\nbban: bban
\ncurrency: EUR
\n\nhelper_info: helper_info
\niban: DE91 1000 0000 0123 4567 89
\nmaskedPan: maskedPan
\nmsisdn: msisdn
\nname: ACCOUNT_MANAGEMENT_FEE
\npan: pan
\n\n","description_markdown":"This endpoint gets the Consents created by a current User.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**aud**](/glossary#): String\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**consent_reference_id**](/glossary#): 123456\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**createdByUserId**](/glossary#): createdByUserId\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**exp**](/glossary#): 60\n\n\n\n[**iat**](/glossary#): 60\n\n\n\n[**iss**](/glossary#): String\n\n\n\n[**jti**](/glossary#): String\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**jwt_payload**](/glossary#): jwt_payload\n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nbf**](/glossary#): 60\n\n\n\n[**request_headers**](/glossary#): request_headers\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**sub**](/glossary#): felixsmith\n\n\n\n[**values**](/glossary#): values\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[access](/glossary#): access\n\n\n\n[accounts](/glossary#accounts): \n\n\n\n[allPsd2](/glossary#): allPsd2\n\n\n\n[availableAccounts](/glossary#): availableAccounts\n\n\n\n[balances](/glossary#): balances\n\n\n\n[bban](/glossary#): bban\n\n\n\n[currency](/glossary#): EUR\n\n\n\n[email](/glossary#): felixsmith@example.com\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n\n[iban](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[maskedPan](/glossary#): maskedPan\n\n\n\n[msisdn](/glossary#): msisdn\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[pan](/glossary#): pan\n\n\n\n[transactions](/glossary#transactions): \n\n\n","success_response_body":{"consents":[{"consent_reference_id":"123456","consent_id":"9d429899-24f5-42c8-8565-943ffa6a7947","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","status":"","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","jwt_payload":{"createdByUserId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","sub":"felixsmith","iss":"String","aud":"String","jti":"String","iat":60,"nbf":60,"exp":60,"request_headers":[{"name":"tags","values":["static"]}],"name":"ACCOUNT_MANAGEMENT_FEE","email":"felixsmith@example.com","entitlements":[{"role_name":"","bank_id":"gh.29.uk"}],"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}],"access":{"accounts":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"balances":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"transactions":[{"iban":"DE91 1000 0000 0123 4567 89","bban":"BARC12345612345678","pan":"5409050000000000","maskedPan":"123456xxxxxx1234","msisdn":"+49 170 1234567","currency":"EUR"}],"availableAccounts":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"api_standard":"Berlin Group","api_version":"v1.3"}]},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"last_action_date":{"type":"string","format":"date-time"},"consent_reference_id":{"type":"string"},"jwt_payload":{"type":"object","properties":{"aud":{"type":"string"},"views":{"type":"array","items":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"nbf":{"type":"integer"},"exp":{"type":"integer"},"iss":{"type":"string"},"iat":{"type":"integer"},"access":{"type":"object","properties":{"availableAccounts":{"type":"string"},"transactions":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"accounts":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}},"balances":{"type":"array","items":{"type":"object","properties":{"bban":{"type":"string"},"msisdn":{"type":"string"},"maskedPan":{"type":"string"},"iban":{"type":"string"},"currency":{"type":"string"},"pan":{"type":"string"}}}}}},"createdByUserId":{"type":"string"},"email":{"type":"string"},"jti":{"type":"string"},"name":{"type":"string"},"request_headers":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"sub":{"type":"string"}}},"status":{"type":"string"},"jwt":{"type":"string"},"api_version":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/consents","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsObpV400","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObpV400"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nCreate 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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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\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\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":[]},{"operation_id":"OBPv2.0.0-addKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"addKycMedia"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","summary":"Add KYC Media","description":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_MEDIA_ID](/glossary#kyc_media_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","example_request_body":{"customer_number":"5987953","type":"image","url":"http://www.example.com/id-docs/123/image.png","date":"1099-12-31T21:00:00Z","relates_to_kyc_document_id":"123","relates_to_kyc_check_id":"123"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1099-12-31T21:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-00004: Server error: could not add message","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"url":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"relates_to_kyc_document_id":{"type":"string"},"type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}},"roles":[{"role":"CanAddKycMedia","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-getEntitlementsForCurrentUser","implemented_by":{"version":"OBPv3.0.0","function":"getEntitlementsForCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/entitlements","summary":"Get Entitlements for the current User","description":"Get Entitlements for the current User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Get Entitlements for the current User.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/entitlements","connector_methods":[]},{"operation_id":"OBPv3.0.0-getBranches","implemented_by":{"version":"OBPv3.0.0","function":"getBranches"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches","summary":"Get Branches for a Bank","description":"Returns information about branches for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 50 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nYou can also use the follow url query parameters:
city - string, find Branches those in this city, optional
\nwithinMetersOf - number, find Branches within given meters distance, optional
\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","description_markdown":"Returns information about branches for a single bank specified by BANK_ID including:\n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under\n* Structured opening hours\n* Accessible flag\n* Branch Type\n* More Info\n\nPagination:\n\nBy default, 50 records are returned.\n\nYou can use the url query parameters *limit* and *offset* for pagination\nYou can also use the follow url query parameters:\n\n - city - string, find Branches those in this city, optional\n\n\n - withinMetersOf - number, find Branches within given meters distance, optional\n - nearLatitude - number, a position of latitude value, cooperate with withMetersOf do query filter, optional\n - nearLongitude - number, a position of longitude value, cooperate with withMetersOf do query filter, optional\n\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.\n\nUser Authentication is Optional. The User need not be logged in.\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[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n","success_response_body":{"branches":[{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-32001: No branches available. License may not be set.","OBP-50000: Unknown Error."],"tags":["Branch","Bank"],"typed_success_response_body":{"type":"object","properties":{"branches":{"type":"array","items":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv4.0.0-createStandingOrderManagement","implemented_by":{"version":"OBPv4.0.0","function":"createStandingOrderManagement"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/standing-order","summary":"Create Standing Order (management)","description":"Create standing order for an account.
\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}
\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nactive: false
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndate_cancelled: 2020-01-27
\ndate_expires: 2021-01-27
\ndate_signed: 2020-01-27
\ndate_starts: 2020-01-27
\n\nfrequency: DAILY
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nwhen: 2020-01-27
\n","description_markdown":"Create standing order for an account.\n\nwhen -> frequency = {‘YEARLY’,’MONTHLY, ‘WEEKLY’, ‘BI-WEEKLY’, DAILY’}\nwhen -> detail = { ‘FIRST_MONDAY’, ‘FIRST_DAY’, ‘LAST_DAY’}}\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n\n[date_expires](/glossary#): 2021-01-27\n\n\n\n[date_signed](/glossary#): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**active**](/glossary#active): false\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_cancelled**](/glossary#): 2020-01-27\n\n\n\n[**date_expires**](/glossary#): 2021-01-27\n\n\n\n[**date_signed**](/glossary#): 2020-01-27\n\n\n\n[**date_starts**](/glossary#): 2020-01-27\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**standing_order_id**](/glossary#standing_order_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","example_request_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","amount":{"currency":"EUR","amount":"0"},"when":{"frequency":"YEARLY","detail":"LAST_DAY"},"date_signed":"1099-12-31T21:00:00Z","date_starts":"1099-12-31T21:00:00Z","date_expires":"1099-12-31T21:00:00Z"},"success_response_body":{"standing_order_id":"aa0533bd-eb22-4bff-af75-d45240361b05","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","amount":{"currency":"EUR","amount":"0"},"when":{"frequency":"WEEKLY","detail":"FIRST_DAY"},"date_signed":"2026-03-16T21:00:25Z","date_starts":"2026-03-16T21:00:25Z","date_expires":"2026-03-16T21:00:25Z","date_cancelled":"2026-03-16T21:00:25Z","active":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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20057: User not found by userId.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Standing-Order","Account"],"typed_request_body":{"type":"object","properties":{"date_signed":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"date_expires":{"type":"string","format":"date-time"},"counterparty_id":{"type":"string"},"date_starts":{"type":"string","format":"date-time"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date_expires":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"active":{"type":"boolean"},"bank_id":{"type":"string"},"standing_order_id":{"type":"string"},"counterparty_id":{"type":"string"},"date_cancelled":{"type":"string","format":"date-time"},"when":{"type":"object","properties":{"frequency":{"type":"string"},"detail":{"type":"string"}}},"date_starts":{"type":"string","format":"date-time"},"amount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"date_signed":{"type":"string","format":"date-time"},"account_id":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateStandingOrderAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/standing-order","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "71c80111-d36c-4d55-863f-27f88380346e"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&branchId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&atmId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&accountId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&productCode=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&cardId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&accountId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9&transactionId=0137b84a-b7d7-4a71-bb9e-addbecae6665"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=71c80111-d36c-4d55-863f-27f88380346e&accountId=bb42966e-f6cc-4d5c-bd67-4b3dcdef82b9&counterpartyId=0137b84a-b7d7-4a71-bb9e-addbecae6665"\n}\n\nThis is a management endpoint that allows the creation of a Counterparty on any Account.
\nFor an introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nvalue: 5987953
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"This is a management endpoint that allows the creation of a Counterparty on any Account.\n\nFor an introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]},"success_response_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-10001: Incorrect json format.","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Counterparty","Account"],"typed_request_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"image_url":{"type":"string"}}},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"roles":[{"role":"CanCreateCounterparty","requires_bank_id":true},{"role":"CanCreateCounterpartyAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomersMinimalAtAnyBank","implemented_by":{"version":"OBPv4.0.0","function":"getCustomersMinimalAtAnyBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/customers-minimal","summary":"Get Customers Minimal at Any Bank","description":"Get Customers Minimal at Any Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n","description_markdown":"Get Customers Minimal at Any Bank.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customers**](/glossary#customers): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomersMinimalAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers-minimal","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.
\nUser Authentication is Optional. The User need not be logged in.
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: Description of the object. 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.\nUser Authentication is Optional. The User need not be logged in.\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): Description of the object. 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":"Description of the object. 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_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/api-collections/sharable/API_COLLECTION_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCardForBank","implemented_by":{"version":"OBPv3.1.0","function":"getCardForBank"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID","summary":"Get Card By Id","description":"This will the datails of the card.
\nIt shows the account infomation which linked the the card.
\nAlso shows the card attributes of the card.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\ncancelled: false
\n\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_number: 1
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\nvalue: 5987953
\n\n","description_markdown":"This will the datails of the card.\nIt shows the account infomation which linked the the card.\nAlso shows the card attributes of the card. \n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CARD_ID](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**cancelled**](/glossary#cancelled): false\n\n\n\n[**card_attributes**](/glossary#card_attributes): \n\n\n\n[**card_id**](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","bank_id":"gh.29.uk","card_number":"364435172576215","card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"technologyString1","networks":["networks1"],"allows":["credit","debit"],"account":{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"My Account","views_available":[{"id":"owner","name":"owner","description":"This view is for the owner for the account."}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","card_attributes":[{"name":"OVERDRAFT_START_DATE","card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","attribute_type":"STRING","bank_id":{"value":"gh.29.uk"},"value":"2012-04-23","card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Card"],"typed_success_response_body":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"technology":{"type":"string"},"customer_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"card_id":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"card_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]},"card_id":{"type":"string"},"name":{"type":"string"},"card_attribute_id":{"type":"string"}}}},"issue_number":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"}}},"serial_number":{"type":"string"},"collected":{"type":"string","format":"date-time"},"cancelled":{"type":"boolean"},"networks":{"type":"array","items":{"type":"string"}}}},"roles":[{"role":"CanGetCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards/CARD_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-getPermissionForUserForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getPermissionForUserForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","summary":"Get Account access for User","description":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
\nAll url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPROVIDER: ETHEREUM
\n\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n\n","description_markdown":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.\nAll url parameters must be [%-encoded](http://en.wikipedia.org/wiki/Percent-encoding), which is often especially relevant for USER_ID and PROVIDER.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nThe user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","success_response_body":{"views":[{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account","User"],"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-refreshUser","implemented_by":{"version":"OBPv3.1.0","function":"refreshUser"},"request_verb":"POST","request_url":"/obp/v3.1.0/users/USER_ID/refresh","summary":"Refresh User","description":"The endpoint is used for updating the accounts, views, account holders for the user.
\nAs to the Json body, you can leave it as Empty.
\nThis call will get data from backend, no need to prepare the json body in api side.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nJSON response body fields:
\nduration_time: 60
\n","description_markdown":"The endpoint is used for updating the accounts, views, account holders for the user.\n As to the Json body, you can leave it as Empty. \n This call will get data from backend, no need to prepare the json body in api side.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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 request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**duration_time**](/glossary#duration_time): 60\n\n\n","success_response_body":{"duration_time":"10 ms"},"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":["User"],"typed_success_response_body":{"type":"object","properties":{"duration_time":{"type":"string"}}},"roles":[{"role":"CanRefreshUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/refresh","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteBranch","implemented_by":{"version":"OBPv3.1.0","function":"deleteBranch"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Delete Branch","description":"Delete Branch from given Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n","description_markdown":"Delete Branch from given Bank.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[BRANCH_ID](/glossary#): DERBY6\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Branch"],"roles":[{"role":"CanDeleteBranch","requires_bank_id":true},{"role":"CanDeleteBranchAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerOverview","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerOverview"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customers/customer-number-query/overview","summary":"Get Customer Overview","description":"Gets the Customer Overview specified by customer_number and bank_code.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_number: 5987953
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlabel: My Account
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\nproduct_code: 1234BW
\n\nrelationship_status: single
\nscheme: OBP
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\ncontract_code: contract_code
\ncontracts: contracts
\n\n\n","description_markdown":"Gets the Customer Overview specified by customer_number and bank_code.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[contract_code](/glossary#): contract_code\n\n\n\n[contracts](/glossary#): contracts\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:25Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}],"accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","label":"My Account","product_code":"787LOW","balance":{"currency":"EUR","amount":"0"},"branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"contract_code":"LKJL98769F","product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"branch_id":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"contract_code":{"type":"string"}}}},"account_id":{"type":"string"}}}},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"},"last_ok_date":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanGetCustomerOverview","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/customer-number-query/overview","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerCreditLimit","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerCreditLimit"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit-limit","summary":"Update the credit limit of a Customer","description":"Update the credit limit of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the credit limit of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"credit_limit":{"currency":"EUR","amount":"1000"}},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerCreditLimit","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit-limit","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv5.1.0-getBankAccountsBalances","implemented_by":{"version":"OBPv5.1.0","function":"getBankAccountsBalances"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/balances","summary":"Get Account Balances by BANK_ID","description":"Get the Balances for the Account specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","description_markdown":"Get the Balances for the Account specified by BANK_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balances**](/glossary#): balances\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"accounts":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_routings":[{"scheme":"accountNumber","address":"123456"}],"label":"My Account","balances":[{"type":"","currency":"EUR","amount":"10"}]}]},"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-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/balances","connector_methods":[]},{"operation_id":"OBPv4.0.0-getBankLevelDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"getBankLevelDynamicResourceDoc"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Get Bank Level Dynamic Resource Doc by Id","description":"Get a Bank Level Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Get a Bank Level Dynamic Resource Doc by DYNAMIC-RESOURCE-DOC-ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanGetBankLevelDynamicResourceDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getTransactionRequests","implemented_by":{"version":"OBPv5.1.0","function":"getTransactionRequests"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","summary":"Get Transaction Requests","description":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
We support query transaction request by attribute
\nURL params example:/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests?invoiceNumber=123&referenceNumber=456
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\ntransaction_requests_with_charges:
\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"Returns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.\n\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.\n\nVersion 2.0.0 now returns charge information.\n\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:\n\n* Transaction Request Id\n* Type\n* Status (INITIATED, COMPLETED)\n* Challenge (in order to confirm the request)\n* From Bank / Account\n* Details including Currency, Value, Description and other initiation information specific to each type. (Could potentialy include a list of future transactions.)\n* Related Transactions\n\nPSD2 Context: PSD2 requires transparency of charges to the customer.\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.\nThe customer can proceed with the Transaction by answering the security challenge.\n\nWe support query transaction request by attribute\nURL params example:/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests?invoiceNumber=123&referenceNumber=456\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transaction_requests_with_charges**](/glossary#transaction_requests_with_charges): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","success_response_body":{"transaction_requests_with_charges":[{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-20022: View does not permit the access.","OBP-60010: Get Transaction Requests Exception. ","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)"],"typed_success_response_body":{"type":"object","properties":{"transaction_requests_with_charges":{"type":"array","items":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteCounterpartyForAnyAccount","implemented_by":{"version":"OBPv4.0.0","function":"deleteCounterpartyForAnyAccount"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Delete Counterparty for any account (Explicit)","description":"This is a management endpoint that enables the deletion of any specified Counterparty along with any related Metadata of that Counterparty.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"This is a management endpoint that enables the deletion of any specified Counterparty along with any related Metadata of that Counterparty.\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"roles":[{"role":"CanDeleteCounterparty","requires_bank_id":true},{"role":"CanDeleteCounterpartyAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycDocument","implemented_by":{"version":"OBPv2.0.0","function":"addKycDocument"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_ID","summary":"Add KYC Document","description":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc. \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[KYC_DOCUMENT_ID](/glossary#kyc_document_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"customer_number":"5987953","type":"passport","number":"12345","issue_date":"1099-12-31T21:00:00Z","issue_place":"Berlin","expiry_date":"1099-12-31T21:00:00Z"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1099-12-31T21:00:00Z","issue_place":"PlaceholderString","expiry_date":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","Server error: could not add KycDocument","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"issue_place":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"type":{"type":"string"},"number":{"type":"string"},"issue_date":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"issue_place":{"type":"string"},"customer_id":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}},"roles":[{"role":"CanAddKycDocument","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_documents/KYC_DOCUMENT_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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "0246459f-3f5f-4fa7-b5b1-2b9481d59bc8"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&branchId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&atmId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&accountId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&productCode=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&cardId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&accountId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f&transactionId=78b20aea-ce27-4796-8c78-8622d195cf91"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=0246459f-3f5f-4fa7-b5b1-2b9481d59bc8&accountId=ec0e8697-7e05-48bc-9c2d-ca42745f5d6f&counterpartyId=78b20aea-ce27-4796-8c78-8622d195cf91"\n}\n\nUpdate ATM Services.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\n","description_markdown":"Update ATM Services.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n","example_request_body":{"services":["ATBP","ATBA"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","services":["ATBP","ATBA"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"services":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"atm_id":{"type":"string"},"services":{"type":"array","items":{"type":"string"}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/services","connector_methods":[]},{"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.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Update Bank Level dynamic endpoint Host.\nThe value can be obp_mock, dynamic_entity, or some service url.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-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
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nNote: Resource Docs are cached, TTL is 3600 seconds\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv5.1.0-selfRevokeConsent","implemented_by":{"version":"OBPv5.1.0","function":"selfRevokeConsent"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/my/consent/current","summary":"Revoke Consent used in the Current Call","description":"Revoke Consent specified by Consent-Id at Request Header
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"Revoke Consent specified by Consent-Id at Request Header\n\nThere are a few reasons you might need to revoke an application’s access to a user’s account:\n - The user explicitly wishes to revoke the application’s access\n - You as the service provider have determined an application is compromised or malicious, and want to disable it\n - etc.\n\nOBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.\nThe status of the token is changed to \"REVOKED\" so the next time the revoked client makes a request, their token will fail to validate.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"REJECTED"},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consent/current","connector_methods":[]},{"operation_id":"OBPv5.0.0-createCustomerAccountLink","implemented_by":{"version":"OBPv5.0.0","function":"createCustomerAccountLink"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/customer-account-links","summary":"Create Customer Account Link","description":"Link a Customer to a Account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","description_markdown":"Link a Customer to a Account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_account_link_id**](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n","example_request_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"},"success_response_body":{"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30223: The Account is already linked to a Customer at the bank specified by BANK_ID","OBP-30224: Could not create the customer account link.","OBP-50000: Unknown Error."],"tags":["Customer","Account"],"typed_request_body":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerAccountLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer-account-links","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCallsLimit","implemented_by":{"version":"OBPv5.1.0","function":"getCallsLimit"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/call-limits","summary":"Get Call Limits for a Consumer","description":"Get Calls limits per Consumer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncreated_at: created_at
\nfrom_date: 1100-01-01T01:01:01.000Z
\nlimits: limits
\n\n\n\n\n\n\nrate_limiting_id: rate_limiting_id
\nto_date: 1100-01-01T01:01:01.000Z
\nupdated_at: updated_at
\n","description_markdown":"Get Calls limits per Consumer.\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**created_at**](/glossary#): created_at\n\n\n\n[**from_date**](/glossary#from_date): 1100-01-01T01:01:01.000Z\n\n\n\n[**limits**](/glossary#): limits\n\n\n\n[**per_day_call_limit**](/glossary#per_day_call_limit): \n\n\n\n[**per_hour_call_limit**](/glossary#per_hour_call_limit): \n\n\n\n[**per_minute_call_limit**](/glossary#per_minute_call_limit): \n\n\n\n[**per_month_call_limit**](/glossary#per_month_call_limit): \n\n\n\n[**per_second_call_limit**](/glossary#per_second_call_limit): 10\n\n\n\n[**per_week_call_limit**](/glossary#per_week_call_limit): \n\n\n\n[**rate_limiting_id**](/glossary#): rate_limiting_id\n\n\n\n[**to_date**](/glossary#to_date): 1100-01-01T01:01:01.000Z\n\n\n\n[**updated_at**](/glossary#): updated_at\n\n\n","success_response_body":{"limits":[{"rate_limiting_id":"80e1e0b2-d8bf-4f85-a579-e69ef36e3305","from_date":"1099-12-31T21:00:00Z","to_date":"1099-12-31T21:00:00Z","per_second_call_limit":"100","per_minute_call_limit":"100","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1","created_at":"1099-12-31T21:00:00Z","updated_at":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30023: Cannot update Consumer ","OBP-50000: Unknown Error."],"tags":["Consumer"],"typed_success_response_body":{"type":"object","properties":{"limits":{"type":"array","items":{"type":"object","properties":{"rate_limiting_id":{"type":"string"},"per_second_call_limit":{"type":"string"},"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"},"per_minute_call_limit":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"updated_at":{"type":"string","format":"date-time"}}}}}},"roles":[{"role":"CanReadCallLimits","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/call-limits","connector_methods":[]},{"operation_id":"OBPv2.2.0-createFx","implemented_by":{"version":"OBPv2.2.0","function":"createFx"},"request_verb":"PUT","request_url":"/obp/v2.2.0/banks/BANK_ID/fx","summary":"Create Fx","description":"Create or Update Fx for the Bank.
\nExample:
\n“from_currency_code”:“EUR”,
\n“to_currency_code”:“USD”,
\n“conversion_value”: 1.136305,
\n“inverse_conversion_value”: 1 / 1.136305 = 0.8800454103431737,
Thus 1 Euro = 1.136305 US Dollar
\nand
\n1 US Dollar = 0.8800 Euro
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\n\n\nto_currency_code: EUR
\n","description_markdown":"Create or Update Fx for the Bank.\n\nExample:\n\n“from_currency_code”:“EUR”,\n“to_currency_code”:“USD”,\n“conversion_value”: 1.136305,\n“inverse_conversion_value”: 1 / 1.136305 = 0.8800454103431737,\n\n Thus 1 Euro = 1.136305 US Dollar\n and\n 1 US Dollar = 0.8800 Euro\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**conversion_value**](/glossary#conversion_value): 100\n\n\n\n[**effective_date**](/glossary#effective_date): 2020-01-27\n\n\n\n[**from_currency_code**](/glossary#from_currency_code): \n\n\n\n[**inverse_conversion_value**](/glossary#inverse_conversion_value): 50\n\n\n\n[**to_currency_code**](/glossary#to_currency_code): EUR\n\n\n","example_request_body":{"bank_id":"gh.29.uk","from_currency_code":"EUR","to_currency_code":"USD","conversion_value":1.136305,"inverse_conversion_value":0.8800454103431737,"effective_date":"1099-12-31T21:00:00Z"},"success_response_body":{"bank_id":"gh.29.uk","from_currency_code":"EUR","to_currency_code":"USD","conversion_value":1.136305,"inverse_conversion_value":0.8800454103431737,"effective_date":"1099-12-31T21:00:00Z"},"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":["FX"],"typed_request_body":{"type":"object","properties":{"conversion_value":{"type":"number"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"to_currency_code":{"type":"string"},"effective_date":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"conversion_value":{"type":"number"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"to_currency_code":{"type":"string"},"effective_date":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateFxRate","requires_bank_id":true},{"role":"CanCreateFxRateAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/fx","connector_methods":[]},{"operation_id":"OBPv4.0.0-getConsentInfosByBank","implemented_by":{"version":"OBPv4.0.0","function":"getConsentInfosByBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/my/consent-infos","summary":"Get My Consents Info At Bank","description":"This endpoint gets the Consents that the current User created at bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napi_standard: api_standard
\n\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nlast_action_date: last_action_date
\nlast_usage_date: last_usage_date
\n\n","description_markdown":"This endpoint gets the Consents that the current User created at bank.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**api_standard**](/glossary#): api_standard\n\n\n\n[**api_version**](/glossary#api_version): \n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**consents**](/glossary#consents): \n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**last_action_date**](/glossary#): last_action_date\n\n\n\n[**last_usage_date**](/glossary#): last_usage_date\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"consents":[{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","last_action_date":"2020-01-27","last_usage_date":"2021-04-08T09:12:27Z","status":"INITIATED","api_standard":"Berlin Group","api_version":"v1.3"}]},"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-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"created_by_user_id":{"type":"string"},"api_standard":{"type":"string"},"consumer_id":{"type":"string"},"last_usage_date":{"type":"string","format":"date-time"},"last_action_date":{"type":"string","format":"date-time"},"consent_id":{"type":"string"},"status":{"type":"string"},"api_version":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/my/consent-infos","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateCustomView","implemented_by":{"version":"OBPv5.1.0","function":"updateCustomView"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","summary":"Update Custom View","description":"Update an existing custom view on a bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Update an existing custom view on a bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n\nThe json sent is the same as during view creation (above), with one difference: the 'name' field\nof a view is not editable (it is only set when a view is created)\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TARGET_VIEW_ID](/glossary#): TARGET_VIEW_ID\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allowed_permissions**](/glossary#): allowed_permissions\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"description":"This view is for the owner for the account.","metadata_view":"","is_public":false,"which_alias_to_use":"public","hide_metadata_if_alias_used":false,"allowed_permissions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"]},"success_response_body":{"id":"owner","name":"owner","description":"This view is for the owner for the account.","metadata_view":"","is_public":false,"alias":"public","hide_metadata_if_alias_used":false,"allowed_permissions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"updateEndpointMapping"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Update Endpoint Mapping","description":"Update an Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Update an Endpoint Mapping.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}}},"success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanUpdateEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsentByConsentId","implemented_by":{"version":"OBPv5.1.0","function":"getConsentByConsentId"},"request_verb":"GET","request_url":"/obp/v5.1.0/user/current/consents/CONSENT_ID","summary":"Get Consent By Consent Id via User","description":"This endpoint gets the Consent By consent id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n","description_markdown":"This endpoint gets the Consent By consent id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[scopes](/glossary#scopes): \n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","scopes":[{"role_name":"","bank_id":"gh.29.uk"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"scopes":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/user/current/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestCounterparty","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestCounterparty"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","summary":"Create Transaction Request (COUNTERPARTY)","description":"For an introduction to Transaction Requests, see: here
\nWhen using a COUNTERPARTY to create a Transaction Request, specify the counterparty_id in the body of the request.
\nThe routing details of the counterparty will be forwarded to the Core Banking System (CBS) for the transfer.
COUNTERPARTY Transaction Requests are used for Variable Recurring Payments (VRP). Use the following endpoint to create a consent for VRPs.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\nattribute_type: STRING
\ncharge_policy: SHARED
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nto:
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nfuture_date: 20200127
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"For an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\nWhen using a COUNTERPARTY to create a Transaction Request, specify the counterparty_id in the body of the request.\nThe routing details of the counterparty will be forwarded to the Core Banking System (CBS) for the transfer.\n\nCOUNTERPARTY Transaction Requests are used for Variable Recurring Payments (VRP). Use the following endpoint to create a consent for VRPs.\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY](/glossary#counterparty): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**charge_policy**](/glossary#): SHARED\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[future_date](/glossary#future_date): 20200127\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A description for the transaction to the counterparty","charge_policy":"SHARED","future_date":"20200127","attributes":[{"name":"HOUSE_RENT","attribute_type":"STRING","value":"123456789"}]},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"charge_policy":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/COUNTERPARTY/transaction-requests","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)
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\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\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[CONNECTOR](/glossary#Connector): CONNECTOR\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/message-docs/CONNECTOR/swagger2.0","connector_methods":[]},{"operation_id":"OBPv4.0.0-getDoubleEntryTransaction","implemented_by":{"version":"OBPv4.0.0","function":"getDoubleEntryTransaction"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/double-entry-transaction","summary":"Get Double Entry Transaction","description":"Get Double Entry Transaction
\nThis endpoint can be used to see the double entry transactions. It returns the bank_id, account_id and transaction_id
\nfor the debit end the credit transaction. The other side account can be a settlement account or an OBP account.
The endpoint also provide the transaction_request object which contains the bank_id, account_id and
\ntransaction_request_id of the transaction request at the origin of the transaction. Please note that if none
\ntransaction request is at the origin of the transaction, the transaction_request object will be null.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncredit_transaction: credit_transaction
\ndebit_transaction: debit_transaction
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request: transaction_request
\ntransaction_request_id: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\n","description_markdown":"Get Double Entry Transaction\n\nThis endpoint can be used to see the double entry transactions. It returns the `bank_id`, `account_id` and `transaction_id`\nfor the debit end the credit transaction. The other side account can be a settlement account or an OBP account.\n\nThe endpoint also provide the `transaction_request` object which contains the `bank_id`, `account_id` and\n`transaction_request_id` of the transaction request at the origin of the transaction. Please note that if none\ntransaction request is at the origin of the transaction, the `transaction_request` object will be `null`.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**credit_transaction**](/glossary#): credit_transaction\n\n\n\n[**debit_transaction**](/glossary#): debit_transaction\n\n\n\n[**transaction_id**](/glossary#): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[**transaction_request**](/glossary#): transaction_request\n\n\n\n[**transaction_request_id**](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n","success_response_body":{"transaction_request":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_request_id":"8138a7e4-6d02-40e3-a129-0b2bf89de9f1"},"debit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"},"credit_transaction":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","transaction_id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub"}},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"debit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"credit_transaction":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_id":{"type":"string"},"account_id":{"type":"string"}}},"transaction_request":{"type":"object","properties":{"bank_id":{"type":"string"},"transaction_request_id":{"type":"string"},"account_id":{"type":"string"}}}}},"roles":[{"role":"CanGetDoubleEntryTransactionAtAnyBank","requires_bank_id":false},{"role":"CanGetDoubleEntryTransactionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/double-entry-transaction","connector_methods":[]},{"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.
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nglossary-item-not-found\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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-answerTransactionRequestChallenge","implemented_by":{"version":"OBPv4.0.0","function":"answerTransactionRequestChallenge"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","summary":"Answer Transaction Request Challenge","description":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
\n1)TRANSACTION_REQUEST_TYPE : is the same as createTransactionRequest request URL .
2)TRANSACTION_REQUEST_ID : is the id field in createTransactionRequest response body.
3) id : is challenge.id field in createTransactionRequest response body.
4) answer : must be 123 in case that Strong Customer Authentication method for OTP challenge is dummy.
\nFor instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy
\nPossible values are dummy,email and sms
\nIn CBS mode, the answer can be got by phone message or other SCA methods.
Note that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.
\nOTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.
Single or Multiple authorisations
\nOBP allows single or multi party authorisations.
\nSingle party authorisation:
\nIn the case that only one person needs to authorise i.e. answer a security challenge we have the following change of state of a transaction request:
\nINITIATED => COMPLETED
Multiparty authorisation:
\nIn the case that multiple parties (n persons) need to authorise a transaction request i.e. answer security challenges, we have the followings state flow for a transaction request:
\nINITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED
The security challenge is bound to a user i.e. in the case of a correct answer but the user is different than expected the challenge will fail.
\nRule for calculating number of security challenges:
\nIf Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges
\n(one for every user that has a View where permission can_add_transaction_request_to_any_account=true)
\nIn the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nTRANSACTION_REQUEST_TYPE: SEPA
\nVIEW_ID: owner
\nJSON request body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nadditional_information: additional_information
\nreason_code: reason_code
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"In Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.\n\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.\n\n1)`TRANSACTION_REQUEST_TYPE` : is the same as createTransactionRequest request URL .\n\n2)`TRANSACTION_REQUEST_ID` : is the `id` field in createTransactionRequest response body.\n\n3) `id` : is `challenge.id` field in createTransactionRequest response body.\n\n4) `answer` : must be `123` in case that Strong Customer Authentication method for OTP challenge is dummy.\n For instance: SANDBOX_TAN_OTP_INSTRUCTION_TRANSPORT=dummy\n Possible values are dummy,email and sms\n In CBS mode, the answer can be got by phone message or other SCA methods.\n\nNote that each Transaction Request Type can have its own OTP_INSTRUCTION_TRANSPORT method.\nOTP_INSTRUCTION_TRANSPORT methods are set in Props. See sample.props.template for instructions.\n\nSingle or Multiple authorisations\n\nOBP allows single or multi party authorisations.\n\nSingle party authorisation:\n\nIn the case that only one person needs to authorise i.e. answer a security challenge we have the following change of state of a `transaction request`:\n INITIATED => COMPLETED\n\n\nMultiparty authorisation:\n\nIn the case that multiple parties (n persons) need to authorise a transaction request i.e. answer security challenges, we have the followings state flow for a `transaction request`:\n INITIATED => NEXT_CHALLENGE_PENDING => ... => NEXT_CHALLENGE_PENDING => COMPLETED\n\nThe security challenge is bound to a user i.e. in the case of a correct answer but the user is different than expected the challenge will fail.\n\nRule for calculating number of security challenges:\nIf Product Account attribute REQUIRED_CHALLENGE_ANSWERS=N then create N challenges\n(one for every user that has a View where permission can_add_transaction_request_to_any_account=true)\nIn the case REQUIRED_CHALLENGE_ANSWERS is not defined as an account attribute, the default number of security challenges created is one.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n[TRANSACTION_REQUEST_TYPE](/glossary#): SEPA\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[additional_information](/glossary#): additional_information\n\n\n\n[reason_code](/glossary#): reason_code\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"id":"This is challenge.id, you can get it from `Create Transaction Request.` response, only is useful if status ==`INITIATED` there.","answer":"123","reason_code":"[Optional] Reason code for REJECT answer (e.g. 'CUST')","additional_information":"[Optional] Additional description for REJECT answer"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40011: Transaction Request Status is not INITIATED.","OBP-40009: The TRANSACTION_REQUEST_TYPE has changed.","OBP-40014: Sorry, you've used up your allowed attempts. ","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"additional_information":{"type":"string"},"answer":{"type":"string"},"reason_code":{"type":"string"},"id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyImageUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Update Counterparty Image Url","description":"Update the url that points to the logo of the counterparty
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the url that points to the logo of the counterparty\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"image_URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating an image url","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"image_URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"deleteTaxResidence"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","summary":"Delete Tax Residence","description":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","description_markdown":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[TAX_RESIDENCE_ID](/glossary#tax_residence_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-50000: Unknown Error."],"tags":["Customer","KYC"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-syncExternalUser","implemented_by":{"version":"OBPv5.1.0","function":"syncExternalUser"},"request_verb":"POST","request_url":"/obp/v5.1.0/users/PROVIDER/PROVIDER_ID/sync","summary":"Sync User","description":"The endpoint is used to create or sync an OBP User with User from an external identity provider.
\nPROVIDER is the host of the provider e.g. a Keycloak Host.
\nPROVIDER_ID is the unique identifier for the User at the PROVIDER.
\nAt the end of the process, a User will exist in OBP with the Account Access records defined by the CBS.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\n\nJSON request body fields:
\nJSON response body fields:
\nduration_time: 60
\n","description_markdown":"The endpoint is used to create or sync an OBP User with User from an external identity provider.\nPROVIDER is the host of the provider e.g. a Keycloak Host.\nPROVIDER_ID is the unique identifier for the User at the PROVIDER.\nAt the end of the process, a User will exist in OBP with the Account Access records defined by the CBS.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[PROVIDER_ID](/glossary#provider_id): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**duration_time**](/glossary#duration_time): 60\n\n\n","success_response_body":{"duration_time":"10 ms"},"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":["User"],"typed_success_response_body":{"type":"object","properties":{"duration_time":{"type":"string"}}},"roles":[{"role":"CanSyncUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/PROVIDER/PROVIDER_ID/sync","connector_methods":[]},{"operation_id":"OBPv3.1.0-updatedCardForBank","implemented_by":{"version":"OBPv3.1.0","function":"updatedCardForBank"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID","summary":"Update Card","description":"Update Card at bank specified by CARD_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n\n\nallows: [credit,debit,cash_withdrawal]
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncancelled: false
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_number: 364435172576215
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nenabled: false
\nexpires_date: 2021-01-27
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\n\non_hot_list: false
\n\nposted: 2020-01-27
\n\n\nrequested_date: 2020-01-27
\nserial_number: 1324234
\n\ntechnology: technology1
\nvalid_from_date: 2020-01-27
\n\n","description_markdown":"Update Card at bank specified by CARD_ID .\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CARD_ID](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allows**](/glossary#allows): [credit,debit,cash_withdrawal]\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**cancelled**](/glossary#cancelled): false\n\n\n\n[**card_id**](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**collected**](/glossary#collected): 2020-01-27\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**expires_date**](/glossary#): 2021-01-27\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**issue_number**](/glossary#): 1\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**networks**](/glossary#networks): \n\n\n\n[**on_hot_list**](/glossary#on_hot_list): false\n\n\n\n[**pin_reset**](/glossary#pin_reset): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**reason_requested**](/glossary#reason_requested): \n\n\n\n[**replacement**](/glossary#replacement): \n\n\n\n[**requested_date**](/glossary#): 2020-01-27\n\n\n\n[**serial_number**](/glossary#): 1324234\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**technology**](/glossary#technology): technology1\n\n\n\n[**valid_from_date**](/glossary#): 2020-01-27\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","example_request_body":{"card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"technology":"technology1","networks":["network1","network2"],"allows":["credit","debit"],"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"},{"requested_date":"2026-03-16T21:00:23Z","reason_requested":"GOOD_SECURITY_PRACTICE"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"success_response_body":{"card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","bank_id":"gh.29.uk","card_number":"364435172576215","card_type":"Credit","name_on_card":"SusanSmith","issue_number":"1","serial_number":"1324234","valid_from_date":"1099-12-31T21:00:00Z","expires_date":"1099-12-31T21:00:00Z","enabled":true,"cancelled":true,"on_hot_list":true,"technology":"technologyString1","networks":["networks1"],"allows":["credit","debit"],"account":{"id":"123","label":"OBP","views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk"},"replacement":{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"RENEW"},"pin_reset":[{"requested_date":"1099-12-31T21:00:00Z","reason_requested":"FORGOT"}],"collected":"1099-12-31T21:00:00Z","posted":"1099-12-31T21:00:00Z","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10015: Allowed values are:","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"technology":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"customer_id":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"valid_from_date":{"type":"string","format":"date-time"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"networks":{"type":"array","items":{"type":"string"}},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"serial_number":{"type":"string"},"collected":{"type":"string","format":"date-time"},"account_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"card_number":{"type":"string"},"enabled":{"type":"boolean"},"allows":{"type":"array","items":{"type":"string"}},"on_hot_list":{"type":"boolean"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"account":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"id":{"type":"string"}}},"technology":{"type":"string"},"customer_id":{"type":"string"},"valid_from_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"posted":{"type":"string","format":"date-time"},"replacement":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}},"card_id":{"type":"string"},"expires_date":{"type":"string","format":"date-time"},"issue_number":{"type":"string"},"pin_reset":{"type":"array","items":{"type":"object","properties":{"reason_requested":{"type":"string"},"requested_date":{"type":"string","format":"date-time"}}}},"serial_number":{"type":"string"},"collected":{"type":"string","format":"date-time"},"cancelled":{"type":"boolean"},"networks":{"type":"array","items":{"type":"string"}}}},"roles":[{"role":"CanUpdateCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards/CARD_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-createConsentByConsentRequestIdEmail","implemented_by":{"version":"OBPv5.0.0","function":"createConsentByConsentRequestIdEmail"},"request_verb":"POST","request_url":"/obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/EMAIL/consents","summary":"Create Consent By CONSENT_REQUEST_ID (EMAIL)","description":"This endpoint continues the process of creating a Consent.
\nIt starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent cannot elevate the privileges of the logged in user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","description_markdown":"This endpoint continues the process of creating a Consent.\n\nIt starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.\n\nPlease note that the Consent cannot elevate the privileges of the logged in user.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_REQUEST_ID](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[EMAIL](/glossary#): felixsmith@example.com\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[account_access](/glossary#): account_access\n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_access":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}},"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-10001: Incorrect json format.","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","VRP"],"typed_success_response_body":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/EMAIL/consents","connector_methods":[]},{"operation_id":"OBPv4.0.0-ibanChecker","implemented_by":{"version":"OBPv4.0.0","function":"ibanChecker"},"request_verb":"POST","request_url":"/obp/v4.0.0/account/check/scheme/iban","summary":"Validate and check IBAN","description":"Validate and check IBAN for errors
\nUser Authentication is Optional. The User need not be logged in.
\nJSON request body fields:
\n\nJSON response body fields:
\n\nattributes: attribute value in form of (name, value)
\nbank:
\nbank_routings: bank routing in form of (scheme, address)
\nbranch: branch
\ncity:
\ncountry: Germany
\nis_valid: is_valid
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nscheme: OBP
\nvalue: 5987953
\n\n","description_markdown":"Validate and check IBAN for errors\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON request body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**bank_routings**](/glossary#bank_routings): bank routing in form of (scheme, address)\n\n\n\n[**branch**](/glossary#Branch): branch\n\n\n\n[**city**](/glossary#city): \n\n\n\n[**country**](/glossary#country): Germany\n\n\n\n[**is_valid**](/glossary#): is_valid\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[details](/glossary#details): \n\n\n","example_request_body":{"address":"DE75512108001245126199"},"success_response_body":{"is_valid":true,"details":{"bank_routings":[{"scheme":"BIC","address":"SOGEDEFF"}],"bank":"Societe Generale","branch":"","address":"Neue mainzer strasse 46-50","city":"Frankfurt am Main","postcode":"60311","phone":"","country":"Germany","attributes":[{"name":"country_iso","value":""},{"name":"sepa_credit_transfer","value":"YES"},{"name":"sepa_direct_debit","value":"YES"},{"name":"sepa_sdd_core","value":"YES"},{"name":"sepa_b2b","value":"YES"},{"name":"sepa_card_clearing","value":"YES"}]}},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"address":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"is_valid":{"type":"boolean"},"details":{"type":"object","properties":{"postcode":{"type":"string"},"branch":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"address":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"city":{"type":"string"},"country":{"type":"string"},"bank":{"type":"string"},"phone":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/account/check/scheme/iban","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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\napp_name: appNameBank
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): appNameBank\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":"1099-12-31T21: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"},"date":{"type":"string","format":"date-time"},"verb":{"type":"string"},"implemented_by_partial_function":{"type":"string"},"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":"OBPv3.1.0-getAccountApplications","implemented_by":{"version":"OBPv3.1.0","function":"getAccountApplications"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications","summary":"Get Account Applications","description":"Get the Account Applications.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\nproduct_code: 1234BW
\nprovider: ETHEREUM
\n\n\nrelationship_status: single
\n\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n\n\n","description_markdown":"Get the Account Applications.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_application_id**](/glossary#account_application_id): \n\n\n\n[**account_applications**](/glossary#account_applications): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_application**](/glossary#date_of_application): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"account_applications":[{"account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763","product_code":"1234BW","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"customer":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"date_of_application":"1099-12-31T21:00:00Z","status":"REQUESTED"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account-Application","Account"],"typed_success_response_body":{"type":"object","properties":{"account_applications":{"type":"array","items":{"type":"object","properties":{"date_of_application":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"product_code":{"type":"string"},"status":{"type":"string"},"customer":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"account_application_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/account-applications","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"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":"glossary-item-not-found
\nDelete Api Collection Endpoint
\nDelete Api Collection Endpoint By Id
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\nDelete Api Collection Endpoint\nDelete Api Collection Endpoint By Id\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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":"OBPv3.1.0-deleteCustomerAddress","implemented_by":{"version":"OBPv3.1.0","function":"deleteCustomerAddress"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","summary":"Delete Customer Address","description":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ADDRESS_ID](/glossary#customer_address_id): \n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\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":["Customer","KYC"],"roles":[{"role":"CanDeleteCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get My Dynamic Endpoints.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv3.0.0-addEntitlementRequest","implemented_by":{"version":"OBPv3.0.0","function":"addEntitlementRequest"},"request_verb":"POST","request_url":"/obp/v3.0.0/entitlement-requests","summary":"Create Entitlement Request for current User","description":"Create Entitlement Request.
\nAny logged in User can use this endpoint to request an Entitlement
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Create Entitlement Request.\n\nAny logged in User can use this endpoint to request an Entitlement\n\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlement_request_id**](/glossary#entitlement_request_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"bank_id":"gh.29.uk","role_name":"CanCreateBranch"},"success_response_body":{"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723","user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]}},"role_name":"CanQueryOtherUser","bank_id":"gh.29.uk","created":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-10001: Incorrect json format.","OBP-10007: Incorrect Role name:","OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.","OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.","OBP-30214: Entitlement Request already exists for the user.","OBP-30217: Entitlement Request cannot be added.","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"entitlement_request_id":{"type":"string"},"created":{"type":"string","format":"date-time"},"role_name":{"type":"string"},"bank_id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"user_id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/entitlement-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-getTagsForViewOnAccount","implemented_by":{"version":"OBPv4.0.0","function":"getTagsForViewOnAccount"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags","summary":"Get tags on account","description":"Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
Authentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\ntags: Create-My-User
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the account ACCOUNT_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account-Metadata","Account"],"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAtmAccessibilityFeatures","implemented_by":{"version":"OBPv4.0.0","function":"updateAtmAccessibilityFeatures"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/atms/ATM_ID/accessibility-features","summary":"Update ATM Accessibility Features","description":"Update ATM Accessibility Features.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n","description_markdown":"Update ATM Accessibility Features.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n","example_request_body":{"accessibility_features":["ATAC","ATAD"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","accessibility_features":["ATAC","ATAD"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"accessibility_features":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"accessibility_features":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/accessibility-features","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerNumber","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerNumber"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/number","summary":"Update the number of a Customer","description":"Update the number of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the number of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"customer_number":"5987953"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"customer_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerNumber","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/number","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateBankAccountBalance","implemented_by":{"version":"OBPv5.1.0","function":"updateBankAccountBalance"},"request_verb":"PUT","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","summary":"Update Bank Account Balance","description":"Update an existing Bank Account Balance specified by BALANCE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBALANCE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","description_markdown":"Update an existing Bank Account Balance specified by BALANCE_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BALANCE_ID](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**balance_amount**](/glossary#): 50.89\n\n\n\n[**balance_id**](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**balance_type**](/glossary#balance_type): openingBooked\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n","example_request_body":{"balance_type":"openingBooked","balance_amount":"50.89"},"success_response_body":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","balance_type":"openingBooked","balance_amount":"50.89"},"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":["Account","Balance"],"typed_request_body":{"type":"object","properties":{"balance_amount":{"type":"string"},"balance_type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}},"roles":[{"role":"CanUpdateBankAccountBalance","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances/BALANCE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createOrUpdateProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"createOrUpdateProductAttributeDefinition"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/product","summary":"Create or Update Product Attribute Definition","description":"Create or Update Product Attribute Definition
\nThe category field must be Product
\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Create or Update Product Attribute Definition\n\nThe category field must be Product\n\nThe type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","example_request_body":{"name":"SPECIAL_TAX_NUMBER","category":"Product","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":true},"success_response_body":{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Product","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Product"],"typed_request_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}},"roles":[{"role":"CanCreateProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/product","connector_methods":[]},{"operation_id":"OBPv1.2.1-addCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addCommentForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Add a Transaction Comment","description":"Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
\n${authenticationRequiredMessage(false)}
\nAuthentication is required since the comment is linked with the user.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a comment about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\n${authenticationRequiredMessage(false)}\n\nAuthentication is required since the comment is linked with the user.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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-getTransactionAttributeById","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributeById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ATTRIBUTE_ID","summary":"Get Transaction Attribute By Id","description":"Get Transaction Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Attribute By Id\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanGetTransactionAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyMoreInfo","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyMoreInfo"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","summary":"Update Counterparty More Info","description":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"more_info":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating more info","More Info cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"more_info":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","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 en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nGets the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\nvalue: 5987953
\n\n\n","description_markdown":"Gets the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_attributes**](/glossary#customer_attributes): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr","customer_attributes":[{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"customer_attributes":{"type":"array","items":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getRegulatedEntityById","implemented_by":{"version":"OBPv5.1.0","function":"getRegulatedEntityById"},"request_verb":"GET","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID","summary":"Get Regulated Entity","description":"Get Regulated Entity By REGULATED_ENTITY_ID
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattributeType: attributeType
\ncertificate_authority_ca_owner_id: CY_CBC
\nentity_address: EXAMPLE COMPANY LTD, 5 SOME STREET
\nentity_certificate_public_key: MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==
\nentity_code: PSD_PICY_CBC!12345
\nentity_country: CY
\nentity_id: 0af807d7-3c39-43ef-9712-82bcfde1b9ca
\nentity_name: EXAMPLE COMPANY LTD
\nentity_post_code: 1060
\nentity_town_city: SOME CITY
\nentity_type: PSD_PI
\nentity_web_site: www.example.com
\nname: ACCOUNT_MANAGEMENT_FEE
\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\n","description_markdown":"Get Regulated Entity By REGULATED_ENTITY_ID\n \n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attributeType**](/glossary#): attributeType\n\n\n\n[**certificate_authority_ca_owner_id**](/glossary#certificate_authority_ca_owner_id): CY_CBC\n\n\n\n[**entity_address**](/glossary#entity_address): EXAMPLE COMPANY LTD, 5 SOME STREET\n\n\n\n[**entity_certificate_public_key**](/glossary#entity_certificate_public_key): MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==\n\n\n\n[**entity_code**](/glossary#entity_code): PSD_PICY_CBC!12345\n\n\n\n[**entity_country**](/glossary#entity_country): CY\n\n\n\n[**entity_id**](/glossary#entity_id): 0af807d7-3c39-43ef-9712-82bcfde1b9ca\n\n\n\n[**entity_name**](/glossary#entity_name): EXAMPLE COMPANY LTD\n\n\n\n[**entity_post_code**](/glossary#entity_post_code): 1060\n\n\n\n[**entity_town_city**](/glossary#entity_town_city): SOME CITY\n\n\n\n[**entity_type**](/glossary#entity_type): PSD_PI\n\n\n\n[**entity_web_site**](/glossary#entity_web_site): www.example.com\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n","success_response_body":{"entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","certificate_authority_ca_owner_id":"CY_CBC","entity_certificate_public_key":"MIICsjCCAZqgAwIBAgIGAYwQ62R0MA0GCSqGSIb3DQEBCwUAMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTAeFw0yMzExMjcxMzE1MTFaFw0yNTExMjYxMzE1MTFaMBoxGDAWBgNVBAMMD2FwcC5leGFtcGxlLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK9WIodZHWzKyCcf9YfWEhPURbfO6zKuMqzHN27GdqHsVVEGxP4F/J4mso+0ENcRr6ur4u81iREaVdCc40rHDHVJNEtniD8Icbz7tcsqAewIVhc/q6WXGqImJpCq7hA0m247dDsaZT0lb/MVBiMoJxDEmAE/GYYnWTEn84R35WhJsMvuQ7QmLvNg6RkChY6POCT/YKe9NKwa1NqI1U+oA5RFzAaFtytvZCE3jtp+aR0brL7qaGfgxm6B7dEpGyhg0NcVCV7xMQNq2JxZTVdAr6lcsRGaAFulakmW3aNnmK+L35Wu8uW+OxNxwUuC6f3b4FVBa276FMuUTRfu7gc+k6kCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAAU5CjEyAoyTn7PgFpQD48ZNPuUsEQ19gzYgJvHMzFIoZ7jKBodjO5mCzWBcR7A4mpeAsdyiNBl2sTiZscSnNqxk61jVzP5Ba1D7XtOjjr7+3iqowrThj6BY40QqhYh/6BSY9fDzVZQiHnvlo6ZUM5kUK6OavZOovKlp5DIl5sGqoP0qAJnpQ4nhB2WVVsKfPlOXc+2KSsbJ23g9l8zaTMr+X0umlvfEKqyEl1Fa2L1dO0y/KFQ+ILmxcZLpRdq1hRAjd0quq9qGC8ucXhRWDg4hslVpau0da68g0aItWNez3mc5lB82b3dcZpFMzO41bgw7gvw10AvvTfQDqEYIuQ==","entity_name":"EXAMPLE COMPANY LTD","entity_code":"PSD_PICY_CBC!12345","entity_type":"PSD_PI","entity_address":"EXAMPLE COMPANY LTD, 5 SOME STREET","entity_town_city":"SOME CITY","entity_post_code":"1060","entity_country":"CY","entity_web_site":"www.example.com","services":[{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}],"attributes":[{"attributeType":"STRING","name":"STATUS","value":"closed"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Directory","API"],"typed_success_response_body":{"type":"object","properties":{"entity_country":{"type":"string"},"entity_certificate_public_key":{"type":"string"},"entity_code":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"CY":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}}},"entity_town_city":{"type":"string"},"entity_name":{"type":"string"},"entity_post_code":{"type":"string"},"entity_web_site":{"type":"string"},"entity_id":{"type":"string"},"entity_type":{"type":"string"},"certificate_authority_ca_owner_id":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"attributeType":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}},"entity_address":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyImageUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyImageUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","summary":"Delete Counterparty Image URL","description":"Delete image url of other bank account
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete image url of other bank account\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":[]},{"operation_id":"OBPv5.1.0-createBankAccountBalance","implemented_by":{"version":"OBPv5.1.0","function":"createBankAccountBalance"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances","summary":"Create Bank Account Balance","description":"Create a new Balance for a Bank Account.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nbalance_amount: 50.89
\nbalance_type: openingBooked
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbalance_amount: 50.89
\nbalance_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nbalance_type: openingBooked
\nbank_id: gh.29.uk
\n","description_markdown":"Create a new Balance for a Bank Account.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**balance_amount**](/glossary#): 50.89\n\n\n\n[**balance_type**](/glossary#balance_type): openingBooked\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**balance_amount**](/glossary#): 50.89\n\n\n\n[**balance_id**](/glossary#balance_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**balance_type**](/glossary#balance_type): openingBooked\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n","example_request_body":{"balance_type":"openingBooked","balance_amount":"50.89"},"success_response_body":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","balance_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","balance_type":"openingBooked","balance_amount":"50.89"},"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":["Account","Balance"],"typed_request_body":{"type":"object","properties":{"balance_amount":{"type":"string"},"balance_type":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"balance_amount":{"type":"string"},"bank_id":{"type":"string"},"balance_id":{"type":"string"},"account_id":{"type":"string"},"balance_type":{"type":"string"}}},"roles":[{"role":"CanCreateBankAccountBalance","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/balances","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateMyPersonalUserAttribute","implemented_by":{"version":"OBPv4.0.0","function":"updateMyPersonalUserAttribute"},"request_verb":"PUT","request_url":"/obp/v4.0.0/my/user/attributes/USER_ATTRIBUTE_ID","summary":"Update My Personal User Attribute","description":"Update My Personal User Attribute for current user by USER_ATTRIBUTE_ID
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","description_markdown":"Update My Personal User Attribute for current user by USER_ATTRIBUTE_ID\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[USER_ATTRIBUTE_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"BATTERY_LEVEL","type":"STRING","value":"90"},"success_response_body":{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","insert_date":"2026-03-16T21:00:25Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["User"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"name":{"type":"string"}}},"roles":[],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/user/attributes/USER_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteTransactionCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteTransactionCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID","summary":"Delete Transaction Cascade","description":"Delete a Transaction Cascade specified by TRANSACTION_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\n","description_markdown":"Delete a Transaction Cascade specified by TRANSACTION_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Transaction"],"roles":[{"role":"CanDeleteTransactionCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get Dynamic Endpoints.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv4.0.0-deleteBankAttribute","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankAttribute"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","summary":"Delete Bank Attribute","description":"Delete Bank Attribute
\nDelete a Bank Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ATTRIBUTE_ID: BANK_ATTRIBUTE_ID
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Bank Attribute\n\nDelete a Bank Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ATTRIBUTE_ID](/glossary#): BANK_ATTRIBUTE_ID\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Bank"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attributes/BANK_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteAtmAttribute","implemented_by":{"version":"OBPv5.1.0","function":"deleteAtmAttribute"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","summary":"Delete ATM Attribute","description":"Delete ATM Attribute
\nDelete a Atm Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ATTRIBUTE_ID: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete ATM Attribute\n\nDelete a Atm Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ATTRIBUTE_ID](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-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":["ATM"],"roles":[{"role":"CanDeleteAtmAttribute","requires_bank_id":true},{"role":"CanDeleteAtmAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"deleteDynamicResourceDoc"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","summary":"Delete Dynamic Resource Doc","description":"Delete a Dynamic Resource Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","description_markdown":"Delete a Dynamic Resource Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":["Dynamic-Resource-Doc"],"roles":[{"role":"CanDeleteDynamicResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC-RESOURCE-DOC-ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-revokeConsentAtBank","implemented_by":{"version":"OBPv5.1.0","function":"revokeConsentAtBank"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID","summary":"Revoke Consent at Bank","description":"Revoke Consent specified by CONSENT_ID
\nThere are a few reasons you might need to revoke an application’s access to a user’s account:
\n- The user explicitly wishes to revoke the application’s access
\n- You as the service provider have determined an application is compromised or malicious, and want to disable it
\n- etc.
OBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.
\nThe status of the token is changed to "REVOKED" so the next time the revoked client makes a request, their token will fail to validate.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"Revoke Consent specified by CONSENT_ID\n\nThere are a few reasons you might need to revoke an application’s access to a user’s account:\n - The user explicitly wishes to revoke the application’s access\n - You as the service provider have determined an application is compromised or malicious, and want to disable it\n - etc.\n\nOBP as a resource server stores access tokens in a database, then it is relatively easy to revoke some token that belongs to a particular user.\nThe status of the token is changed to \"REVOKED\" so the next time the revoked client makes a request, their token will fail to validate.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"REJECTED"},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"roles":[{"role":"CanRevokeConsentAtBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAtmSupportedLanguages","implemented_by":{"version":"OBPv4.0.0","function":"updateAtmSupportedLanguages"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/atms/ATM_ID/supported-languages","summary":"Update ATM Supported Languages","description":"Update ATM Supported Languages.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nsupported_languages: ["es","fr","de"]
\n","description_markdown":"Update ATM Supported Languages.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n","example_request_body":{"supported_languages":["es","fr","de"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","supported_languages":["es","fr","de"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"supported_languages":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"supported_languages":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/supported-languages","connector_methods":[]},{"operation_id":"OBPv4.0.0-getUserCustomerLinksByUserId","implemented_by":{"version":"OBPv4.0.0","function":"getUserCustomerLinksByUserId"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/user_customer_links/users/USER_ID","summary":"Get User Customer Links by User","description":"Get User Customer Links by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Get User Customer Links by USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\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[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_inserted**](/glossary#date_inserted): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**user_customer_link_id**](/glossary#user_customer_link_id): \n\n\n\n[**user_customer_links**](/glossary#user_customer_links): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"user_customer_links":[{"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","date_inserted":"1099-12-31T21:00:00Z","is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"user_customer_links":{"type":"array","items":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"user_id":{"type":"string"},"date_inserted":{"type":"string","format":"date-time"}}}}}},"roles":[{"role":"CanGetUserCustomerLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user_customer_links/users/USER_ID","connector_methods":[]},{"operation_id":"OBPv1.4.0-getTransactionRequestTypes","implemented_by":{"version":"OBPv1.4.0","function":"getTransactionRequestTypes"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","summary":"Get Transaction Request Types for Account","description":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
\nThese are the ways this API Server can create a Transaction via a Transaction Request
\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)
A Transaction Request Type internally determines:
\nFor instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.
\nThis approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\n\ncurrency: EUR
\n\n\nvalue: 5987953
\n","description_markdown":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.\n\nThese are the ways this API Server can create a Transaction via a Transaction Request\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)\n\n A Transaction Request Type internally determines:\n\n * the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,\n * the type of security challenge that may be be raised before the Transaction Request proceeds, and\n * the threshold of that challenge.\n\n For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.\n\n This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.\n \n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**transaction_request_types**](/glossary#transaction_request_types): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_request_types":[{"value":"10","charge":{"summary":"The bank fixed charge","value":{"currency":"EUR","amount":"0"}}}]},"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-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","Please specify a valid value for CURRENCY of your Bank Account. ","Current user does not have access to the view ","account not found at bank","user does not have access to owner view","OBP-40018: Sorry, Transaction Requests are not enabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"charge":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"}}},"value":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteWebUiProps","implemented_by":{"version":"OBPv3.1.0","function":"deleteWebUiProps"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/management/webui_props/WEB_UI_PROPS_ID","summary":"Delete WebUiProps","description":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[WEB_UI_PROPS_ID](/glossary#web_ui_props_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":["WebUi-Props"],"roles":[{"role":"CanDeleteWebUiProps","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/webui_props/WEB_UI_PROPS_ID","connector_methods":[]},{"operation_id":"OBPv3.0.0-getPrivateAccountIdsbyBankId","implemented_by":{"version":"OBPv3.0.0","function":"getPrivateAccountIdsbyBankId"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/account_ids/private","summary":"Get Accounts at Bank (IDs only)","description":"Returns only the list of accounts ids at BANK_ID that the user has access to.
\nEach account must have at least one private View.
\nFor each account the API returns its account ID.
\nIf you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n","description_markdown":"Returns only the list of accounts ids at BANK_ID that the user has access to.\n\nEach account must have at least one private View.\n\nFor each account the API returns its account ID.\n\nIf you want to see more information on the Views, use the Account Detail call.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**accounts**](/glossary#accounts): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n","success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"}]},"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-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/account_ids/private","connector_methods":[]},{"operation_id":"OBPv5.1.0-createCounterpartyLimit","implemented_by":{"version":"OBPv5.1.0","function":"createCounterpartyLimit"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","summary":"Create Counterparty Limit","description":"Create limits (for single or recurring payments) for a counterparty specified by the COUNTERPARTY_ID.
\nUsing this endpoint, we can attach a limit record to a Counterparty referenced by its counterparty_id (a UUID).
\nFor more information on Counterparty Limits, see here
\nFor an introduction to Counterparties in OBP, see here
\nYou can automate the process of creating counterparty limits and consents for VRP with this endpoint.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON request body fields:
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","description_markdown":"Create limits (for single or recurring payments) for a counterparty specified by the COUNTERPARTY_ID.\n\nUsing this endpoint, we can attach a limit record to a Counterparty referenced by its counterparty_id (a UUID).\n\nFor more information on Counterparty Limits, see [here](/glossary#Counterparty-Limits)\n\nFor an introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nYou can automate the process of creating counterparty limits and consents for VRP with this endpoint.\n\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_limit_id**](/glossary#counterparty_limit_id): abc9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","example_request_body":{"currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100},"success_response_body":{"counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Counterparty-Limits"],"typed_request_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","connector_methods":[]},{"operation_id":"OBPv4.0.0-addConsentUser","implemented_by":{"version":"OBPv4.0.0","function":"addConsentUser"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/consents/CONSENT_ID/user-update-request","summary":"Add User to a Consent","description":"This endpoint is used to add the User of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint is used to add the User of Consent.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"user_id":"ed7a7c01-db37-45cc-ba12-0ae8891c195c"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"AUTHORISED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-35024: The Consent's User is already added.","OBP-10001: Incorrect json format.","OBP-35001: Consent not found by CONSENT_ID. ","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/user-update-request","connector_methods":[]},{"operation_id":"OBPv5.0.0-createUserAuthContextUpdateRequest","implemented_by":{"version":"OBPv5.0.0","function":"createUserAuthContextUpdateRequest"},"request_verb":"POST","request_url":"/obp/v5.0.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD","summary":"Create User Auth Context Update Request","description":"Create User Auth Context Update Request.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
URL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON request body fields:
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nkey: CustomerNumber
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\n","description_markdown":"Create User Auth Context Update Request.\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\" or \"EMAIL\". \"EMAIL\" is used for testing purposes.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SCA_METHOD](/glossary#sca_method): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**user_auth_context_update_id**](/glossary#user_auth_context_update_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"key":"CUSTOMER_NUMBER","value":"78987432"},"success_response_body":{"user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","status":"INITIATED","consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"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-10001: Incorrect json format.","OBP-30053: Could not insert the UserAuthContext","OBP-50000: Unknown Error."],"tags":["User"],"typed_request_body":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD","connector_methods":[]},{"operation_id":"OBPv4.0.0-createProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createProductAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attribute","summary":"Create Product Attribute","description":"Create Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nTypical product attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nis_active: false
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Create Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nTypical product attributes might be:\n\nISIN (for International bonds)\nVKN (for German bonds)\nREDCODE (markit short code for credit derivative)\nLOAN_ID (e.g. used for Anacredit reporting)\n\nISSUE_DATE (When the bond was issued in the market)\nMATURITY_DATE (End of life time of a product)\nTRADABLE\n\nSee [FPML](http://www.fpml.org/) for more examples.\n\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":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":["Product"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanCreateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute","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=2026-03-16T21:00:23.790Z&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=2026-03-16T21:00:23.790Z
\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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\napp_name: appNameBank
\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=2026-03-16T21:00:23.790Z&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=2026-03-16T21:00:23.790Z\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\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":[]},{"operation_id":"OBPv4.0.0-deleteCardAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"deleteCardAttributeDefinition"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/card","summary":"Delete Card Attribute Definition","description":"Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete Card Attribute Definition by ATTRIBUTE_DEFINITION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_DEFINITION_ID](/glossary#attribute_definition_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Card"],"roles":[{"role":"CanDeleteCardAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/ATTRIBUTE_DEFINITION_ID/card","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerBranch","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerBranch"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/branch","summary":"Update the Branch of a Customer","description":"Update the Branch of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the Branch of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"branch_id":"123"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"branch_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerIdentity","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/branch","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteRegulatedEntityAttribute","implemented_by":{"version":"OBPv5.1.0","function":"deleteRegulatedEntityAttribute"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","summary":"Delete Regulated Entity Attribute","description":"Delete a Regulated Entity Attribute specified by REGULATED_ENTITY_ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\n","description_markdown":"Delete a Regulated Entity Attribute specified by REGULATED_ENTITY_ATTRIBUTE_ID.\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ATTRIBUTE_ID](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Directory","API"],"roles":[{"role":"CanDeleteRegulatedEntityAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getEntitlementsAndPermissions","implemented_by":{"version":"OBPv5.1.0","function":"getEntitlementsAndPermissions"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/USER_ID/entitlements-and-permissions","summary":"Get Entitlements and Permissions for a User","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\n\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20057: User not found by userId.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}},"roles":[{"role":"CanGetEntitlementsForAnyUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/entitlements-and-permissions","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"getKycMedia"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_media","summary":"Get KYC Media for a customer","description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\ntype:
\nurl: http://www.example.com/id-docs/123/image.png
\n","description_markdown":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**medias**](/glossary#medias): \n\n\n\n[**relates_to_kyc_check_id**](/glossary#relates_to_kyc_check_id): \n\n\n\n[**relates_to_kyc_document_id**](/glossary#relates_to_kyc_document_id): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n","success_response_body":{"medias":[{"bank_id":"gh.29.uk","customer_id":"PlaceholderString","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","url":"PlaceholderString","date":"1099-12-31T21:00:00Z","relates_to_kyc_document_id":"PlaceholderString","relates_to_kyc_check_id":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"medias":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"type":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"relates_to_kyc_document_id":{"type":"string"},"id":{"type":"string"},"relates_to_kyc_check_id":{"type":"string"},"url":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycMedia","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_media","connector_methods":[]},{"operation_id":"OBPv5.1.0-createConsentImplicit","implemented_by":{"version":"OBPv5.1.0","function":"createConsentImplicit"},"request_verb":"POST","request_url":"/obp/v5.1.0/my/consents/IMPLICIT","summary":"Create Consent (IMPLICIT)","description":"This endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS","EMAIL" or "IMPLICIT". "EMAIL" is used for testing purposes. OBP mapped mode "IMPLICIT" is "EMAIL".
\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n}
URL Parameters:
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nview_id: owner
\n\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nvalid_from: 2020-01-27
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\",\"EMAIL\" or \"IMPLICIT\". \"EMAIL\" is used for testing purposes. OBP mapped mode \"IMPLICIT\" is \"EMAIL\".\nOther mode, bank can decide it in the connector method 'getConsentImplicitSCA'.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.\nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.\nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nExample 1:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n}\n\n\n**URL Parameters:**\n\n[IMPLICIT](/glossary#): IMPLICIT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**everything**](/glossary#everything): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[**views**](/glossary#views): \n\n\n\n[consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[time_to_live](/glossary#time_to_live): \n\n\n\n[valid_from](/glossary#valid_from): 2020-01-27\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","valid_from":"2026-03-16T21:00:23Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"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-10001: Incorrect json format.","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/consents/IMPLICIT","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyCorporateLocation"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Update Counterparty Corporate Location","description":"Update the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update the geolocation of the counterparty's registered address\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"corporate_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating a corporate location","Coordinates not possible","Corporate Location cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCustomersByLegalName","implemented_by":{"version":"OBPv5.1.0","function":"getCustomersByLegalName"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/customers/legal-name","summary":"Get Customers by Legal Name","description":"Gets the Customers specified by Legal Name.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nlegal_name: Eveline Tripman
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Gets the Customers specified by Legal Name.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"legal_name":"Eveline Tripman"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"legal_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanGetCustomer","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/legal-name","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateProductFee","implemented_by":{"version":"OBPv4.0.0","function":"updateProductFee"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","summary":"Update Product Fee","description":"Update Product Fee.
\nUpdate one Product Fee by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nPRODUCT_FEE_ID: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Product Fee. \n\nUpdate one Product Fee by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n[PRODUCT_FEE_ID](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"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":["Product"],"typed_request_body":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"roles":[{"role":"CanUpdateProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/fees/PRODUCT_FEE_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getCustomerAccountLinkById","implemented_by":{"version":"OBPv5.0.0","function":"getCustomerAccountLinkById"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","summary":"Get Customer Account Link by Id","description":"Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncustomer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nrelationship_type: Owner
\n","description_markdown":"Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ACCOUNT_LINK_ID](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_account_link_id**](/glossary#): xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**relationship_type**](/glossary#): Owner\n\n\n","success_response_body":{"customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","relationship_type":"Owner"},"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":["Customer"],"typed_success_response_body":{"type":"object","properties":{"customer_account_link_id":{"type":"string"},"customer_id":{"type":"string"},"bank_id":{"type":"string"},"account_id":{"type":"string"},"relationship_type":{"type":"string"}}},"roles":[{"role":"CanGetCustomerAccountLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer-account-links/CUSTOMER_ACCOUNT_LINK_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-createAtm","implemented_by":{"version":"OBPv5.1.0","function":"createAtm"},"request_verb":"POST","request_url":"/obp/v5.1.0/banks/BANK_ID/atms","summary":"Create ATM","description":"Create ATM.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nJSON response body fields:
\naccessibility_features: ["ATAC","ATAD"]
\n\natm_attribute_id: xxaf2a-9a0f-4bfa-b30b-9003aa467f51
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\n\n\nbank_id: gh.29.uk
\nbranch_identification: branch_identification
\ncash_withdrawal_international_fee:
\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\nhas_deposit_capability: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlocation_categories: location_categories
\nlongitude: -77.0364
\nmeta:
\nminimum_withdrawal: minimum_withdrawal
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nnotes: notes
\n\n\n\n\nservices: [{"CY":["PS_010","PS_020","PS_03C","PS_04C"]}]
\nsite_identification: site_identification
\nsite_name: site_name
\n\n\nsupported_currencies: ["EUR","MXN","USD"]
\nsupported_languages: ["es","fr","de"]
\n\n\ntype:
\nvalue: 5987953
\n\nattributes: attribute value in form of (name, value)
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_active: false
\n","description_markdown":"Create ATM.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atm_type**](/glossary#): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accessibility_features**](/glossary#accessibility_features): [\"ATAC\",\"ATAD\"]\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**atm_attribute_id**](/glossary#): xxaf2a-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**atm_type**](/glossary#): \n\n\n\n[**balance_inquiry_fee**](/glossary#): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_identification**](/glossary#): branch_identification\n\n\n\n[**cash_withdrawal_international_fee**](/glossary#): \n\n\n\n[**cash_withdrawal_national_fee**](/glossary#): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**has_deposit_capability**](/glossary#): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**located_at**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**location_categories**](/glossary#): location_categories\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**minimum_withdrawal**](/glossary#): minimum_withdrawal\n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**notes**](/glossary#): notes\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone**](/glossary#phone): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**services**](/glossary#services): [{\"CY\":[\"PS_010\",\"PS_020\",\"PS_03C\",\"PS_04C\"]}]\n\n\n\n[**site_identification**](/glossary#): site_identification\n\n\n\n[**site_name**](/glossary#): site_name\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**supported_currencies**](/glossary#supported_currencies): [\"EUR\",\"MXN\",\"USD\"]\n\n\n\n[**supported_languages**](/glossary#supported_languages): [\"es\",\"fr\",\"de\"]\n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":""},"success_response_body":{"id":"atme-9a0f-4bfa-b30b-9003aa467f51","bank_id":"gh.29.uk","name":"Atm by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"},"is_accessible":"false","located_at":"","more_info":"More information about this fee","has_deposit_capability":"false","supported_languages":["es","fr","de"],"services":["ATBP","ATBA"],"accessibility_features":["ATAC","ATAD"],"supported_currencies":["EUR","MXN","USD"],"notes":["String1","String2"],"location_categories":["ATBI","ATBE"],"minimum_withdrawal":"5","branch_identification":"","site_identification":"","site_name":"","cash_withdrawal_national_fee":"","cash_withdrawal_international_fee":"","balance_inquiry_fee":"","atm_type":"","phone":"","attributes":[{"bank_id":"gh.29.uk","atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","atm_attribute_id":"xxaf2a-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","type":"","value":"5987953","is_active":false}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"site_name":{"type":"string"},"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"site_identification":{"type":"string"},"atm_type":{"type":"string"},"accessibility_features":{"type":"array","items":{"type":"string"}},"supported_currencies":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"cash_withdrawal_international_fee":{"type":"string"},"has_deposit_capability":{"type":"string"},"supported_languages":{"type":"array","items":{"type":"string"}},"balance_inquiry_fee":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"notes":{"type":"array","items":{"type":"string"}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"phone":{"type":"string"},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"located_at":{"type":"string"},"more_info":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"county":{"type":"string"}}},"minimum_withdrawal":{"type":"string"},"branch_identification":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"bank_id":{"type":"string"},"name":{"type":"string"},"atm_attribute_id":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"atm_id":{"type":"string"}}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"services":{"type":"array","items":{"type":"string"}},"cash_withdrawal_national_fee":{"type":"string"},"location_categories":{"type":"array","items":{"type":"string"}}}},"roles":[{"role":"CanCreateAtm","requires_bank_id":true},{"role":"CanCreateAtmAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms","connector_methods":[]},{"operation_id":"OBPv1.4.0-addCustomerMessage","implemented_by":{"version":"OBPv1.4.0","function":"addCustomerMessage"},"request_verb":"POST","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","summary":"Create Customer Message","description":"Create a message for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_department: Open Bank
\nfrom_person: Tom
\nmessage: 123456
\nJSON response body fields:
\n\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"message":"String","from_department":"String","from_person":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"from_person":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","connector_methods":[]},{"operation_id":"OBPv1.4.0-getResourceDocsSwagger","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsSwagger"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/swagger","summary":"Get Swagger documentation","description":"Returns documentation about the RESTful resources on this server in Swagger format.
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
\n(All endpoints are given one or more tags which for used in grouping)
\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
\n(Each endpoint is implemented in the OBP Scala code by a 'function')
\nSee the Resource Doc endpoint for more information.
\nNote: Resource Docs are cached, TTL is 3600 seconds
\nFollowing are more examples:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Returns documentation about the RESTful resources on this server in Swagger format.\n\nAPI_VERSION is the version you want documentation about e.g. v3.0.0\n\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank\n\n(All endpoints are given one or more tags which for used in grouping)\n\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById\n\n(Each endpoint is implemented in the OBP Scala code by a 'function')\n\nSee the Resource Doc endpoint for more information.\n\n Note: Resource Docs are cached, TTL is 3600 seconds\n \nFollowing are more examples:\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById\n\n \n\nUser Authentication is Optional. The User need not be logged in.\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","error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllDynamicResourceDocs","implemented_by":{"version":"OBPv4.0.0","function":"getAllDynamicResourceDocs"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-resource-docs","summary":"Get all Dynamic Resource Docs","description":"Get all Dynamic Resource Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Get all Dynamic Resource Docs.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","success_response_body":{"dynamic-resource-docs":[{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}}]},"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-Resource-Doc"],"typed_success_response_body":{"type":"object","properties":{"dynamic-resource-docs":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllDynamicResourceDocs","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteNonPersonalUserAttribute","implemented_by":{"version":"OBPv5.1.0","function":"deleteNonPersonalUserAttribute"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes/USER_ATTRIBUTE_ID","summary":"Delete Non Personal User Attribute","description":"Delete the Non Personal User Attribute specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete the Non Personal User Attribute specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[USER_ATTRIBUTE_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\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","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["User"],"roles":[{"role":"CanDeleteNonPersonalUserAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes/USER_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-callsLimit","implemented_by":{"version":"OBPv4.0.0","function":"callsLimit"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/consumers/CONSUMER_ID/consumer/call-limits","summary":"Set Rate Limits / Call Limits per Consumer","description":"Set the API rate limits / call limits for a Consumer:
\nRate limiting can be set:
\nPer Second
\nPer Minute
\nPer Hour
\nPer Week
\nPer Month
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nfrom_date: 1100-01-01T01:01:01.000Z
\n\n\n\n\n\n\nto_date: 1100-01-01T01:01:01.000Z
\napi_name: api_name
\n\nbank_id: gh.29.uk
\n","description_markdown":"Set the API rate limits / call limits for a Consumer:\n\nRate limiting can be set:\n\nPer Second\nPer Minute\nPer Hour\nPer Week\nPer Month\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**from_date**](/glossary#from_date): 1100-01-01T01:01:01.000Z\n\n\n\n[**per_day_call_limit**](/glossary#per_day_call_limit): \n\n\n\n[**per_hour_call_limit**](/glossary#per_hour_call_limit): \n\n\n\n[**per_minute_call_limit**](/glossary#per_minute_call_limit): \n\n\n\n[**per_month_call_limit**](/glossary#per_month_call_limit): \n\n\n\n[**per_second_call_limit**](/glossary#per_second_call_limit): 10\n\n\n\n[**per_week_call_limit**](/glossary#per_week_call_limit): \n\n\n\n[**to_date**](/glossary#to_date): 1100-01-01T01:01:01.000Z\n\n\n\n[api_name](/glossary#): api_name\n\n\n\n[api_version](/glossary#api_version): \n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n","example_request_body":{"from_date":"1099-12-31T21:00:00Z","to_date":"1099-12-31T21:00:00Z","per_second_call_limit":"-1","per_minute_call_limit":"-1","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1"},"success_response_body":{"from_date":"1099-12-31T21:00:00Z","to_date":"1099-12-31T21:00:00Z","per_second_call_limit":"-1","per_minute_call_limit":"-1","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30023: Cannot update Consumer ","OBP-50000: Unknown Error."],"tags":["Consumer","Rate-Limits"],"typed_request_body":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"to_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"from_date":{"type":"string","format":"date-time"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}},"roles":[{"role":"CanSetCallLimits","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/call-limits","connector_methods":[]},{"operation_id":"OBPv2.0.0-addEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"addEntitlement"},"request_verb":"POST","request_url":"/obp/v2.0.0/users/USER_ID/entitlements","summary":"Add Entitlement for a User","description":"Create Entitlement. Grant Role to User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","description_markdown":"Create Entitlement. Grant Role to User.\n\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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 request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","example_request_body":{"bank_id":"gh.29.uk","role_name":"CanCreateBranch"},"success_response_body":{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20005: User not found. Please specify a valid value for USER_ID.","OBP-20050: Current User is not a Super Admin!","OBP-10001: Incorrect json format.","OBP-10007: Incorrect Role name:","OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.","OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.","OBP-30216: Entitlement already exists for the user.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}},"roles":[{"role":"CanCreateEntitlementAtOneBank","requires_bank_id":true},{"role":"CanCreateEntitlementAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv5.1.0-getBankAccountsBalancesThroughView","implemented_by":{"version":"OBPv5.1.0","function":"getBankAccountsBalancesThroughView"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/views/VIEW_ID/balances","summary":"Get Account Balances by BANK_ID through the VIEW_ID","description":"Get the Balances for the Account specified by BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","description_markdown":"Get the Balances for the Account specified by BANK_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balances**](/glossary#): balances\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"accounts":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_routings":[{"scheme":"accountNumber","address":"123456"}],"label":"My Account","balances":[{"type":"","currency":"EUR","amount":"10"}]}]},"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-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/views/VIEW_ID/balances","connector_methods":[]},{"operation_id":"OBPv5.0.0-getConsentRequest","implemented_by":{"version":"OBPv5.0.0","function":"getConsentRequest"},"request_verb":"GET","request_url":"/obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID","summary":"Get Consent Request","description":"User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\npayload: payload
\n","description_markdown":"User Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[CONSENT_REQUEST_ID](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_request_id**](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**payload**](/glossary#payload): payload\n\n\n","success_response_body":{"consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","payload":{"everything":false,"account_access":[{"account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"view_id":"owner"}],"phone_number":"+44 07972 444 876","valid_from":"2022-06-14T12:42:00Z","time_to_live":3600},"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-35020: You exceeded max value of time to live of consents.","OBP-20306: PEM Encoded Certificate cannot be found at request header.","OBP-20300: PEM Encoded Certificate issue.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"consumer_id":{"type":"string"},"consent_request_id":{"type":"string"},"payload":{"type":"object","properties":{"phone_number":{"type":"string"},"everything":{"type":"boolean"},"account_access":{"type":"array","items":{"type":"object","properties":{"account_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}},"view_id":{"type":"string"}}}},"valid_from":{"type":"string"},"time_to_live":{"type":"integer"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_NAME: Favourites
\nJSON response body fields:
\napi_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\napi_collection_name: Favourites
\ndescription: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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":"OBPv3.1.0-createWebUiProps","implemented_by":{"version":"OBPv3.1.0","function":"createWebUiProps"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/webui_props","summary":"Create WebUiProps","description":"Create a WebUiProps.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nExplaination of Fields:
\nThe line break and double quotations should do escape, example:
\n\n{"name": "webui_some", "value": "this value\nhave "line break" and double quotations."}\n\nshould do escape like this:
\n\n{"name": "webui_some", "value": "this value\\nhave \\"line break\\" and double quotations."}\n\nInsert image examples:
\n// set width=100 and height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}\n\n// only set height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}\n\n// only width=20%\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}\n\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","description_markdown":"Create a WebUiProps.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nExplaination of Fields:\n\n* name is required String value\n* value is required String value\n\nThe line break and double quotations should do escape, example:\n\n```\n\n{\"name\": \"webui_some\", \"value\": \"this value\nhave \"line break\" and double quotations.\"}\n\n```\nshould do escape like this:\n\n```\n\n{\"name\": \"webui_some\", \"value\": \"this value\\nhave \\\"line break\\\" and double quotations.\"}\n\n```\n\nInsert image examples:\n\n```\n// set width=100 and height=50\n{\"name\": \"webui_some_pic\", \"value\": \"here is a picture \"}\n\n// only set height=50\n{\"name\": \"webui_some_pic\", \"value\": \"here is a picture \"}\n\n// only width=20%\n{\"name\": \"webui_some_pic\", \"value\": \"here is a picture \"}\n\n```\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"webui_api_explorer_url","value":"https://apiexplorer.openbankproject.com"},"success_response_body":{"name":"webui_api_explorer_url","value":"https://apiexplorer.openbankproject.com","web_ui_props_id":"some-web-ui-props-id"},"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":["WebUi-Props"],"typed_request_body":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateWebUiProps","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/webui_props","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteUserAuthContextById","implemented_by":{"version":"OBPv3.1.0","function":"deleteUserAuthContextById"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/users/USER_ID/auth-context/USER_AUTH_CONTEXT_ID","summary":"Delete User Auth Context","description":"Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[USER_AUTH_CONTEXT_ID](/glossary#user_auth_context_id): \n\n\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","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":["User"],"roles":[{"role":"CanDeleteUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/auth-context/USER_AUTH_CONTEXT_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 (RabbitMq) 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: rest_vMar2019, stored_procedure_vDec2019 ...
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nCONNECTOR: CONNECTOR
\nJSON response body fields:
\n\n\ndescription: Description of the object. 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 (RabbitMq) 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`: rest_vMar2019, stored_procedure_vDec2019 ...\n \n\nUser Authentication is Optional. The User need not be logged in.\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): Description of the object. 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":"rest_vMar2019","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-30211: Invalid Connector. Please specify a valid value for CONNECTOR.","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"}}}},"requiredFieldInfo":{"type":"object","properties":{"data.bankId":{"type":"array","items":{"type":"string"}}}},"inbound_topic":{"type":"string"},"outbound_topic":{"type":"string"},"outboundAvroSchema":{"type":"object","properties":{"jsonString":{"type":"string"}}},"message_format":{"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":[]},{"operation_id":"OBPv4.0.0-getTransactionAttributes","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionAttributes"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes","summary":"Get Transaction Attributes","description":"Get Transaction Attributes
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Attributes\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction"],"typed_success_response_body":{"type":"object","properties":{"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}}}},"roles":[{"role":"CanGetTransactionAttributesAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transactions/TRANSACTION_ID/attributes","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv5.0.0-getMyCustomersAtAnyBank","implemented_by":{"version":"OBPv5.0.0","function":"getMyCustomersAtAnyBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/my/customers","summary":"Get My Customers","description":"Gets all Customers that are linked to me.
\nAuthentication via OAuth is required.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n\nrelationship_status: single
\n\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Gets all Customers that are linked to me.\n\nAuthentication via OAuth is required.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error."],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"customer_id":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/customers","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","description_markdown":"Get all Authentication Type Validations.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv1.2.1-deleteCounterpartyCorporateLocation","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyCorporateLocation"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","summary":"Delete Counterparty Corporate Location","description":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","Corporate Location cannot be deleted","Delete not completed","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyPrivateAlias","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyPrivateAlias"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","summary":"Delete Counterparty Private Alias","description":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.
\nUser Authentication is Optional. The User need not be logged in.
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Optional. The User need not be logged in.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting the private alias","Alias cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyUrl"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Update url of other bank account","description":"A url which represents the counterparty (home page url etc.)
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"URL":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","URL cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv3.1.0-updateCustomerMobileNumber","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerMobileNumber"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/mobile-number","summary":"Update the mobile number of a Customer","description":"Update the mobile number of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\ndependants: 1
\ndob_of_dependants: [2019-09-08, 2017-07-12]
\n\nemployment_status: worker
\n\nhighest_education_attained: Master
\nkyc_status: false
\nlast_ok_date: 2025-03-16T21:00:22.318Z
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\nname_suffix: Sr
\n\nrelationship_status: single
\n\ntitle: Dr.
\nurl: http://www.example.com/id-docs/123/image.png
\n\n\n","description_markdown":"Update the mobile number of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**dependants**](/glossary#): 1\n\n\n\n[**dob_of_dependants**](/glossary#dob_of_dependants): [2019-09-08, 2017-07-12]\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**employment_status**](/glossary#): worker\n\n\n\n[**face_image**](/glossary#face_image): \n\n\n\n[**highest_education_attained**](/glossary#): Master\n\n\n\n[**kyc_status**](/glossary#): false\n\n\n\n[**last_ok_date**](/glossary#last_ok_date): 2025-03-16T21:00:22.318Z\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name_suffix**](/glossary#): Sr\n\n\n\n[**rating**](/glossary#): \n\n\n\n[**relationship_status**](/glossary#): single\n\n\n\n[**source**](/glossary#): \n\n\n\n[**title**](/glossary#): Dr.\n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[credit_limit](/glossary#credit_limit): \n\n\n\n[credit_rating](/glossary#credit_rating): \n\n\n","example_request_body":{"mobile_phone_number":"+381631954907"},"success_response_body":{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","legal_name":"Eveline Tripman","mobile_phone_number":"+44 07972 444 876","email":"felixsmith@example.com","face_image":{"url":"www.openbankproject","date":"1099-12-31T21:00:00Z"},"date_of_birth":"1099-12-31T21:00:00Z","relationship_status":"single","dependants":1,"dob_of_dependants":["1099-12-31T21:00:00Z"],"credit_rating":{"rating":"OBP","source":"OBP"},"credit_limit":{"currency":"EUR","amount":"0"},"highest_education_attained":"Master","employment_status":"worker","kyc_status":false,"last_ok_date":"2025-03-16T21:00:23Z","title":"Dr.","branch_id":"DERBY6","name_suffix":"Sr"},"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":["Customer"],"typed_request_body":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"dependants":{"type":"integer"},"date_of_birth":{"type":"string","format":"date-time"},"credit_limit":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"employment_status":{"type":"string"},"email":{"type":"string"},"last_ok_date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"relationship_status":{"type":"string"},"face_image":{"type":"object","properties":{"url":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"bank_id":{"type":"string"},"highest_education_attained":{"type":"string"},"customer_number":{"type":"string"},"credit_rating":{"type":"object","properties":{"rating":{"type":"string"},"source":{"type":"string"}}},"name_suffix":{"type":"string"},"legal_name":{"type":"string"},"dob_of_dependants":{"type":"array","items":{"type":"string","format":"date-time"}},"title":{"type":"string"},"branch_id":{"type":"string"},"mobile_phone_number":{"type":"string"},"kyc_status":{"type":"boolean"}}},"roles":[{"role":"CanUpdateCustomerMobilePhoneNumber","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/mobile-number","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAllDynamicMessageDocs","implemented_by":{"version":"OBPv4.0.0","function":"getAllDynamicMessageDocs"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/dynamic-message-docs","summary":"Get all Dynamic Message Docs","description":"Get all Dynamic Message Docs.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Get all Dynamic Message Docs.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","success_response_body":{"dynamic-message-docs":[{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","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":["Dynamic-Message-Doc"],"typed_success_response_body":{"type":"object","properties":{"dynamic-message-docs":{"type":"array","items":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}}}}},"roles":[{"role":"CanGetAllDynamicMessageDocs","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-message-docs","connector_methods":[]},{"operation_id":"OBPv5.1.0-getConsumer","implemented_by":{"version":"OBPv5.1.0","function":"getConsumer"},"request_verb":"GET","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID","summary":"Get Consumer","description":"Get the Consumer specified by CONSUMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Get the Consumer specified by CONSUMER_ID.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"consumer_id":1213,"app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-50000: Unknown Error."],"tags":["Consumer"],"typed_success_response_body":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}},"roles":[{"role":"CanGetConsumers","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateConsentStatus","implemented_by":{"version":"OBPv4.0.0","function":"updateConsentStatus"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/consents/CONSENT_ID","summary":"Update Consent Status","description":"This endpoint is used to update the Status of Consent.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"This endpoint is used to update the Status of Consent.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"status":"AUTHORISED"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"AUTHORISED"},"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-10001: Incorrect json format.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)"],"typed_request_body":{"type":"object","properties":{"status":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-getServerJWK","implemented_by":{"version":"OBPv3.1.0","function":"getServerJWK"},"request_verb":"GET","request_url":"/obp/v3.1.0/certs","summary":"Get JSON Web Key (JWK)","description":"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.
User Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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":[]},{"operation_id":"OBPv4.0.0-createDynamicResourceDoc","implemented_by":{"version":"OBPv4.0.0","function":"createDynamicResourceDoc"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/dynamic-resource-docs","summary":"Create Dynamic Resource Doc","description":"Create a Dynamic Resource Doc.
\nThe connector_method_body is URL-encoded format String
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nname: ACCOUNT_MANAGEMENT_FEE
\nroles: CanCreateMyUser
\n\ntags: Create-My-User
\n","description_markdown":"Create a Dynamic Resource Doc.\n\nThe connector_method_body is URL-encoded format String\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**roles**](/glossary#roles): CanCreateMyUser\n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n","example_request_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"success_response_body":{"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: ,OBP-10001: Incorrect json format.","description":"Create one User","tags":"Create-My-User","dynamic_resource_doc_id":"vce035ca-9a0f-4bfa-b30b-9003aa467f51","request_verb":"POST","method_body":"%20%20%20%20val%20Some(resourceDoc)%20%3D%20callContext.resourceDocument%0A%20%20%20%20val%20hasRequestBody%20%3D%20request.body.isDefined%0A%0A%20%20%20%20%2F%2F%20get%20Path%20Parameters%2C%20example%3A%0A%20%20%20%20%2F%2F%20if%20the%20requestUrl%20of%20resourceDoc%20is%20%2Fhello%2Fbanks%2FBANK_ID%2Fworld%0A%20%20%20%20%2F%2F%20the%20request%20path%20is%20%2Fhello%2Fbanks%2Fbank_x%2Fworld%0A%20%20%20%20%2F%2FpathParams.get(%22BANK_ID%22)%20will%20get%20Option(%22bank_x%22)%20value%0A%0A%20%20%20%20val%20myUserId%20%3D%20pathParams(%22MY_USER_ID%22)%0A%0A%0A%20%20%20%20val%20requestEntity%20%3D%20request.json%20match%20%7B%0A%20%20%20%20%20%20case%20Full(zson)%20%3D%3E%0A%20%20%20%20%20%20%20%20try%20%7B%0A%20%20%20%20%20%20%20%20%20%20zson.extract%5BRequestRootJsonClass%5D%0A%20%20%20%20%20%20%20%20%7D%20catch%20%7B%0A%20%20%20%20%20%20%20%20%20%20case%20e%3A%20MappingException%20%3D%3E%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidJsonFormat%20%24%7Be.msg%7D%22))%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20case%20_%3A%20EmptyBox%20%3D%3E%0A%20%20%20%20%20%20%20%20return%20Full(errorJsonResponse(s%22%24InvalidRequestPayload%20Current%20request%20has%20no%20payload%22))%0A%20%20%20%20%7D%0A%0A%0A%20%20%20%20%2F%2F%20please%20add%20business%20logic%20here%0A%20%20%20%20val%20responseBody%3AResponseRootJsonClass%20%3D%20ResponseRootJsonClass(s%22%24%7BmyUserId%7D_from_path%22%2C%20requestEntity.name%2C%20requestEntity.age%2C%20requestEntity.hobby)%0A%20%20%20%20Future.successful%20%7B%0A%20%20%20%20%20%20(responseBody%2C%20HttpCode.%60200%60(callContext.callContext))%0A%20%20%20%20%7D","roles":"CanCreateMyUser","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"request_url":"/my_user/MY_USER_ID","bank_id":"gh.29.uk","partial_function_name":"createUser","summary":"Create My User","success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"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-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tags":{"type":"string"},"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"bank_id":{"type":"string"},"partial_function_name":{"type":"string"},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"roles":{"type":"string"},"dynamic_resource_doc_id":{"type":"string"},"summary":{"type":"string"},"request_url":{"type":"string"},"description":{"type":"string"},"method_body":{"type":"string"},"error_response_bodies":{"type":"string"}}},"roles":[{"role":"CanCreateDynamicResourceDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteBankLevelEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"deleteBankLevelEndpointMapping"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","summary":"Delete Bank Level Endpoint Mapping","description":"Delete a Bank Level Endpoint Mapping.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nENDPOINT_MAPPING_ID: ENDPOINT_MAPPING_ID
\nJSON response body fields:
\n","description_markdown":"Delete a Bank Level Endpoint Mapping.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[ENDPOINT_MAPPING_ID](/glossary#): ENDPOINT_MAPPING_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n","success_response_body":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":["Endpoint-Mapping"],"roles":[{"role":"CanDeleteBankLevelEndpointMapping","requires_bank_id":true},{"role":"CanDeleteEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateAtmNotes","implemented_by":{"version":"OBPv4.0.0","function":"updateAtmNotes"},"request_verb":"PUT","request_url":"/obp/v4.0.0/banks/BANK_ID/atms/ATM_ID/notes","summary":"Update ATM Notes","description":"Update ATM Notes.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\natm_id: atme-9a0f-4bfa-b30b-9003aa467f51
\nnotes: notes
\n","description_markdown":"Update ATM Notes.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\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[**atm_id**](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**notes**](/glossary#): notes\n\n\n","example_request_body":{"notes":["String1","String2"]},"success_response_body":{"atm_id":"atme-9a0f-4bfa-b30b-9003aa467f51","notes":["String1","String2"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["ATM"],"typed_request_body":{"type":"object","properties":{"notes":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"notes":{"type":"array","items":{"type":"string"}},"atm_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID/notes","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField1": {\n "type": "reference:Consumer",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField2": {\n "type": "reference:Customer",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField3": {\n "type": "reference:MethodRouting",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField4": {\n "type": "reference:DynamicEntity",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField5": {\n "type": "reference:TransactionRequest",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField6": {\n "type": "reference:ProductAttribute",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField7": {\n "type": "reference:AccountAttribute",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField8": {\n "type": "reference:TransactionAttribute",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField9": {\n "type": "reference:CustomerAttribute",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField10": {\n "type": "reference:AccountApplication",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField11": {\n "type": "reference:CardAttribute",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField12": {\n "type": "reference:Counterparty",\n "example": "dc1d2abd-6377-4543-b77f-5e18962d1902"\n}\n\n"someField13": {\n "type": "reference:Branch:bankId&branchId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&branchId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862"\n}\n\n"someField14": {\n "type": "reference:Atm:bankId&atmId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&atmId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862"\n}\n\n"someField15": {\n "type": "reference:BankAccount:bankId&accountId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&accountId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862"\n}\n\n"someField16": {\n "type": "reference:Product:bankId&productCode",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&productCode=f7ca848e-5dc1-44e1-82ca-7f6b77d96862"\n}\n\n"someField17": {\n "type": "reference:PhysicalCard:bankId&cardId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&cardId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862"\n}\n\n"someField18": {\n "type": "reference:Transaction:bankId&accountId&transactionId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&accountId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862&transactionId=dc022794-75c6-4c8e-9033-d4dca914c22a"\n}\n\n"someField19": {\n "type": "reference:Counterparty:bankId&accountId&counterpartyId",\n "example": "bankId=dc1d2abd-6377-4543-b77f-5e18962d1902&accountId=f7ca848e-5dc1-44e1-82ca-7f6b77d96862&counterpartyId=dc022794-75c6-4c8e-9033-d4dca914c22a"\n}\n\nInformation returned about the account through VIEW_ID :
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\nproduct_code: 1234BW
\nscheme: OBP
\n\n","description_markdown":"Information returned about the account through VIEW_ID :\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**views_basic**](/glossary#views_basic): \n\n\n","success_response_body":{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","bank_id":"gh.29.uk","label":"My Account","number":"546387432","product_code":"AC","balance":{"currency":"EUR","amount":"0"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"views_basic":["owner"]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"views_basic":{"type":"array","items":{"type":"string"}},"bank_id":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"product_code":{"type":"string"},"id":{"type":"string"},"number":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAccount","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requests","summary":"Create Transaction Request (ACCOUNT)","description":"When using ACCOUNT, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using ACCOUNT, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT](/glossary#Account): \n\n\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/ACCOUNT/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-getAccountsByAccountRoutingRegex","implemented_by":{"version":"OBPv4.0.0","function":"getAccountsByAccountRoutingRegex"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/accounts/account-routing-regex-query","summary":"Get Accounts by Account Routing Regex","description":"This endpoint returns an array of accounts matching the provided routing scheme and the routing address regex.
\nThe bank_id field is optional.
Example of account routing scheme: IBAN, OBP, AccountNumber, ...
\nExample of account routing address regex: DE175.*, 55897106215-[A-Z]{3}, ...
This endpoint can be used to retrieve multiples accounts matching a same account routing address pattern.
\nFor example, if you want to link multiple accounts having different currencies, you can create an account
\nwith 123456789-EUR as Account Number and an other account with 123456789-USD as Account Number.
\nSo we can identify the Account Number as 123456789, so to get all the accounts with the same account number
\nand the different currencies, we can use this body in the request :
{\n "bank_id": "BANK_ID",\n "account_routing": {\n "scheme": "AccountNumber",\n "address": "123456789-[A-Z]{3}"\n }\n}\nThis request will returns the accounts matching the routing address regex (123456789-EUR and 123456789-USD).
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\n\nscheme: OBP
\nbank_id: gh.29.uk
\nJSON response body fields:
\n\n\n\n\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\n\n\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\n\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_swift_bic:
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_swift_bic: false
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\nscheme: OBP
\n\ntags: Create-My-User
\ntype:
\nuser:
\nvalue: 5987953
\n\nproduct_instance_code: product_instance_code
\n","description_markdown":"This endpoint returns an array of accounts matching the provided routing scheme and the routing address regex.\n\nThe `bank_id` field is optional.\n\nExample of account routing scheme: `IBAN`, `OBP`, `AccountNumber`, ...\nExample of account routing address regex: `DE175.*`, `55897106215-[A-Z]{3}`, ...\n\nThis endpoint can be used to retrieve multiples accounts matching a same account routing address pattern.\nFor example, if you want to link multiple accounts having different currencies, you can create an account\nwith `123456789-EUR` as Account Number and an other account with `123456789-USD` as Account Number.\nSo we can identify the Account Number as `123456789`, so to get all the accounts with the same account number\nand the different currencies, we can use this body in the request :\n\n```\n{\n \"bank_id\": \"BANK_ID\",\n \"account_routing\": {\n \"scheme\": \"AccountNumber\",\n \"address\": \"123456789-[A-Z]{3}\"\n }\n}\n```\n\nThis request will returns the accounts matching the routing address regex (`123456789-EUR` and `123456789-USD`).\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**account_routing**](/glossary#account_routing): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[bank_id](/glossary#): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**views_available**](/glossary#views_available): \n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"bank_id":"gh.29.uk","account_routing":{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}},"success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NoneLabel","number":"123","owners":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}],"product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"views_available":[{"id":"123","short_name":"short_name","description":"description","is_public":true,"alias":"None","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true}],"bank_id":"gh.29.uk","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"account_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"product_code":{"type":"string"},"label":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}},"id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"can_see_transaction_metadata":{"type":"boolean"},"id":{"type":"string"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"},"alias":{"type":"string"}}}},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/accounts/account-routing-regex-query","connector_methods":[]},{"operation_id":"OBPv3.1.0-getMeetings","implemented_by":{"version":"OBPv3.1.0","function":"getMeetings"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings","summary":"Get Meetings","description":"Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
\nThe actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.\n\nThe actual conference/chats are handled by external services.\n\nLogin is required.\n\nThis call is **experimental** and will require further authorisation in the future.\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**meetings**](/glossary#meetings): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","success_response_body":{"meetings":[{"meeting_id":"UUID-String","provider_id":"Chris","purpose_id":"String, eg: onboarding","bank_id":"gh.29.uk","present":{"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"keys":{"session_id":"String","staff_token":"String","customer_token":"String"},"when":"1099-12-31T21:00:00Z","creator":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"invitees":[{"contact_details":{"name":"Simon ","mobile_phone":"+44 07972 444 876","email_address":"felixsmith@example.com"},"status":"String, eg: Good"}]}]},"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-50000: Unknown Error."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_success_response_body":{"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/meetings","connector_methods":[]},{"operation_id":"OBPv3.0.0-getCurrentUser","implemented_by":{"version":"OBPv3.0.0","function":"getCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/current","summary":"Get User (Current)","description":"Get the logged in user
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nlist:
\nprovider: ETHEREUM
\n\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\n\n","description_markdown":"Get the logged in user\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"username":{"type":"string"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/current","connector_methods":[]},{"operation_id":"OBPv4.0.0-resetPasswordUrl","implemented_by":{"version":"OBPv4.0.0","function":"resetPasswordUrl"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/user/reset-password-url","summary":"Create password reset url","description":"Create password reset url.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nJSON response body fields:
\n\n","description_markdown":"Create password reset url.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**reset_password_url**](/glossary#reset_password_url): \n\n\n","example_request_body":{"username":"jobloggs","email":"jo@gmail.com","user_id":"74a8ebcc-10e4-4036-bef3-9835922246bf"},"success_response_body":{"reset_password_url":"https://apisandbox.openbankproject.com/user_mgt/reset_password/QOL1CPNJPCZ4BRMPX3Z01DPOX1HMGU3L"},"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":["User"],"typed_request_body":{"type":"object","properties":{"user_id":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"reset_password_url":{"type":"string"}}},"roles":[{"role":"CanCreateResetPasswordUrl","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/user/reset-password-url","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteCardForBank","implemented_by":{"version":"OBPv3.1.0","function":"deleteCardForBank"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID","summary":"Delete Card","description":"Delete a Card at bank specified by CARD_ID .
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\n","description_markdown":"Delete a Card at bank specified by CARD_ID .\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CARD_ID](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \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-10015: Allowed values are:","OBP-50000: Unknown Error."],"tags":["Card"],"roles":[{"role":"CanCreateCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards/CARD_ID","connector_methods":[]},{"operation_id":"OBPv2.1.0-getEntitlementsByBankAndUser","implemented_by":{"version":"OBPv2.1.0","function":"getEntitlementsByBankAndUser"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/users/USER_ID/entitlements","summary":"Get Entitlements for User at Bank","description":"Get Entitlements specified by BANK_ID and USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\n","description_markdown":"Get Entitlements specified by BANK_ID and USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n","success_response_body":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"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":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetEntitlementsForAnyUserAtOneBank","requires_bank_id":true},{"role":"CanGetEntitlementsForAnyUserAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/users/USER_ID/entitlements","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.
User Authentication is Optional. The User need not be logged in.
\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\nUser Authentication is Optional. The User need not be logged in.\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":[]},{"operation_id":"OBPv3.1.0-createCardAttribute","implemented_by":{"version":"OBPv3.1.0","function":"createCardAttribute"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID/attribute","summary":"Create Card Attribute","description":"Create Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","description_markdown":"Create Card Attribute\n\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Card Attribute is linked to its Card by CARD_ID\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CARD_ID](/glossary#): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DOUBLE","value":"2012-04-23"},"success_response_body":{"name":"OVERDRAFT_START_DATE","card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ","attribute_type":"DOUBLE","bank_id":{"value":"gh.29.uk"},"value":"2012-04-23","card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Card"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"bank_id":{"type":"object","properties":{"value":{"type":"string"}}},"card_id":{"type":"string"},"name":{"type":"string"},"card_attribute_id":{"type":"string"},"attribute_type":{"type":"string","enum":["STRING","INTEGER","DOUBLE","DATE_WITH_DAY"]}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/cards/CARD_ID/attribute","connector_methods":[]},{"operation_id":"OBPv4.0.0-createDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"createDynamicMessageDoc"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/dynamic-message-docs","summary":"Create Dynamic Message Doc","description":"Create a Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Create a Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","example_request_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","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":["Dynamic-Message-Doc"],"typed_request_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanCreateDynamicMessageDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-message-docs","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteRegulatedEntity","implemented_by":{"version":"OBPv5.1.0","function":"deleteRegulatedEntity"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID","summary":"Delete Regulated Entity","description":"Delete Regulated Entity specified by REGULATED_ENTITY_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\n","description_markdown":"Delete Regulated Entity specified by REGULATED_ENTITY_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_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-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Directory","API"],"roles":[{"role":"CanDeleteRegulatedEntity","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_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":"glossary-item-not-found
\nDelete Api Collection Endpoint By OPERATION_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAPI_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n","description_markdown":"glossary-item-not-found\n\nDelete Api Collection Endpoint By OPERATION_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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.0.0-getCustomersMinimalAtOneBank","implemented_by":{"version":"OBPv5.0.0","function":"getCustomersMinimalAtOneBank"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/customers-minimal","summary":"Get Customers Minimal at Bank","description":"Get Customers Minimal at Bank.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n","description_markdown":"Get Customers Minimal at Bank.\n\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customers**](/glossary#customers): \n\n\n","success_response_body":{"customers":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"}]},"error_response_bodies":["OBP-30008: User Customer Link not found by USER_ID","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],"tags":["Customer","User"],"typed_success_response_body":{"type":"object","properties":{"customers":{"type":"array","items":{"type":"object","properties":{"customer_id":{"type":"string"},"bank_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetCustomersMinimal","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers-minimal","connector_methods":[]},{"operation_id":"OBPv1.2.1-getTagsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getTagsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Get Transaction Tags","description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Returns the transaction TRANSACTION_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycChecks","implemented_by":{"version":"OBPv2.0.0","function":"getKycChecks"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_checks","summary":"Get Customer KYC Checks","description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nhow:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nsatisfied: false
\n\n\n","description_markdown":"Get KYC checks for the Customer specified by CUSTOMER_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**checks**](/glossary#checks): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**how**](/glossary#how): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**satisfied**](/glossary#satisfied): false\n\n\n\n[**staff_name**](/glossary#staff_name): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n","success_response_body":{"checks":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","date":"1099-12-31T21:00:00Z","how":"PlaceholderString","staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","staff_name":"PlaceholderString","satisfied":true,"comments":"PlaceholderString"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"comments":{"type":"string"},"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"staff_user_id":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"id":{"type":"string"},"satisfied":{"type":"boolean"},"how":{"type":"string"},"staff_name":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycChecks","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_checks","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateConsumerName","implemented_by":{"version":"OBPv5.1.0","function":"updateConsumerName"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/name","summary":"Update Consumer Name","description":"Update an existing name for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\ncertificate_pem: certificate_pem
\ncompany: Tesobe GmbH
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nconsumer_key: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq
\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nissuer_domain_name: issuer_domain_name
\nnot_after: not_after
\nnot_before: not_before
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nsubject_domain_name: subject_domain_name
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\ncertificate_info: certificate_info
\nlogo_url: logo_url
\nroles: CanCreateMyUser
\nroles_info: roles_info
\n","description_markdown":"Update an existing name for a Consumer specified by CONSUMER_ID.\n\n Please note: Your consumer may be disabled as a result of this action.\n\n CONSUMER_ID can be obtained after you register the application.\n\n Or use the endpoint 'Get Consumers' to get it\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**certificate_pem**](/glossary#): certificate_pem\n\n\n\n[**company**](/glossary#company): Tesobe GmbH\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**consumer_key**](/glossary#): bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**issuer_domain_name**](/glossary#): issuer_domain_name\n\n\n\n[**not_after**](/glossary#): not_after\n\n\n\n[**not_before**](/glossary#): not_before\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**subject_domain_name**](/glossary#): subject_domain_name\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[certificate_info](/glossary#): certificate_info\n\n\n\n[logo_url](/glossary#logo_url): logo_url\n\n\n\n[roles](/glossary#roles): CanCreateMyUser\n\n\n\n[roles_info](/glossary#): roles_info\n\n\n","example_request_body":{"app_name":"App name"},"success_response_body":{"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","consumer_key":"bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq","app_name":"appNameBank","app_type":"Web","description":"Description of the object. Maximum length is 2000. It can be any characters here.","developer_email":"felixsmith@example.com","company":"Tesobe GmbH","redirect_url":"https://apisandbox.openbankproject.com","certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIFIjCCBAqgAwIBAgIIX3qsz7QQxngwDQYJKoZIhvcNAQELBQAwgZ8xCzAJBgNV\r\nBAYTAkRFMQ8wDQYDVQQIEwZCZXJsaW4xDzANBgNVBAcTBkJlcmxpbjEPMA0GA1UE\r\nChMGVEVTT0JFMRowGAYDVQQLExFURVNPQkUgT3BlcmF0aW9uczESMBAGA1UEAxMJ\r\nVEVTT0JFIENBMR8wHQYJKoZIhvcNAQkBFhBhZG1pbkB0ZXNvYmUuY29tMQwwCgYD\r\nVQQpEwNWUE4wHhcNMjMwNzE3MDg0MDAwWhcNMjQwNzE3MDg0MDAwWjCBizELMAkG\r\nA1UEBhMCREUxDzANBgNVBAgTBkJlcmxpbjEPMA0GA1UEBxMGQmVybGluMRQwEgYD\r\nVQQKEwtUZXNvYmUgR21iSDEPMA0GA1UECxMGc3lzb3BzMRIwEAYDVQQDEwlsb2Nh\r\nbGhvc3QxHzAdBgkqhkiG9w0BCQEWEGFkbWluQHRlc29iZS5jb20wggEiMA0GCSqG\r\nSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCwxGuWUN1H0d0IeYPYWdLA0I/5BXx4DLO6\r\nzfi1GGJlF8BIXRN0VTJckIY9C3J1RnXDs6p6ufA01iHe1PQdL6VzfcaC3j+jUSgV\r\n1z9ybEUPyUwq3PCCxqoVI9n8yh+O6FDn3dvu/9Q2NtBpJHUBDCLf7OO9TgsFU2sE\r\nMys+Hw5DuuX5n5OQ2VIwH+qlMTQnd+yw5y8FKHqAZT5hE60lF/x6sQnwi58hLGRW\r\nSqo/548c2ZpoeWtnyY1I6PyR7zUYGuhruLY8gVFfLE+610u/lj2wYTXMxntpV+tV\r\nralLFRMhvbqZXW/EpuDb/pEbCnLDNDxq5NarLVDzcHs7VhT9MPChAgMBAAGjggFy\r\nMIIBbjATBgNVHSUEDDAKBggrBgEFBQcDAjAaBgNVHREEEzARgglsb2NhbGhvc3SH\r\nBH8AAAEwggEGBggrBgEFBQcBAwSB+TCB9jAIBgYEAI5GAQEwOAYGBACORgEFMC4w\r\nLBYhaHR0cHM6Ly9leGFtcGxlLm9yZy9wa2lkaXNjbG9zdXJlEwdleGFtcGxlMIGI\r\nBgYEAIGYJwIwfjBMMBEGBwQAgZgnAQMMBlBTUF9BSTARBgcEAIGYJwEBDAZQU1Bf\r\nQVMwEQYHBACBmCcBAgwGUFNQX1BJMBEGBwQAgZgnAQQMBlBTUF9JQwwlRHVtbXkg\r\nRmluYW5jaWFsIFN1cGVydmlzaW9uIEF1dGhvcml0eQwHWFgtREZTQTAlBgYEAI5G\r\nAQYwGwYHBACORgEGAQYHBACORgEGAgYHBACORgEGAzARBglghkgBhvhCAQEEBAMC\r\nB4AwHgYJYIZIAYb4QgENBBEWD3hjYSBjZXJ0aWZpY2F0ZTANBgkqhkiG9w0BAQsF\r\nAAOCAQEAKTS7exS9A7rWJLRzWrlHoTu68Avm5g9Dz1GKjgt8rnvj3D21SE14Rf5p\r\n0JWHYH4SiCdnh8Tx+IA7o0TmPJ1JRfAXR3i/5R7TJi/HrnqL+V7SIx2Cuq/hkZEU\r\nAhVs07nnvHURcrlQGwcfn4TbgpCURpCPpYZlNsYySb6BS6I4qFaadHGqMTyEkphV\r\nwfXyB3brmzxj9V4Qgp0t+s/uFuFirWyIayRc9nSSC7vuNVYvib2Kim4y8kvuWpA4\r\nZ51+fFOmBqCqpmwfAADNgDsLJiA/741eBflVd/ZUeAzgOjMCMIaDGlwiwZlePKT7\r\n553GtfsGxZMf05oqfUrQEQfJaU+/+Q==\n-----END CERTIFICATE-----\n","certificate_info":{"subject_domain_name":"OID.2.5.4.41=VPN, EMAILADDRESS=admin@tesobe.com, CN=TESOBE CA, OU=TESOBE Operations, O=TESOBE, L=Berlin, ST=Berlin, C=DE","issuer_domain_name":"CN=localhost, O=TESOBE GmbH, ST=Berlin, C=DE","not_before":"2022-04-01T10:13:00.000Z","not_after":"2032-04-01T10:13:00.000Z","roles_info":"PEM Encoded Certificate does not contain PSD2 roles."},"created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00:00Z","logo_url":"https://apisandbox.openbankproject.com/logo"},"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":["Consumer"],"typed_request_body":{"type":"object","properties":{"app_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"enabled":{"type":"boolean"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"logo_url":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"string"},"consumer_key":{"type":"string"},"certificate_pem":{"type":"string"},"certificate_info":{"type":"object","properties":{"roles_info":{"type":"string"},"subject_domain_name":{"type":"string"},"not_before":{"type":"string"},"issuer_domain_name":{"type":"string"},"not_after":{"type":"string"}}},"company":{"type":"string"},"redirect_url":{"type":"string"},"description":{"type":"string"},"app_type":{"type":"string"},"app_name":{"type":"string"}}},"roles":[{"role":"CanUpdateConsumerName","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/name","connector_methods":[]},{"operation_id":"OBPv1.2.1-updateCounterpartyPhysicalLocation","implemented_by":{"version":"OBPv1.2.1","function":"updateCounterpartyPhysicalLocation"},"request_verb":"PUT","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","summary":"Update Counterparty Physical Location","description":"Update geocoordinates of the counterparty's main location
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Update geocoordinates of the counterparty's main location\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"physical_location":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","the view does not allow metadata access","the view does not allow updating a physical location","Coordinates not possible","Physical Location cannot be updated","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","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=2026-03-16T21:00:23.789Z&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=2026-03-16T21:00:23.789Z
\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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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=2026-03-16T21:00:23.789Z&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=2026-03-16T21:00:23.789Z\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv4.0.0-getProductAttributeDefinition","implemented_by":{"version":"OBPv4.0.0","function":"getProductAttributeDefinition"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/attribute-definitions/product","summary":"Get Product Attribute Definition","description":"Get Product Attribute Definition
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\nattributes: attribute value in form of (name, value)
\nbank_id: gh.29.uk
\ncan_be_seen_on_views: false
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_active: false
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\n","description_markdown":"Get Product Attribute Definition\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**alias**](/glossary#alias): \n\n\n\n[**attribute_definition_id**](/glossary#attribute_definition_id): \n\n\n\n[**attributes**](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**can_be_seen_on_views**](/glossary#can_be_seen_on_views): false\n\n\n\n[**category**](/glossary#category): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"attributes":[{"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","name":"SPECIAL_TAX_NUMBER","category":"Product","type":"STRING","description":"description","alias":"STRING","can_be_seen_on_views":["bank"],"is_active":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Product"],"typed_success_response_body":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"can_be_seen_on_views":{"type":"array","items":{"type":"string"}},"attribute_definition_id":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"category":{"type":"string"},"alias":{"type":"string"}}}}}},"roles":[{"role":"CanGetProductAttributeDefinitionAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/attribute-definitions/product","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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nnone:
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[none](/glossary#none): \n\n\n","success_response_body":{},"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","Old-Style"],"typed_success_response_body":{"type":"object","properties":{}},"roles":[{"role":"CanSearchMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/search/metrics","connector_methods":[]},{"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:
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nakka:
\n\n\n\n\n\n\n\n\nrequire_scopes_for_listed_roles: false
\n\n\nvalue: 5987953
\n\nremote_data_secret_matched: remote_data_secret_matched
\n","description_markdown":"Returns information about:\n\n* The default bank_id\n* Akka configuration\n* Elastic Search configuration\n* Cached functions \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): false\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":[]},{"operation_id":"OBPv5.1.0-deleteCounterpartyLimit","implemented_by":{"version":"OBPv5.1.0","function":"deleteCounterpartyLimit"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","summary":"Delete Counterparty Limit","description":"Delete Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete Counterparty Limit.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Counterparty-Limits"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","connector_methods":[]},{"operation_id":"OBPv5.1.0-createNonPersonalUserAttribute","implemented_by":{"version":"OBPv5.1.0","function":"createNonPersonalUserAttribute"},"request_verb":"POST","request_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes","summary":"Create Non Personal User Attribute","description":"Create Non Personal User Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nJSON response body fields:
\ninsert_date: 2020-01-27
\nis_personal: is_personal
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nuser_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\n","description_markdown":"Create Non Personal User Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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 request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**insert_date**](/glossary#): 2020-01-27\n\n\n\n[**is_personal**](/glossary#): is_personal\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"BATTERY_LEVEL","type":"STRING","value":"90"},"success_response_body":{"user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"BATTERY_LEVEL","type":"STRING","value":"90","is_personal":false,"insert_date":"2026-03-16T21:00:25Z"},"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":["User"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"insert_date":{"type":"string","format":"date-time"},"user_attribute_id":{"type":"string"},"type":{"type":"string"},"is_personal":{"type":"boolean"},"name":{"type":"string"}}},"roles":[{"role":"CanCreateNonPersonalUserAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestAttribute","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestAttribute"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attribute","summary":"Create Transaction Request Attribute","description":"Create Transaction Request Attribute
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON request body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Transaction Request Attribute\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","attribute_type":"STRING","value":"123456789"},"success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"STRING","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanCreateTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attribute","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateRegulatedEntityAttribute","implemented_by":{"version":"OBPv5.1.0","function":"updateRegulatedEntityAttribute"},"request_verb":"PUT","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","summary":"Update Regulated Entity Attribute","description":"Update an existing Regulated Entity Attribute specified by ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Update an existing Regulated Entity Attribute specified by ATTRIBUTE_ID.\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ATTRIBUTE_ID](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**regulated_entity_attribute_id**](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**regulated_entity_id**](/glossary#): regulated_entity_id\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","example_request_body":{"name":"Attribute Name","attribute_type":"STRING","value":"1234","is_active":false},"success_response_body":{"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","attribute_type":"","value":"5987953","is_active":false},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Directory","API"],"typed_request_body":{"type":"object","properties":{"attribute_type":{"type":"string"},"value":{"type":"string"},"is_active":{"type":"boolean"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanUpdateRegulatedEntityAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCounterpartyLimitStatus","implemented_by":{"version":"OBPv5.1.0","function":"getCounterpartyLimitStatus"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limit-status","summary":"Get Counterparty Limit Status","description":"Get Counterparty Limit Status.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\ncurrency_status: currency_status
\nmax_monthly_amount: 10000.11
\nmax_monthly_amount_status: max_monthly_amount_status
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_monthly_transactions_status: max_number_of_monthly_transactions_status
\nmax_number_of_transactions: 100
\nmax_number_of_transactions_status: max_number_of_transactions_status
\nmax_number_of_yearly_transactions: 100
\nmax_number_of_yearly_transactions_status: max_number_of_yearly_transactions_status
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_total_amount_status: max_total_amount_status
\nmax_yearly_amount: 12000.11
\nmax_yearly_amount_status: max_yearly_amount_status
\n\nview_id: owner
\n","description_markdown":"Get Counterparty Limit Status.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_limit_id**](/glossary#counterparty_limit_id): abc9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**currency_status**](/glossary#): currency_status\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_monthly_amount_status**](/glossary#): max_monthly_amount_status\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_monthly_transactions_status**](/glossary#): max_number_of_monthly_transactions_status\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_transactions_status**](/glossary#): max_number_of_transactions_status\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions_status**](/glossary#): max_number_of_yearly_transactions_status\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_total_amount_status**](/glossary#): max_total_amount_status\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n[**max_yearly_amount_status**](/glossary#): max_yearly_amount_status\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n","success_response_body":{"counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100,"status":{"currency_status":"EUR","max_monthly_amount_status":"1000.11","max_number_of_monthly_transactions_status":10,"max_yearly_amount_status":"12000.11","max_number_of_yearly_transactions_status":100,"max_total_amount_status":"10000.12","max_number_of_transactions_status":100}},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Counterparty-Limits"],"typed_success_response_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"status":{"type":"object","properties":{"max_number_of_yearly_transactions_status":{"type":"integer"},"max_number_of_monthly_transactions_status":{"type":"integer"},"max_yearly_amount_status":{"type":"string"},"max_number_of_transactions_status":{"type":"integer"},"currency_status":{"type":"string"},"max_total_amount_status":{"type":"string"},"max_monthly_amount_status":{"type":"string"}}},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limit-status","connector_methods":[]},{"operation_id":"OBPv4.0.0-getSettlementAccounts","implemented_by":{"version":"OBPv4.0.0","function":"getSettlementAccounts"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/settlement-accounts","summary":"Get Settlement accounts at Bank","description":"Get settlement accounts on this API instance
\nReturns a list of settlement accounts at this Bank
Note: a settlement account is considered as a bank account.
\nSo you can update it and add account attributes to it using the regular account endpoints
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nname: ACCOUNT_MANAGEMENT_FEE
\npayment_system: SEPA
\nproduct_code: 1234BW
\nscheme: OBP
\n\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Get settlement accounts on this API instance\nReturns a list of settlement accounts at this Bank\n\nNote: a settlement account is considered as a bank account.\nSo you can update it and add account attributes to it using the regular account endpoints\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**branch_id**](/glossary#): DERBY6\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**payment_system**](/glossary#): SEPA\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**settlement_accounts**](/glossary#settlement_accounts): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","success_response_body":{"settlement_accounts":[{"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","payment_system":"SEPA","balance":{"currency":"EUR","amount":"0"},"label":"My Account","branch_id":"DERBY6","account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"account_attributes":[{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","PSD2"],"typed_success_response_body":{"type":"object","properties":{"settlement_accounts":{"type":"array","items":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"payment_system":{"type":"string"},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"account_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}}},"branch_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetSettlementAccountAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/settlement-accounts","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCustomerAttributeById","implemented_by":{"version":"OBPv4.0.0","function":"getCustomerAttributeById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes/ATTRIBUTE_ID","summary":"Get Customer Attribute By Id","description":"Get Customer Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Customer Attribute By Id\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"SPECIAL_TAX_NUMBER","type":"STRING","value":"123456789"},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Customer"],"typed_success_response_body":{"type":"object","properties":{"customer_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanGetCustomerAttributeAtOneBank","requires_bank_id":true},{"role":"CanGetCustomerAttributeAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createCustomerMessage","implemented_by":{"version":"OBPv4.0.0","function":"createCustomerMessage"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","summary":"Create Customer Message","description":"Create a message for the customer specified by CUSTOMER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nfrom_department: Open Bank
\nfrom_person: Tom
\nmessage: 123456
\ntransport: SMS
\nJSON response body fields:
\n\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID \nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**from_department**](/glossary#from_department): Open Bank\n\n\n\n[**from_person**](/glossary#from_person): Tom\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**transport**](/glossary#transport): SMS\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"message":"123456","transport":"SMS","from_department":"Open Bank","from_person":"Tom"},"success_response_body":{"success":"Success"},"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: "],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"message":{"type":"string"},"transport":{"type":"string"},"from_person":{"type":"string"},"from_department":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateCustomerMessage","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/messages","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Delete a DynamicEndpoint specified by DYNAMIC_ENDPOINT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv3.0.0-getBranch","implemented_by":{"version":"OBPv3.0.0","function":"getBranch"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Get Branch","description":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nBRANCH_ID: DERBY6
\nJSON response body fields:
\n\n\nbank_id: gh.29.uk
\n\n\ncity:
\nclosing_time: 2020-01-27
\ncountry_code: 1254
\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_accessible: false
\nlatitude: 38.8951
\n\n\n\n\n\n\nlongitude: -77.0364
\nmeta:
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\nscheme: OBP
\n\n\n\n\n\n","description_markdown":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:\n\n* Name\n* Address\n* Geo Location\n* License the data under this endpoint is released under.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[BRANCH_ID](/glossary#): DERBY6\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**accessibleFeatures**](/glossary#accessiblefeatures): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_routing**](/glossary#branch_routing): \n\n\n\n[**branch_type**](/glossary#branch_type): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**closing_time**](/glossary#closing_time): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**drive_up**](/glossary#drive_up): \n\n\n\n[**friday**](/glossary#friday): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_accessible**](/glossary#): false\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**lobby**](/glossary#lobby): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**monday**](/glossary#monday): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**opening_time**](/glossary#opening_time): \n\n\n\n[**phone_number**](/glossary#phone_number): \n\n\n\n[**postcode**](/glossary#postcode): \n\n\n\n[**saturday**](/glossary#saturday): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**state**](/glossary#state): \n\n\n\n[**sunday**](/glossary#sunday): \n\n\n\n[**thursday**](/glossary#thursday): \n\n\n\n[**tuesday**](/glossary#tuesday): \n\n\n\n[**wednesday**](/glossary#wednesday): \n\n\n","success_response_body":{"id":"branch-id-123","bank_id":"bank-id-123","name":"Branch by the Lake","address":{"line_1":"No 1 the Road","line_2":"The Place","line_3":"The Hill","city":"Berlin","county":"String","state":"Brandenburg","postcode":"13359","country_code":"DE"},"location":{"latitude":10.0,"longitude":10.0},"meta":{"license":{"id":"ODbL-1.0","name":"Open Database License"}},"lobby":{"monday":[{"opening_time":"10:00","closing_time":"18:00"}],"tuesday":[{"opening_time":"10:00","closing_time":"18:00"}],"wednesday":[{"opening_time":"10:00","closing_time":"18:00"}],"thursday":[{"opening_time":"10:00","closing_time":"18:00"}],"friday":[{"opening_time":"10:00","closing_time":"18:00"}],"saturday":[{"opening_time":"10:00","closing_time":"18:00"}],"sunday":[{"opening_time":"10:00","closing_time":"18:00"}]},"drive_up":{"monday":{"opening_time":"10:00","closing_time":"18:00"},"tuesday":{"opening_time":"10:00","closing_time":"18:00"},"wednesday":{"opening_time":"10:00","closing_time":"18:00"},"thursday":{"opening_time":"10:00","closing_time":"18:00"},"friday":{"opening_time":"10:00","closing_time":"18:00"},"saturday":{"opening_time":"10:00","closing_time":"18:00"},"sunday":{"opening_time":"10:00","closing_time":"18:00"}},"branch_routing":{"scheme":"OBP","address":"123abc"},"is_accessible":"true","accessibleFeatures":"wheelchair, atm usuable by the visually impaired","branch_type":"Full service store","more_info":"short walk to the lake from here","phone_number":"+381631954907"},"error_response_bodies":["OBP-300010: Branch not found. Please specify a valid value for BRANCH_ID. Or License may not be set. meta.license.id and meta.license.name can not be empty","OBP-50000: Unknown Error."],"tags":["Branch","Bank"],"typed_success_response_body":{"type":"object","properties":{"accessibleFeatures":{"type":"string"},"more_info":{"type":"string"},"branch_type":{"type":"string"},"name":{"type":"string"},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}}},"id":{"type":"string"},"is_accessible":{"type":"string"},"address":{"type":"object","properties":{"city":{"type":"string"},"county":{"type":"string"},"postcode":{"type":"string"},"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"}}},"drive_up":{"type":"object","properties":{"friday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"monday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"saturday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"thursday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"tuesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"wednesday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}},"sunday":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"phone_number":{"type":"string"},"lobby":{"type":"object","properties":{"saturday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"tuesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"monday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"friday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"sunday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"wednesday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}},"thursday":{"type":"array","items":{"type":"object","properties":{"closing_time":{"type":"string"},"opening_time":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-getCounterpartyLimit","implemented_by":{"version":"OBPv5.1.0","function":"getCounterpartyLimit"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","summary":"Get Counterparty Limit","description":"Get Counterparty Limit.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncounterparty_limit_id: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1
\ncurrency: EUR
\nmax_monthly_amount: 10000.11
\nmax_number_of_monthly_transactions: 10
\nmax_number_of_transactions: 100
\nmax_number_of_yearly_transactions: 100
\nmax_single_amount: 1000.11
\nmax_total_amount: 10000.12
\nmax_yearly_amount: 12000.11
\nview_id: owner
\n","description_markdown":"Get Counterparty Limit.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**counterparty_limit_id**](/glossary#counterparty_limit_id): abc9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**max_monthly_amount**](/glossary#max_monthly_amount): 10000.11\n\n\n\n[**max_number_of_monthly_transactions**](/glossary#max_number_of_monthly_transactions): 10\n\n\n\n[**max_number_of_transactions**](/glossary#max_number_of_transactions): 100\n\n\n\n[**max_number_of_yearly_transactions**](/glossary#max_number_of_yearly_transactions): 100\n\n\n\n[**max_single_amount**](/glossary#max_single_amount): 1000.11\n\n\n\n[**max_total_amount**](/glossary#max_total_amount): 10000.12\n\n\n\n[**max_yearly_amount**](/glossary#max_yearly_amount): 12000.11\n\n\n\n[**view_id**](/glossary#): owner\n\n\n","success_response_body":{"counterparty_limit_id":"abc9a7e4-6d02-40e3-a129-0b2bf89de9b1","bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","currency":"EUR","max_single_amount":"1000.11","max_monthly_amount":"10000.11","max_number_of_monthly_transactions":10,"max_yearly_amount":"12000.11","max_number_of_yearly_transactions":100,"max_total_amount":"10000.12","max_number_of_transactions":100},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-30017: Counterparty not found. Please specify a valid value for COUNTERPARTY_ID.","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Counterparty-Limits"],"typed_success_response_body":{"type":"object","properties":{"max_total_amount":{"type":"string"},"currency":{"type":"string"},"bank_id":{"type":"string"},"counterparty_id":{"type":"string"},"counterparty_limit_id":{"type":"string"},"view_id":{"type":"string"},"max_number_of_yearly_transactions":{"type":"integer"},"max_monthly_amount":{"type":"string"},"max_single_amount":{"type":"string"},"max_number_of_monthly_transactions":{"type":"integer"},"account_id":{"type":"string"},"max_yearly_amount":{"type":"string"},"max_number_of_transactions":{"type":"integer"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/counterparties/COUNTERPARTY_ID/limits","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteViewForBankAccount","implemented_by":{"version":"OBPv1.2.1","function":"deleteViewForBankAccount"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","summary":"Delete Custom View","description":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","user does not have owner access"],"tags":["View-Custom","Account"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-updateConsumerRedirectURL","implemented_by":{"version":"OBPv5.1.0","function":"updateConsumerRedirectURL"},"request_verb":"PUT","request_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/redirect_url","summary":"Update Consumer RedirectURL","description":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.
\nPlease note: Your consumer may be disabled as a result of this action.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\napp_name: appNameBank
\napp_type: Web
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nenabled: false
\nprovider: ETHEREUM
\n\nredirect_url: https://apisandbox.openbankproject.com
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n","description_markdown":"Update an existing redirectUrl for a Consumer specified by CONSUMER_ID.\n\n Please note: Your consumer may be disabled as a result of this action.\n\n CONSUMER_ID can be obtained after you register the application.\n\n Or use the endpoint 'Get Consumers' to get it\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**app_name**](/glossary#app_name): appNameBank\n\n\n\n[**app_type**](/glossary#app_type): Web\n\n\n\n[**consumer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created**](/glossary#created): \n\n\n\n[**created_by_user**](/glossary#created_by_user): \n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**developer_email**](/glossary#developer_email): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**enabled**](/glossary#enabled): false\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**redirect_url**](/glossary#redirect_url): https://apisandbox.openbankproject.com\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","example_request_body":{"redirect_url":"http://localhost:8888"},"success_response_body":{"consumer_id":1213,"app_name":"SOFI","app_type":"Web","description":"Account Management","developer_email":"felixsmith@example.com","redirect_url":"www.openbankproject.com","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","created_by_user":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith"},"enabled":true,"created":"1099-12-31T21:00: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":["Consumer"],"typed_request_body":{"type":"object","properties":{"redirect_url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"app_name":{"type":"string"},"enabled":{"type":"boolean"},"created_by_user_id":{"type":"string"},"created_by_user":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"username":{"type":"string"},"user_id":{"type":"string"}}},"description":{"type":"string"},"developer_email":{"type":"string"},"created":{"type":"string","format":"date-time"},"consumer_id":{"type":"integer"},"redirect_url":{"type":"string"},"app_type":{"type":"string"}}},"roles":[{"role":"CanUpdateConsumerRedirectUrl","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/consumers/CONSUMER_ID/consumer/redirect_url","connector_methods":[]},{"operation_id":"OBPv4.0.0-getFastFirehoseAccountsAtOneBank","implemented_by":{"version":"OBPv4.0.0","function":"getFastFirehoseAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/fast-firehose/accounts","summary":"Get Fast Firehose Accounts at Bank","description":"This endpoint allows bulk access to accounts.
\noptional pagination parameters for filter with accounts
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncode: 125
\ncurrency: EUR
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\n\n\nproduct_code: 1234BW
\nprovider: ETHEREUM
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nvalue: 5987953
\n","description_markdown":"This endpoint allows bulk access to accounts.\n\noptional pagination parameters for filter with accounts\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**account_attributes**](/glossary#account_attributes): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","bank_id":"gh.29.uk","label":"My Account","number":"","owners":[{"user_id":"b27327a2-a822-41e5-a909-0150da688939","provider":"https://finx22openplatform.fintech-galaxy.com,user_name:synth_user_1_54891","user_name":""}],"product_code":"1234BW","balance":{"currency":"EUR","amount":"0"},"account_routings":[{"bank_id":"bisb.com","account_id":"c590e38e-847c-466f-9a62-f2ad67daf106"}],"account_attributes":[{"type":"INTEGER","code":"Loan1","value":"0"},{"type":"STRING","code":"Loan1","value":"4421.783"}]}]},"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: "],"tags":["Account","Account-Firehose","FirehoseData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"product_code":{"type":"string"},"bank_id":{"type":"string"},"owners":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"string"},"user_name":{"type":"string"},"provider":{"type":"string"}}}},"label":{"type":"string"},"balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"number":{"type":"string"},"account_attributes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}}}}}}}},"roles":[{"role":"CanUseAccountFirehoseAtAnyBank","requires_bank_id":false},{"role":"CanUseAccountFirehose","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/fast-firehose/accounts","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteCustomView","implemented_by":{"version":"OBPv5.1.0","function":"deleteCustomView"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","summary":"Delete Custom View","description":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the custom view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TARGET_VIEW_ID](/glossary#): TARGET_VIEW_ID\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getImagesForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getImagesForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","summary":"Get Transaction Images","description":"Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nlabel: My Account
\nprovider: ETHEREUM
\nuser:
\n","description_markdown":"Returns the transaction TRANSACTION_ID images made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**images**](/glossary#images): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n","success_response_body":{"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_success_response_body":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":[]},{"operation_id":"OBPv5.1.0-getWebUiProps","implemented_by":{"version":"OBPv5.1.0","function":"getWebUiProps"},"request_verb":"GET","request_url":"/obp/v5.1.0/webui-props","summary":"Get WebUiProps","description":"Get the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.
\nurl query parameter:
\nactive: It must be a boolean string. and If active = true, it will show
\ncombination of explicit (inserted) + implicit (default) method_routings.
eg:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v5.1.0/webui-props
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v5.1.0/webui-props?active=true
User Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nvalue: 5987953
\n","description_markdown":"Get the all WebUiProps key values, those props key with \"webui_\" can be stored in DB, this endpoint get all from DB.\n\nurl query parameter:\nactive: It must be a boolean string. and If active = true, it will show\n combination of explicit (inserted) + implicit (default) method_routings.\n\neg:\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v5.1.0/webui-props\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v5.1.0/webui-props?active=true\n\n\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"webui-props":[{"name":"webui_api_explorer_url","value":"https://apiexplorer.openbankproject.com","web_ui_props_id":"web-ui-props-id"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["WebUi-Props"],"typed_success_response_body":{"type":"object","properties":{"webui-props":{"type":"array","items":{"type":"object","properties":{"web_ui_props_id":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/webui-props","connector_methods":[]},{"operation_id":"OBPv3.0.0-createViewForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"createViewForBankAccount"},"request_verb":"POST","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","summary":"Create Custom View","description":"Create a custom view on bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true on the view creation, the rest will be set to false.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nwhich_alias_to_use: public
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_query_available_funds: false
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Create a custom view on bank account\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n The 'alias' field in the JSON can take one of three values:\n\n * _public_: to use the public alias if there is one specified for the other account.\n * _private_: to use the private alias if there is one specified for the other account.\n\n * _''(empty string)_: to use no alias; the view shows the real name of the other account.\n\n The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to `true` and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.\n\n The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to `true` on the view creation, the rest will be set to `false`.\n\n You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP [system views](/index#group-View-System).\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**allowed_actions**](/glossary#allowed_actions): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**which_alias_to_use**](/glossary#which_alias_to_use): public\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","example_request_body":{"name":"_test","description":"This view is for family","metadata_view":"_test","is_public":true,"which_alias_to_use":"family","hide_metadata_if_alias_used":false,"allowed_actions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_request_body":{"type":"object","properties":{"hide_metadata_if_alias_used":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"which_alias_to_use":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","connector_methods":[]},{"operation_id":"OBPv5.1.0-getRegulatedEntityAttributeById","implemented_by":{"version":"OBPv5.1.0","function":"getRegulatedEntityAttributeById"},"request_verb":"GET","request_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","summary":"Get Regulated Entity Attribute By ID","description":"Get a specific Regulated Entity Attribute by its REGULATED_ENTITY_ATTRIBUTE_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nREGULATED_ENTITY_ATTRIBUTE_ID: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nREGULATED_ENTITY_ID: REGULATED_ENTITY_ID
\nJSON response body fields:
\nattribute_type: STRING
\nname: ACCOUNT_MANAGEMENT_FEE
\nregulated_entity_attribute_id: attrafa-9a0f-4bfa-b30b-9003aa467f51
\nregulated_entity_id: regulated_entity_id
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get a specific Regulated Entity Attribute by its REGULATED_ENTITY_ATTRIBUTE_ID.\n\n User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[REGULATED_ENTITY_ATTRIBUTE_ID](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[REGULATED_ENTITY_ID](/glossary#): REGULATED_ENTITY_ID\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**attribute_type**](/glossary#): STRING\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**regulated_entity_attribute_id**](/glossary#): attrafa-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[**regulated_entity_id**](/glossary#): regulated_entity_id\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"regulated_entity_id":"0af807d7-3c39-43ef-9712-82bcfde1b9ca","regulated_entity_attribute_id":"attrafa-9a0f-4bfa-b30b-9003aa467f51","name":"ACCOUNT_MANAGEMENT_FEE","attribute_type":"","value":"5987953","is_active":false},"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":["Directory","API"],"typed_success_response_body":{"type":"object","properties":{"regulated_entity_attribute_id":{"type":"string"},"name":{"type":"string"},"attribute_type":{"type":"string"},"value":{"type":"string"},"regulated_entity_id":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanGetRegulatedEntityAttribute","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/regulated-entities/REGULATED_ENTITY_ID/attributes/REGULATED_ENTITY_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCounterpartyByNameForAnyAccount","implemented_by":{"version":"OBPv4.0.0","function":"getCounterpartyByNameForAnyAccount"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparty-names/COUNTERPARTY_NAME","summary":"Get Counterparty by name for any account (Explicit) ","description":"This is a management endpoint that allows the retrieval of any Counterparty on an Account / View by its Name.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_NAME: John Smith Ltd.
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"This is a management endpoint that allows the retrieval of any Counterparty on an Account / View by its Name.\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_NAME](/glossary#): John Smith Ltd.\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Counterparty","Account"],"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"image_url":{"type":"string"}}},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"roles":[{"role":"CanGetCounterpartyAtAnyBank","requires_bank_id":false},{"role":"CanGetCounterparty","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparty-names/COUNTERPARTY_NAME","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\napi_collection_name: Favourites
\nis_sharable: is_sharable
\ndescription: Description of the object. 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: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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): Description of the object. 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":"Description of the object. 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":"Description of the object. 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":{"description":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/my/api-collections","connector_methods":[]},{"operation_id":"OBPv5.1.0-getOAuth2ServerWellKnown","implemented_by":{"version":"OBPv5.1.0","function":"getOAuth2ServerWellKnown"},"request_verb":"GET","request_url":"/obp/v5.1.0/well-known","summary":"Get Well Known URIs","description":"Get the OAuth2 server's public Well Known URIs.
\nUser Authentication is Optional. The User need not be logged in.
\nJSON response body fields:
\n\n\n","description_markdown":"Get the OAuth2 server's public Well Known URIs.\n\n \n\nUser Authentication is Optional. The User need not be logged in.\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/well-known","connector_methods":[]},{"operation_id":"OBPv2.1.0-createTransactionRequestSandboxTan","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestSandboxTan"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","summary":"Create Transaction Request (SANDBOX_TAN)","description":"When using SANDBOX_TAN, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed.
A Transaction Request can have one of several states.
Transactions are modeled on items in a bank statement that represent the movement of money.
Transaction Requests are requests to move money which may or may not succeeed and thus result in a Transaction.
A Transaction Request might create a security challenge that needs to be answered before the Transaction Request proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"XAF":1.0,
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"XBT":2.9074795E-8,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"HKD":1.0,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"XBT":2.164242461E-6,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"AUD":1.0,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"XBT":1.2284055924E-5,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"KRW":1.0,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"XBT":1.4234725E-8,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"JOD":1.0,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"XBT":2.3803244006E-5,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"GBP":1.0,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"XBT":2.2756409956E-5,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"MXN":1.0,
\n"AED":0.1688,
\n"INR":3.3513,
\n"XBT":8.1112586E-7,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"JOD":0.1930565,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":1.0,
\n"INR":18.3255,
\n"XBT":4.603349217E-6,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"INR":1.0,
\n"XBT":2.2689396E-7,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"XBT":{
\n"XAF":3.4353824E7,
\n"HKD":460448.9,
\n"AUD":81168.603,
\n"KRW":7.0131575E7,
\n"JOD":41960.111,
\n"GBP":44188.118,
\n"MXN":1230503.3,
\n"AED":217414.47,
\n"INR":4407607.74,
\n"XBT":1.0,
\n"JPY":6805170.8,
\n"USD":59245.918,
\n"ILS":182981.21,
\n"EUR":52436.431
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"XBT":1.47171931E-7,
\n"JPY":1.0,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"XBT":1.69154E-5,
\n"JPY":113.161,
\n"USD":1.0,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"XBT":5.452272147E-6,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"ILS":1.0,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"XBT":1.9087905636E-5,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494,
\n"EUR":1.0
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nvalue: 5987953
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using SANDBOX_TAN, the payee is set in the request body.\n\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.\n\nInitiate a Payment via creating a Transaction Request.\n\nIn OBP, a `transaction request` may or may not result in a `transaction`. However, a `transaction` only has one possible state: completed.\n\nA `Transaction Request` can have one of several states.\n\n`Transactions` are modeled on items in a bank statement that represent the movement of money.\n\n`Transaction Requests` are requests to move money which may or may not succeeed and thus result in a `Transaction`.\n\nA `Transaction Request` might create a security challenge that needs to be answered before the `Transaction Request` proceeds.\n\nTransaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).\n\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.\n\nThe payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.\n\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.\n\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.\n\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.\n\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.\n\nThe following static FX rates are available in sandbox mode:\n\n{\n \"XAF\":{\n \"XAF\":1.0,\n \"HKD\":0.0135503,\n \"AUD\":0.00228226,\n \"KRW\":1.87975,\n \"JOD\":0.00127784,\n \"GBP\":0.00131092,\n \"MXN\":0.0396,\n \"AED\":0.00601555,\n \"INR\":0.110241,\n \"XBT\":2.9074795E-8,\n \"JPY\":0.185328,\n \"USD\":0.00163773,\n \"ILS\":0.00641333,\n \"EUR\":0.00152449\n },\n \"HKD\":{\n \"XAF\":73.8049,\n \"HKD\":1.0,\n \"AUD\":0.178137,\n \"KRW\":143.424,\n \"JOD\":0.0903452,\n \"GBP\":0.0985443,\n \"MXN\":2.8067,\n \"AED\":0.467977,\n \"INR\":9.09325,\n \"XBT\":2.164242461E-6,\n \"JPY\":14.0867,\n \"USD\":0.127427,\n \"ILS\":0.460862,\n \"EUR\":0.112495\n },\n \"AUD\":{\n \"XAF\":438.162,\n \"HKD\":5.61346,\n \"AUD\":1.0,\n \"KRW\":895.304,\n \"JOD\":0.556152,\n \"GBP\":0.609788,\n \"MXN\":16.0826,\n \"AED\":2.88368,\n \"INR\":50.4238,\n \"XBT\":1.2284055924E-5,\n \"JPY\":87.0936,\n \"USD\":0.785256,\n \"ILS\":2.83558,\n \"EUR\":0.667969\n },\n \"KRW\":{\n \"XAF\":0.531986,\n \"HKD\":0.00697233,\n \"AUD\":0.00111694,\n \"KRW\":1.0,\n \"JOD\":6.30634E-4,\n \"GBP\":6.97389E-4,\n \"MXN\":0.0183,\n \"AED\":0.00320019,\n \"INR\":0.0586469,\n \"XBT\":1.4234725E-8,\n \"JPY\":0.0985917,\n \"USD\":8.7125E-4,\n \"ILS\":0.00316552,\n \"EUR\":8.11008E-4\n },\n \"JOD\":{\n \"XAF\":782.572,\n \"HKD\":11.0687,\n \"AUD\":1.63992,\n \"KRW\":1585.68,\n \"JOD\":1.0,\n \"GBP\":1.06757,\n \"MXN\":30.8336,\n \"AED\":5.18231,\n \"INR\":90.1236,\n \"XBT\":2.3803244006E-5,\n \"JPY\":156.304,\n \"USD\":1.41112,\n \"ILS\":5.02018,\n \"EUR\":0.237707\n },\n \"GBP\":{\n \"XAF\":762.826,\n \"HKD\":10.1468,\n \"AUD\":1.63992,\n \"KRW\":1433.92,\n \"JOD\":0.936707,\n \"GBP\":1.0,\n \"MXN\":29.242,\n \"AED\":4.58882,\n \"INR\":84.095,\n \"XBT\":2.2756409956E-5,\n \"JPY\":141.373,\n \"USD\":1.2493,\n \"ILS\":4.7002,\n \"EUR\":1.16278\n },\n \"MXN\":{\n \"XAF\":25.189,\n \"HKD\":0.3562,\n \"AUD\":0.0621,\n \"KRW\":54.4512,\n \"JOD\":0.0324,\n \"GBP\":0.0341,\n \"MXN\":1.0,\n \"AED\":0.1688,\n \"INR\":3.3513,\n \"XBT\":8.1112586E-7,\n \"JPY\":4.8687,\n \"USD\":0.0459,\n \"ILS\":0.1541,\n \"EUR\":0.0384\n },\n \"AED\":{\n \"XAF\":166.236,\n \"HKD\":2.13685,\n \"AUD\":0.346779,\n \"KRW\":312.482,\n \"JOD\":0.1930565,\n \"GBP\":0.217921,\n \"MXN\":5.9217,\n \"AED\":1.0,\n \"INR\":18.3255,\n \"XBT\":4.603349217E-6,\n \"JPY\":30.8081,\n \"USD\":0.27225,\n \"ILS\":0.968033,\n \"EUR\":0.253425\n },\n \"INR\":{\n \"XAF\":9.07101,\n \"HKD\":0.109972,\n \"AUD\":0.0198319,\n \"KRW\":17.0512,\n \"JOD\":0.0110959,\n \"GBP\":0.0118913,\n \"MXN\":0.2983,\n \"AED\":0.0545671,\n \"INR\":1.0,\n \"XBT\":2.2689396E-7,\n \"JPY\":1.68111,\n \"USD\":0.0148559,\n \"ILS\":0.0556764,\n \"EUR\":0.0138287\n },\n \"XBT\":{\n \"XAF\":3.4353824E7,\n \"HKD\":460448.9,\n \"AUD\":81168.603,\n \"KRW\":7.0131575E7,\n \"JOD\":41960.111,\n \"GBP\":44188.118,\n \"MXN\":1230503.3,\n \"AED\":217414.47,\n \"INR\":4407607.74,\n \"XBT\":1.0,\n \"JPY\":6805170.8,\n \"USD\":59245.918,\n \"ILS\":182981.21,\n \"EUR\":52436.431\n },\n \"JPY\":{\n \"XAF\":5.39585,\n \"HKD\":0.0709891,\n \"AUD\":0.0114819,\n \"KRW\":10.1428,\n \"JOD\":0.00639777,\n \"GBP\":0.0070735,\n \"MXN\":0.2053,\n \"AED\":0.032459,\n \"INR\":0.594846,\n \"XBT\":1.47171931E-7,\n \"JPY\":1.0,\n \"USD\":0.00883695,\n \"ILS\":0.0320926,\n \"EUR\":0.00822592\n },\n \"USD\":{\n \"XAF\":610.601,\n \"HKD\":7.84766,\n \"AUD\":1.27347,\n \"KRW\":1147.78,\n \"JOD\":0.708659,\n \"GBP\":0.800446,\n \"MXN\":21.748,\n \"AED\":3.6731,\n \"INR\":67.3135,\n \"XBT\":1.69154E-5,\n \"JPY\":113.161,\n \"USD\":1.0,\n \"ILS\":3.55495,\n \"EUR\":0.930886\n },\n \"ILS\":{\n \"XAF\":155.925,\n \"HKD\":2.16985,\n \"AUD\":0.352661,\n \"KRW\":315.903,\n \"JOD\":0.199196,\n \"GBP\":0.212763,\n \"MXN\":6.4871,\n \"AED\":1.03302,\n \"INR\":17.9609,\n \"XBT\":5.452272147E-6,\n \"JPY\":31.1599,\n \"USD\":0.281298,\n \"ILS\":1.0,\n \"EUR\":1.19318\n },\n \"EUR\":{\n \"XAF\":655.957,\n \"HKD\":8.88926,\n \"AUD\":1.49707,\n \"KRW\":1233.03,\n \"JOD\":0.838098,\n \"GBP\":0.860011,\n \"MXN\":26.0359,\n \"AED\":3.94594,\n \"INR\":72.3136,\n \"XBT\":1.9087905636E-5,\n \"JPY\":121.567,\n \"USD\":1.07428,\n \"ILS\":4.20494,\n \"EUR\":1.0\n }\n}\n\n\nTransaction Requests satisfy PSD2 requirements thus:\n\n1) A transaction can be initiated by a third party application.\n\n2) The customer is informed of the charge that will incurred.\n\n3) The call supports delegated authentication (OAuth)\n\nSee [this python code](https://github.com/OpenBankProject/Hello-OBP-DirectLogin-Python/blob/master/hello_payments.py) for a complete example of this flow.\n\nThere is further documentation [here](https://github.com/OpenBankProject/OBP-API/wiki/Transaction-Requests)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[SANDBOX_TAN](/glossary#sandbox_tan): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge**](/glossary#challenge): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"to":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"value":{"currency":"EUR","amount":"0"},"description":"this is for work"},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenge":{"id":"be1a183d-b301-4b83-b855-5eeffdd3526f","allowed_attempts":3,"challenge_type":"SANDBOX_TAN"},"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"to":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenge":{"type":"object","properties":{"challenge_type":{"type":"string"},"allowed_attempts":{"type":"integer"},"id":{"type":"string"}}},"status":{"type":"string"},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","connector_methods":[]},{"operation_id":"OBPv4.0.0-updateBankLevelDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"updateBankLevelDynamicMessageDoc"},"request_verb":"PUT","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","summary":"Update Bank Level Dynamic Message Doc","description":"Update a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Update a Bank Level Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[DYNAMIC_MESSAGE_DOC_ID](/glossary#): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","example_request_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"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-Message-Doc"],"typed_request_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanUpdateDynamicMessageDoc","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-message-docs/DYNAMIC_MESSAGE_DOC_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getSystemViewsIds","implemented_by":{"version":"OBPv5.0.0","function":"getSystemViewsIds"},"request_verb":"GET","request_url":"/obp/v5.0.0/system-views-ids","summary":"Get Ids of System Views","description":"Get Ids of System Views
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n","description_markdown":"Get Ids of System Views\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON response body fields:**\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**views**](/glossary#views): \n\n\n","success_response_body":{"views":[{"id":"owner"}]},"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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"roles":[{"role":"CanGetSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views-ids","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCommentForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteCommentForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","summary":"Delete a Transaction Comment","description":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COMMENT_ID](/glossary#comment_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-lockUserByProviderAndUsername","implemented_by":{"version":"OBPv5.1.0","function":"lockUserByProviderAndUsername"},"request_verb":"POST","request_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/locks","summary":"Lock the user","description":"Lock a User.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON request body fields:
\nJSON response body fields:
\nlast_lock_date: 2020-01-27
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Lock a User.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[USERNAME](/glossary#): felixsmith\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**last_lock_date**](/glossary#last_lock_date): 2020-01-27\n\n\n\n[**type_of_lock**](/glossary#type_of_lock): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","type_of_lock":"lock_via_api","last_lock_date":"1099-12-31T22:01:01Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20027: User not found by provider and username.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"type_of_lock":{"type":"string"},"last_lock_date":{"type":"string","format":"date-time"},"user_id":{"type":"string"}}},"roles":[{"role":"CanLockUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/locks","connector_methods":[]},{"operation_id":"OBPv4.0.0-createProductFee","implemented_by":{"version":"OBPv4.0.0","function":"createProductFee"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/fee","summary":"Create Product Fee","description":"Create Product Fee
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\namount: 10.12
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nfrequency: DAILY
\nis_active: false
\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\nproduct_fee_id: 696hlAHLFKUHE37469287634
\ntype:
\nvalue: 5987953
\n","description_markdown":"Create Product Fee\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_fee_id](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**frequency**](/glossary#frequency): DAILY\n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**product_fee_id**](/glossary#product_fee_id): 696hlAHLFKUHE37469287634\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_fee_id":"696hlAHLFKUHE37469287634","name":"ACCOUNT_MANAGEMENT_FEE","is_active":true,"more_info":"More information about this fee","value":{"currency":"EUR","amount":"10.12","frequency":"DAILY","type":""}},"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-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Product"],"typed_request_body":{"type":"object","properties":{"is_active":{"type":"boolean"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"product_code":{"type":"string"},"is_active":{"type":"boolean"},"bank_id":{"type":"string"},"name":{"type":"string"},"more_info":{"type":"string"},"value":{"type":"object","properties":{"type":{"type":"string"},"currency":{"type":"string"},"frequency":{"type":"string"},"amount":{"type":"number"}}},"product_fee_id":{"type":"string"}}},"roles":[{"role":"CanCreateProductFee","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/fee","connector_methods":[]},{"operation_id":"OBPv5.1.0-getNonPersonalUserAttributes","implemented_by":{"version":"OBPv5.1.0","function":"getNonPersonalUserAttributes"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes","summary":"Get Non Personal User Attributes","description":"Get Non Personal User Attribute for a user specified by USER_ID
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nUSER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\n","description_markdown":"Get Non Personal User Attribute for a user specified by USER_ID\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["User"],"roles":[{"role":"CanGetNonPersonalUserAttributes","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/USER_ID/non-personal/attributes","connector_methods":[]},{"operation_id":"OBPv4.0.0-getCounterpartiesForAnyAccount","implemented_by":{"version":"OBPv4.0.0","function":"getCounterpartiesForAnyAccount"},"request_verb":"GET","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Get Counterparties for any account (Explicit)","description":"This is a management endpoint that gets the Counterparties that have been explicitly created for an Account / View.
\nFor a general introduction to Counterparties in OBP, see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\n\nvalue: 5987953
\n","description_markdown":"This is a management endpoint that gets the Counterparties that have been explicitly created for an Account / View.\n\nFor a general introduction to Counterparties in OBP, see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**counterparties**](/glossary#Counterparties): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"counterparties":[{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Counterparty","Payment Initiation Service (PIS)","PSD2","Account"],"typed_success_response_body":{"type":"object","properties":{"counterparties":{"type":"array","items":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetCounterparties","requires_bank_id":true},{"role":"CanGetCounterpartiesAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv4.0.0-createBankLevelEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelEndpointMapping"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/endpoint-mappings","summary":"Create Bank Level Endpoint Mapping","description":"Create an Bank Level Endpoint Mapping.
\nNote: at moment only support the dynamic endpoints
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Create an Bank Level Endpoint Mapping. \n\nNote: at moment only support the dynamic endpoints\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}}},"success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanCreateBankLevelEndpointMapping","requires_bank_id":true},{"role":"CanCreateEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings","connector_methods":[]},{"operation_id":"OBPv4.0.0-getEntitlementsForBank","implemented_by":{"version":"OBPv4.0.0","function":"getEntitlementsForBank"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/entitlements","summary":"Get Entitlements for One Bank","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\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[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","success_response_body":{"list":[{"entitlement_id":"","role_name":"","bank_id":"gh.29.uk","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}]},"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":["Role","Entitlement","User"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"entitlement_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetEntitlementsForOneBank","requires_bank_id":true},{"role":"CanGetEntitlementsForAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/entitlements","connector_methods":[]},{"operation_id":"OBPv2.1.0-sandboxDataImport","implemented_by":{"version":"OBPv2.1.0","function":"sandboxDataImport"},"request_verb":"POST","request_url":"/obp/v2.1.0/sandbox/data-import","summary":"Create sandbox","description":"Import bulk data into the sandbox (Authenticated access).
\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
\nThe user needs to have CanCreateSandbox entitlement.
\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
\nAn example of an import set of data (json) can be found here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\n\nactual_date: 2020-01-27
\n\namount: 10.12
\natms:
\nbalance: 10
\nbank:
\nbank_id: gh.29.uk
\n\n\n\n\ncity:
\ncode: 125
\ncompleted: 2020-01-27
\ncountry_code: 1254
\n\n\ncurrency: EUR
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nfull_name: full name string
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlabel: My Account
\nlatitude: 38.8951
\n\n\n\n\n\nlogo: logo url
\nlongitude: -77.0364
\nmeta:
\nmore_info_url: www.example.com/abc
\nname: ACCOUNT_MANAGEMENT_FEE
\nnew_balance: 20
\n\n\npassword: password
\npost_code: 789
\nposted: 2020-01-27
\n\n\n\n\n\n\ntype:
\nuser_name: felixsmith
\nusers: user list
\nvalue: 5987953
\nwebsite: www.openbankproject.com
\naccount_number: 546387432
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\n\n","description_markdown":"Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**accounts**](/glossary#accounts): \n\n\n\n[**actual_date**](/glossary#actual_date): 2020-01-27\n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**atms**](/glossary#atms): \n\n\n\n[**balance**](/glossary#balance): 10\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**banks**](/glossary#banks): \n\n\n\n[**branches**](/glossary#branches): \n\n\n\n[**category**](/glossary#category): \n\n\n\n[**channel**](/glossary#channel): \n\n\n\n[**city**](/glossary#city): \n\n\n\n[**code**](/glossary#code): 125\n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**country_code**](/glossary#country_code): 1254\n\n\n\n[**county**](/glossary#county): \n\n\n\n[**crm_events**](/glossary#crm_events): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**customer**](/glossary#Customer): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**detail**](/glossary#detail): \n\n\n\n[**details**](/glossary#details): \n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**family**](/glossary#family): \n\n\n\n[**full_name**](/glossary#full_name): full name string\n\n\n\n[**generate_accountants_view**](/glossary#generate_accountants_view): \n\n\n\n[**generate_auditors_view**](/glossary#generate_auditors_view): \n\n\n\n[**generate_public_view**](/glossary#generate_public_view): \n\n\n\n[**hours**](/glossary#hours): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**license**](/glossary#license): \n\n\n\n[**line_1**](/glossary#): \n\n\n\n[**line_2**](/glossary#): \n\n\n\n[**line_3**](/glossary#): \n\n\n\n[**location**](/glossary#location): \n\n\n\n[**logo**](/glossary#logo): logo url\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**meta**](/glossary#meta): \n\n\n\n[**more_info_url**](/glossary#more_info_url): www.example.com/abc\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**number**](/glossary#number): \n\n\n\n[**owners**](/glossary#owners): \n\n\n\n[**password**](/glossary#): password\n\n\n\n[**post_code**](/glossary#post_code): 789\n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**products**](/glossary#products): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**state**](/glossary#state): \n\n\n\n[**super_family**](/glossary#super_family): \n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_name**](/glossary#): felixsmith\n\n\n\n[**users**](/glossary#users): user list\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**website**](/glossary#website): www.openbankproject.com\n\n\n\n[account_number](/glossary#): 546387432\n\n\n\n[counterparty](/glossary#counterparty): \n\n\n\n[driveUp](/glossary#driveup): \n\n\n\n[lobby](/glossary#lobby): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**success**](/glossary#success): \n\n\n","example_request_body":{"banks":[{"id":"bank1","short_name":"bank 1","full_name":"Bank 1 Inc.","logo":"http://example.com/logo","website":"http://example.com"},{"id":"bank2","short_name":"bank 2","full_name":"Bank 2 Inc.","logo":"http://example.com/logo2","website":"http://example.com/2"}],"users":[{"email":"user1@example.com","password":"TESOBE520berlin123!","user_name":"User 1"},{"email":"user2@example.com","password":"TESOBE520berlin123!","user_name":"User 2"}],"accounts":[{"id":"account1","bank":"bank1","label":"Account 1 at Bank 1","number":"1","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"1234567890","owners":["User 1"],"generate_public_view":true,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account2","bank":"bank1","label":"Account 2 at Bank 1","number":"2","type":"current","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"91234567890","owners":["User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account1","bank":"bank2","label":"Account 1 at Bank 2","number":"22","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"21234567890","owners":["User 1","User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true}],"transactions":[{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank2"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartNameTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"account_number":"123456-AVB"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartAccountNumberTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Piano Repair"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-with-counterparty","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Acme Inc.","account_number":"12345-B"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank1"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}}],"branches":[{"id":"branch1","bank_id":"bank1","name":"Genel Müdürlük","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}},{"id":"branch2","bank_id":"bank1","name":"Manchester","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}],"atms":[{"id":"atm1","bank_id":"bank1","name":"Ashbourne Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"id":"atm2","bank_id":"bank1","name":"Manchester Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"products":[{"bank_id":"bank1","code":"prd1","name":"product 1","category":"cat1","family":"fam1","super_family":"sup fam 1","more_info_url":"www.example.com/index1","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"bank_id":"bank1","code":"prd2","name":"Product 2","category":"cat2","family":"fam2","super_family":"sup fam 2","more_info_url":"www.example.com/index2","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"crm_events":[{"id":"ASDFHJ47YKJH","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"},{"id":"KIFJA76876AS","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"1100-01-01T01:01:01.000Z"}]},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-00002: Data import is disabled for this API instance.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Sandbox"],"typed_request_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"IBAN":{"type":"string"},"generate_accountants_view":{"type":"boolean"},"owners":{"type":"array","items":{"type":"string"}},"generate_public_view":{"type":"boolean"},"bank":{"type":"string"},"id":{"type":"string"},"generate_auditors_view":{"type":"boolean"},"label":{"type":"string"},"number":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"type":{"type":"string"}}}},"branches":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"driveUp":{"type":"object","properties":{"hours":{"type":"string"}}},"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"this_account":{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"}}},"details":{"type":"object","properties":{"value":{"type":"string"},"new_balance":{"type":"string"},"type":{"type":"string"},"completed":{"type":"string"},"posted":{"type":"string"},"description":{"type":"string"}}}}}},"products":{"type":"array","items":{"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"bank_id":{"type":"string"},"super_family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"code":{"type":"string"},"more_info_url":{"type":"string"}}}},"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"crm_events":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"actual_date":{"type":"string","format":"date-time"},"bank_id":{"type":"string"},"customer":{"type":"object","properties":{"number":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"string"},"id":{"type":"string"},"detail":{"type":"string"}}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"user_name":{"type":"string"},"password":{"type":"string"}}}},"banks":{"type":"array","items":{"type":"object","properties":{"full_name":{"type":"string"},"short_name":{"type":"string"},"logo":{"type":"string"},"website":{"type":"string"},"id":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateSandbox","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/sandbox/data-import","connector_methods":[]},{"operation_id":"OBPv3.1.0-createTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"createTaxResidence"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence","summary":"Create Tax Residence","description":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\n\ntax_number: 456
\nJSON response body fields:
\n\ntax_number: 456
\n\n","description_markdown":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n[**tax_residence_id**](/glossary#tax_residence_id): \n\n\n","example_request_body":{"domain":"Enter some domain","tax_number":"Enter some number"},"success_response_body":{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"},"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":["Customer","KYC"],"typed_request_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}},"roles":[{"role":"CanCreateTaxResidence","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence","connector_methods":[]},{"operation_id":"OBPv3.0.0-getFirehoseTransactionsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getFirehoseTransactionsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/firehose/accounts/ACCOUNT_ID/views/VIEW_ID/transactions","summary":"Get Firehose Transactions for Account","description":"Get Transactions for an Account that has a firehose View.
\nAllows bulk access to an account's transactions.
\nUser must have the CanUseFirehoseAtAnyBank Role
To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.
\nFor VIEW_ID try 'owner'
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nURL: http://www.example.com/id-docs/123/image.png
\n\n\namount: 10.12
\n\n\ncompleted: 2020-01-27
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\n\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nnew_balance: 20
\n\n\n\nposted: 2020-01-27
\n\nprovider: ETHEREUM
\n\nscheme: OBP
\ntags: Create-My-User
\n\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ntype:
\nuser:
\nvalue: 5987953
\n\n","description_markdown":"Get Transactions for an Account that has a firehose View.\n\nAllows bulk access to an account's transactions.\nUser must have the CanUseFirehoseAtAnyBank Role\n\nTo find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.\n\nFor VIEW_ID try 'owner'\n\n\n\nPossible custom url parameters for pagination:\n\n* limit=NUMBER ==> default value: 50\n* offset=NUMBER ==> default value: 0\n\neg1:?limit=100&offset=0\n\n\n* sort_direction=ASC/DESC ==> default value: DESC.\n\neg2:?limit=100&offset=0&sort_direction=ASC\n\n\n\n* from_date=DATE => example value: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).\n* to_date=DATE => example value: 2026-03-16T21:00:23.773Z. NOTE! The default value is now (2026-03-16T21:00:23.773Z).\n\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.\n\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_routing**](/glossary#bank_routing): \n\n\n\n[**comments**](/glossary#comments): \n\n\n\n[**completed**](/glossary#completed): 2020-01-27\n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**holders**](/glossary#holders): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**images**](/glossary#images): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**narrative**](/glossary#narrative): \n\n\n\n[**new_balance**](/glossary#new_balance): 20\n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**other_account**](/glossary#other_account): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**posted**](/glossary#posted): 2020-01-27\n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**tags**](/glossary#tags): Create-My-User\n\n\n\n[**this_account**](/glossary#this_account): \n\n\n\n[**transaction_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**transaction_attributes**](/glossary#transaction_attributes): \n\n\n\n[**transactions**](/glossary#transactions): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"transactions":[{"id":"String","this_account":{"id":"String","bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"holders":[{"name":"OBP","is_alias":true}]},"other_account":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"OBP","address":"gh.29.uk"},"account_routings":[{"scheme":"OBP","address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"}],"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"details":{"type":"AC","description":"this is for family","posted":"1099-12-31T21:00:00Z","completed":"1099-12-31T21:00:00Z","new_balance":{"currency":"EUR","amount":"0"},"value":{"currency":"EUR","amount":"0"}},"metadata":{"narrative":"NONE","comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"tags":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}],"where":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"transaction_attributes":[{"transaction_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"DATE_WITH_DAY","value":"123456789"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-00009: Account firehose is not allowed on this instance. Please set allow_account_firehose = true in props files. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Transaction","Account-Firehose","Transaction-Firehose","FirehoseData"],"typed_success_response_body":{"type":"object","properties":{"transactions":{"type":"array","items":{"type":"object","properties":{"other_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"}}},"transaction_attributes":{"type":"array","items":{"type":"object","properties":{"transaction_attribute_id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}}},"this_account":{"type":"object","properties":{"account_routings":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"holders":{"type":"array","items":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}}},"id":{"type":"string"}}},"metadata":{"type":"object","properties":{"narrative":{"type":"string"},"where":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"images":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}},"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}},"tags":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"id":{"type":"string"},"details":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"completed":{"type":"string","format":"date-time"},"new_balance":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"posted":{"type":"string","format":"date-time"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}}}}}}},"roles":[{"role":"CanUseAccountFirehoseAtAnyBank","requires_bank_id":false},{"role":"CanUseAccountFirehose","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/firehose/accounts/ACCOUNT_ID/views/VIEW_ID/transactions","connector_methods":[]},{"operation_id":"OBPv5.1.0-getBankAccountBalances","implemented_by":{"version":"OBPv5.1.0","function":"getBankAccountBalances"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/balances","summary":"Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID","description":"Get the Balances for the Account specified by BANK_ID and ACCOUNT_ID through the VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\n\namount: 10.12
\nbalances: balances
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nscheme: OBP
\ntype:
\n","description_markdown":"Get the Balances for the Account specified by BANK_ID and ACCOUNT_ID through the VIEW_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**account_routings**](/glossary#account_routings): \n\n\n\n[**address**](/glossary#address): \n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**balances**](/glossary#): balances\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**scheme**](/glossary#scheme): OBP\n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_routings":[{"scheme":"accountNumber","address":"123456"}],"label":"My Account","balances":[{"type":"","currency":"EUR","amount":"10"}]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"bank_id":{"type":"string"},"label":{"type":"string"},"balances":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"}}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"account_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/balances","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteWhereTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteWhereTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","summary":"Delete a Transaction Tag","description":"Deletes the where tag of the transaction TRANSACTION_ID made on view.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the where tag of the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20001: User not logged in. Authentication is required!","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","there is no tag to delete","Delete not completed","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"operation_id":"OBPv5.0.0-createConsentByConsentRequestIdSms","implemented_by":{"version":"OBPv5.0.0","function":"createConsentByConsentRequestIdSms"},"request_verb":"POST","request_url":"/obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/SMS/consents","summary":"Create Consent By CONSENT_REQUEST_ID (SMS)","description":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent you are creating cannot exceed the entitlements that the User creating this consents already has.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nSMS:
\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","description_markdown":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.\n\nPlease note that the Consent you are creating cannot exceed the entitlements that the User creating this consents already has.\n\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_REQUEST_ID](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[SMS](/glossary#sms): \n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[account_access](/glossary#): account_access\n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_access":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}},"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-10001: Incorrect json format.","OBP-35029: The CONSENT_REQUEST_ID is invalid. ","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/SMS/consents","connector_methods":[]},{"operation_id":"OBPv3.1.0-deleteProductAttribute","implemented_by":{"version":"OBPv3.1.0","function":"deleteProductAttribute"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Delete Product Attribute","description":"Delete Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nDelete a Product Attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\n","description_markdown":"Delete Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nDelete a Product Attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20006: User is missing one or more roles: ","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Product"],"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteAccountCascade","implemented_by":{"version":"OBPv4.0.0","function":"deleteAccountCascade"},"request_verb":"DELETE","request_url":"/obp/v4.0.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Delete Account Cascade","description":"Delete an Account Cascade specified by ACCOUNT_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete an Account Cascade specified by ACCOUNT_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Account"],"roles":[{"role":"CanDeleteAccountCascade","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/cascading/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-getOtherAccountForTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getOtherAccountForTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","summary":"Get Other Account of Transaction","description":"Get other account of a transaction.
\nReturns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
User Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\nURL: http://www.example.com/id-docs/123/image.png
\nbank:
\n\ndate: 2020-01-27
\n\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\n\nkind:
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\n\n\nprovider: ETHEREUM
\n\n\nuser:
\n","description_markdown":"Get other account of a transaction.\nReturns details of the other party involved in the transaction, moderated by the [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**IBAN**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**URL**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**bank**](/glossary#Bank): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**holder**](/glossary#holder): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_URL**](/glossary#image_url): \n\n\n\n[**is_alias**](/glossary#is_alias): \n\n\n\n[**kind**](/glossary#kind): \n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**national_identifier**](/glossary#national_identifier): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**open_corporates_URL**](/glossary#open_corporates_url): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**swift_bic**](/glossary#swift_bic): \n\n\n\n[**user**](/glossary#User): \n\n\n","success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"number":"123","kind":"3456","IBAN":"UK234DB","swift_bic":"UK12321DB","bank":{"national_identifier":"OBP","name":"OBP"},"metadata":{"public_alias":"NONE","private_alias":"NONE","more_info":"www.openbankproject.com","URL":"www.openbankproject.com","image_URL":"www.openbankproject.com","open_corporates_URL":"www.openbankproject.com","corporate_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"physical_location":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["Transaction","Counterparty"],"typed_success_response_body":{"type":"object","properties":{"metadata":{"type":"object","properties":{"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"IBAN":{"type":"string"},"swift_bic":{"type":"string"},"number":{"type":"string"},"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"bank":{"type":"object","properties":{"national_identifier":{"type":"string"},"name":{"type":"string"}}},"kind":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/other_account","connector_methods":[]},{"operation_id":"OBPv1.2.1-addTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Add a Transaction Tag","description":"Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nvalue: 5987953
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nprovider: ETHEREUM
\nuser:
\nvalue: 5987953
\n","description_markdown":"Posts a tag about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":[]},{"operation_id":"OBPv5.1.0-getUserLockStatus","implemented_by":{"version":"OBPv5.1.0","function":"getUserLockStatus"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/lock-status","summary":"Get User Lock Status","description":"Get User Login Status.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\nbad_attempts_since_last_success_or_reset:
\nlast_failure_date: 2020-01-27
\nusername: felixsmith
\n","description_markdown":"Get User Login Status.\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[USERNAME](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bad_attempts_since_last_success_or_reset**](/glossary#bad_attempts_since_last_success_or_reset): \n\n\n\n[**last_failure_date**](/glossary#last_failure_date): 2020-01-27\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n","success_response_body":{"username":"felixsmith","bad_attempts_since_last_success_or_reset":0,"last_failure_date":"1099-12-31T22:01:01Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20027: User not found by provider and username.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"bad_attempts_since_last_success_or_reset":{"type":"integer"},"last_failure_date":{"type":"string","format":"date-time"},"username":{"type":"string"}}},"roles":[{"role":"CanReadUserLockedStatus","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/PROVIDER/USERNAME/lock-status","connector_methods":[]},{"operation_id":"OBPv5.1.0-getUserByProviderAndUsername","implemented_by":{"version":"OBPv5.1.0","function":"getUserByProviderAndUsername"},"request_verb":"GET","request_url":"/obp/v5.1.0/users/provider/PROVIDER/username/USERNAME","summary":"Get User by USERNAME","description":"Get user by PROVIDER and USERNAME
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nCanGetAnyUser entitlement is required,
\nURL Parameters:
\nPROVIDER: ETHEREUM
\nUSERNAME: felixsmith
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\n\n\n\nis_deleted: is_deleted
\nis_locked: is_locked
\nlist:
\nprovider: ETHEREUM
\n\n\ntext:
\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nview_id: owner
\nagreements: agreements
\nlast_marketing_agreement_signed_date: last_marketing_agreement_signed_date
\n\n","description_markdown":"Get user by PROVIDER and USERNAME\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\nCanGetAnyUser entitlement is required,\n\n\n**URL Parameters:**\n\n[PROVIDER](/glossary#provider): ETHEREUM\n\n\n\n[USERNAME](/glossary#): felixsmith\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**email**](/glossary#): felixsmith@example.com\n\n\n\n[**entitlement_id**](/glossary#entitlement_id): \n\n\n\n[**entitlements**](/glossary#entitlements): \n\n\n\n[**is_deleted**](/glossary#): is_deleted\n\n\n\n[**is_locked**](/glossary#): is_locked\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**text**](/glossary#text): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[agreements](/glossary#): agreements\n\n\n\n[last_marketing_agreement_signed_date](/glossary#): last_marketing_agreement_signed_date\n\n\n\n[views](/glossary#views): \n\n\n","success_response_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","email":"felixsmith@example.com","provider_id":"Chris","provider":"http://127.0.0.1:8080","username":"felixsmith","entitlements":{"list":[{"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723","role_name":"CanQueryOtherUser","bank_id":"gh.29.uk"}]},"views":{"list":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}]},"agreements":[{"type":"","text":""}],"is_deleted":false,"last_marketing_agreement_signed_date":"1099-12-31T21:00:00Z","is_locked":false},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-20027: User not found by provider and username.","OBP-50000: Unknown Error."],"tags":["User"],"typed_success_response_body":{"type":"object","properties":{"provider":{"type":"string"},"email":{"type":"string"},"provider_id":{"type":"string"},"agreements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"text":{"type":"string"}}}},"entitlements":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"role_name":{"type":"string"},"bank_id":{"type":"string"},"entitlement_id":{"type":"string"}}}}}},"is_deleted":{"type":"boolean"},"is_locked":{"type":"boolean"},"username":{"type":"string"},"last_marketing_agreement_signed_date":{"type":"string","format":"date-time"},"views":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}}}},"user_id":{"type":"string"}}},"roles":[{"role":"CanGetAnyUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/users/provider/PROVIDER/username/USERNAME","connector_methods":[]},{"operation_id":"OBPv4.0.0-createEndpointMapping","implemented_by":{"version":"OBPv4.0.0","function":"createEndpointMapping"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/endpoint-mappings","summary":"Create Endpoint Mapping","description":"Create an Endpoint Mapping.
\nNote: at moment only support the dynamic endpoints
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"Create an Endpoint Mapping. \n\nNote: at moment only support the dynamic endpoints\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","example_request_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}}},"success_response_body":{"operation_id":"OBPv4.0.0-dynamicEndpoint_POST_account","request_mapping":{},"response_mapping":{"name":{"entity":"FooBar","field":"name","query":"number"},"balance":{"entity":"FashionBrand","field":"number","query":"number"}},"endpoint_mapping_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"},"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":["Endpoint-Mapping"],"typed_request_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}}}},"typed_success_response_body":{"type":"object","properties":{"operation_id":{"type":"string"},"request_mapping":{"type":"object","properties":{}},"response_mapping":{"type":"object","properties":{"name":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}},"balance":{"type":"object","properties":{"entity":{"type":"string"},"field":{"type":"string"},"query":{"type":"string"}}}}},"endpoint_mapping_id":{"type":"string"}}},"roles":[{"role":"CanCreateEndpointMapping","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/endpoint-mappings","connector_methods":[]},{"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://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/method_routings?active=true
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/method_routings?method_name=getBank
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/method_routings?active=true\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/management/method_routings?method_name=getBank\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv5.0.0-updateSystemView","implemented_by":{"version":"OBPv5.0.0","function":"updateSystemView"},"request_verb":"PUT","request_url":"/obp/v5.0.0/system-views/VIEW_ID","summary":"Update System View","description":"Update an existing view on a bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Update an existing view on a bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n\nThe json sent is the same as during view creation (above), with one difference: the 'name' field\nof a view is not editable (it is only set when a view is created)\n\n\n**URL Parameters:**\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_grant_access_to_views**](/glossary#): can_grant_access_to_views\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_revoke_access_to_views**](/glossary#): can_revoke_access_to_views\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","example_request_body":{"description":"this is for family","metadata_view":"owner","is_public":false,"is_firehose":false,"which_alias_to_use":"family","hide_metadata_if_alias_used":true,"allowed_actions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"],"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"]},"success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"],"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":true},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"typed_request_body":{"type":"object","properties":{"is_firehose":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"metadata_view":{"type":"string"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"which_alias_to_use":{"type":"string"},"allowed_actions":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"roles":[{"role":"CanUpdateSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv5.1.0-deleteAtm","implemented_by":{"version":"OBPv5.1.0","function":"deleteAtm"},"request_verb":"DELETE","request_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","summary":"Delete ATM","description":"Delete ATM.
\nThis will also delete all its attributes.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nATM_ID: atme-9a0f-4bfa-b30b-9003aa467f51
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Delete ATM.\n\nThis will also delete all its attributes.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ATM_ID](/glossary#atm_id): atme-9a0f-4bfa-b30b-9003aa467f51\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["ATM"],"roles":[{"role":"CanDeleteAtmAtAnyBank","requires_bank_id":false},{"role":"CanDeleteAtm","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/atms/ATM_ID","connector_methods":[]},{"operation_id":"OBPv2.0.0-addKycStatus","implemented_by":{"version":"OBPv2.0.0","function":"addKycStatus"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","summary":"Add KYC Status","description":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: false
\n","description_markdown":"Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**ok**](/glossary#ok): false\n\n\n","example_request_body":{"customer_number":"5987953","ok":true,"date":"1099-12-31T21:00:00Z"},"success_response_body":{"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","customer_number":"5987953","ok":true,"date":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-00004: Server error: could not add message","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_request_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_number":{"type":"string"},"ok":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"customer_id":{"type":"string"},"customer_number":{"type":"string"},"ok":{"type":"boolean"}}},"roles":[{"role":"CanAddKycStatus","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_statuses","connector_methods":[]},{"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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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:
\n","description_markdown":"Delete Bank Level Endpoint Tag.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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","success_response_body":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":[]},{"operation_id":"OBPv4.0.0-createUserCustomerLinks","implemented_by":{"version":"OBPv4.0.0","function":"createUserCustomerLinks"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/user_customer_links","summary":"Create User Customer Link","description":"Link a User to a Customer
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nis_active: false
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"Link a User to a Customer\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**date_inserted**](/glossary#date_inserted): \n\n\n\n[**is_active**](/glossary#is_active): false\n\n\n\n[**user_customer_link_id**](/glossary#user_customer_link_id): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n","example_request_body":{"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"success_response_body":{"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","date_inserted":"1099-12-31T21:00:00Z","is_active":true},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID","OBP-30025: Could not create user_customer_links ","OBP-50000: Unknown Error."],"tags":["Customer","User"],"typed_request_body":{"type":"object","properties":{"customer_id":{"type":"string"},"user_id":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_customer_link_id":{"type":"string"},"customer_id":{"type":"string"},"is_active":{"type":"boolean"},"user_id":{"type":"string"},"date_inserted":{"type":"string","format":"date-time"}}},"roles":[{"role":"CanCreateUserCustomerLinkAtAnyBank","requires_bank_id":false},{"role":"CanCreateUserCustomerLink","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/user_customer_links","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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\n","description_markdown":"Get all System Dynamic Entities \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.","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":"OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyOpenCorporatesUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","summary":"Delete Counterparty Open Corporates URL","description":"Delete open corporate url of other bank account
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete open corporate url of other bank account\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting an open corporate url","URL cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":[]},{"operation_id":"OBPv2.0.0-getKycDocuments","implemented_by":{"version":"OBPv2.0.0","function":"getKycDocuments"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_documents","summary":"Get Customer KYC Documents","description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
\nGet a list of documents that affirm the identity of the customer
\nPassport, driving licence etc.
\nUser Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\n\nexpiry_date: 2021-01-27
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nissue_date: 2020-01-27
\n\n\ntype:
\n","description_markdown":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID\nGet a list of documents that affirm the identity of the customer\nPassport, driving licence etc.\nUser Authentication is Optional. The User need not be logged in.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**customer_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**customer_number**](/glossary#): 5987953\n\n\n\n[**documents**](/glossary#documents): \n\n\n\n[**expiry_date**](/glossary#): 2021-01-27\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**issue_date**](/glossary#): 2020-01-27\n\n\n\n[**issue_place**](/glossary#issue_place): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**type**](/glossary#type): \n\n\n","success_response_body":{"documents":[{"bank_id":"gh.29.uk","customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","id":"PlaceholderString","customer_number":"5987953","type":"PlaceholderString","number":"PlaceholderString","issue_date":"1099-12-31T21:00:00Z","issue_place":"PlaceholderString","expiry_date":"1099-12-31T21:00:00Z"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["KYC","Customer"],"typed_success_response_body":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"issue_place":{"type":"string"},"customer_id":{"type":"string"},"expiry_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"number":{"type":"string"},"bank_id":{"type":"string"},"customer_number":{"type":"string"},"issue_date":{"type":"string","format":"date-time"},"id":{"type":"string"}}}}}},"roles":[{"role":"CanGetAnyKycDocuments","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/customers/CUSTOMER_ID/kyc_documents","connector_methods":[]},{"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
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv3.1.0-getTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"getTaxResidence"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residences","summary":"Get Tax Residences of Customer","description":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n\ntax_number: 456
\n\n\n","description_markdown":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**domain**](/glossary#domain): \n\n\n\n[**tax_number**](/glossary#tax_number): 456\n\n\n\n[**tax_residence**](/glossary#tax_residence): \n\n\n\n[**tax_residence_id**](/glossary#tax_residence_id): \n\n\n","success_response_body":{"tax_residence":[{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer","KYC"],"typed_success_response_body":{"type":"object","properties":{"tax_residence":{"type":"array","items":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residences","connector_methods":[]},{"operation_id":"OBPv4.0.0-getProductAttribute","implemented_by":{"version":"OBPv4.0.0","function":"getProductAttribute"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Get Product Attribute","description":"Get Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nGet one product attribute by its id.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nPRODUCT_CODE: 1234BW
\nJSON response body fields:
\nbank_id: gh.29.uk
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nis_active: false
\n","description_markdown":"Get Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nGet one product attribute by its id.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_ATTRIBUTE_ID](/glossary#product_attribute_id): \n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_attribute_id**](/glossary#product_attribute_id): \n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[is_active](/glossary#is_active): false\n\n\n","success_response_body":{"bank_id":"gh.29.uk","product_code":"1234BW","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","is_active":true},"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":["Product"],"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"product_attribute_id":{"type":"string"},"bank_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"is_active":{"type":"boolean"}}},"roles":[{"role":"CanUpdateProductAttribute","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteImageForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteImageForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","summary":"Delete a Transaction Image","description":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[IMAGE_ID](/glossary#image_id): \n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-20001: User not logged in. Authentication is required!","You must be able to see images in order to delete them","Image not found for this transaction","Deleting images not permitted for this view","Deleting images not permitted for the current user","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createTransactionRequestCard","implemented_by":{"version":"OBPv4.0.0","function":"createTransactionRequestCard"},"request_verb":"POST","request_url":"/obp/v4.0.0/transaction-request-types/CARD/transaction-requests","summary":"Create Transaction Request (CARD)","description":"When using CARD, the payee is set in the request body .
\nMoney goes into the Counterparty in the request body.
\nFor an introduction to Transaction Requests, see: here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCARD: CARD
\nJSON request body fields:
\namount: 10.12
\nbrand: Visa
\ncard: card
\ncard_number: 364435172576215
\ncard_type: Credit
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ncvv: 123
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nexpiry_month: 01
\nexpiry_year: 2023
\nname_on_card: SusanSmith
\nto:
\nvalue: 5987953
\nJSON response body fields:
\n\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nagent_number: 5987953
\n\namount: 10.12
\nbank_code: CGHZ
\nbank_id: gh.29.uk
\n\n\nchallenges: challenges
\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\n\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\n\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\n\n\nfrom:
\nfuture_date: 20200127
\niban: DE91 1000 0000 0123 4567 89
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\ninstructedAmount: 100
\n\nlegal_name: Eveline Tripman
\nlink:
\nmessage: 123456
\nmobile_phone_number: +49 30 901820
\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\notherAccountRoutingAddress: otherAccountRoutingAddress
\notherAccountRoutingScheme: otherAccountRoutingScheme
\notherAccountSecondaryRoutingAddress: otherAccountSecondaryRoutingAddress
\notherAccountSecondaryRoutingScheme: otherAccountSecondaryRoutingScheme
\notherBankRoutingAddress: otherBankRoutingAddress
\notherBankRoutingScheme: otherBankRoutingScheme
\notherBranchRoutingAddress: otherBranchRoutingAddress
\notherBranchRoutingScheme: otherBranchRoutingScheme
\nstart_date: 2020-01-27
\n\n\nto:
\n\n\ntype:
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nattributes: attribute value in form of (name, value)
\nto_agent: to_agent
\n\n\n\n\nto_simple: to_simple
\n\n\n\n","description_markdown":"When using CARD, the payee is set in the request body .\n\nMoney goes into the Counterparty in the request body.\n\n\n\nFor an introduction to Transaction Requests, see: [here](/glossary#Transaction-Request-Introduction)\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CARD](/glossary#): CARD\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**brand**](/glossary#): Visa\n\n\n\n[**card**](/glossary#): card\n\n\n\n[**card_number**](/glossary#): 364435172576215\n\n\n\n[**card_type**](/glossary#): Credit\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**cvv**](/glossary#): 123\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**expiry_month**](/glossary#): 01\n\n\n\n[**expiry_year**](/glossary#): 2023\n\n\n\n[**name_on_card**](/glossary#): SusanSmith\n\n\n\n[**to**](/glossary#to): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account**](/glossary#Account): \n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**allowed_attempts**](/glossary#allowed_attempts): 5\n\n\n\n[**amount**](/glossary#): 10.12\n\n\n\n[**bank_code**](/glossary#bank_code): CGHZ\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**branch_number**](/glossary#branch_number): \n\n\n\n[**challenge_type**](/glossary#challenge_type): \n\n\n\n[**challenges**](/glossary#): challenges\n\n\n\n[**charge**](/glossary#charge): \n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**creditorAccount**](/glossary#creditoraccount): \n\n\n\n[**creditorName**](/glossary#creditorname): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date_of_birth**](/glossary#): 2018-03-09\n\n\n\n[**debtorAccount**](/glossary#debtoraccount): \n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**details**](/glossary#details): \n\n\n\n[**end_date**](/glossary#end_date): \n\n\n\n[**from**](/glossary#from): \n\n\n\n[**future_date**](/glossary#future_date): 20200127\n\n\n\n[**iban**](/glossary#): DE91 1000 0000 0123 4567 89\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**instructedAmount**](/glossary#instructedamount): 100\n\n\n\n[**kyc_document**](/glossary#kyc_document): \n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**link**](/glossary#link): \n\n\n\n[**message**](/glossary#message): 123456\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**nickname**](/glossary#nickname): \n\n\n\n[**number**](/glossary#number): \n\n\n\n[**otherAccountRoutingAddress**](/glossary#): otherAccountRoutingAddress\n\n\n\n[**otherAccountRoutingScheme**](/glossary#): otherAccountRoutingScheme\n\n\n\n[**otherAccountSecondaryRoutingAddress**](/glossary#): otherAccountSecondaryRoutingAddress\n\n\n\n[**otherAccountSecondaryRoutingScheme**](/glossary#): otherAccountSecondaryRoutingScheme\n\n\n\n[**otherBankRoutingAddress**](/glossary#): otherBankRoutingAddress\n\n\n\n[**otherBankRoutingScheme**](/glossary#): otherBankRoutingScheme\n\n\n\n[**otherBranchRoutingAddress**](/glossary#): otherBranchRoutingAddress\n\n\n\n[**otherBranchRoutingScheme**](/glossary#): otherBranchRoutingScheme\n\n\n\n[**start_date**](/glossary#): 2020-01-27\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**summary**](/glossary#summary): \n\n\n\n[**to**](/glossary#to): \n\n\n\n[**transaction_ids**](/glossary#transaction_ids): \n\n\n\n[**transfer_type**](/glossary#transfer_type): \n\n\n\n[**type**](/glossary#type): \n\n\n\n[**user_id**](/glossary#): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[attributes](/glossary#attributes): attribute value in form of (name, value)\n\n\n\n[to_agent](/glossary#): to_agent\n\n\n\n[to_counterparty](/glossary#to_counterparty): \n\n\n\n[to_sandbox_tan](/glossary#to_sandbox_tan): \n\n\n\n[to_sepa](/glossary#to_sepa): \n\n\n\n[to_sepa_credit_transfers](/glossary#to_sepa_credit_transfers): \n\n\n\n[to_simple](/glossary#): to_simple\n\n\n\n[to_transfer_to_account](/glossary#to_transfer_to_account): \n\n\n\n[to_transfer_to_atm](/glossary#to_transfer_to_atm): \n\n\n\n[to_transfer_to_phone](/glossary#to_transfer_to_phone): \n\n\n","example_request_body":{"card":{"card_type":"Credit","brand":"Visa","cvv":"123","card_number":"364435172576215","name_on_card":"SusanSmith","expiry_year":"2023","expiry_month":"01"},"to":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"value":{"currency":"EUR","amount":"0"},"description":"A card payment description. "},"success_response_body":{"id":"4050046c-63b3-4868-8a22-14b4181d33a6","type":"SANDBOX_TAN","from":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"},"details":{"to_sandbox_tan":{"bank_id":"String","account_id":"String"},"to_sepa":{"iban":"String"},"to_counterparty":{"counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"},"to_simple":{"otherBankRoutingScheme":"BIC","otherBankRoutingAddress":"GENODEM1GLS","otherBranchRoutingScheme":"BRANCH-CODE","otherBranchRoutingAddress":"DERBY6","otherAccountRoutingScheme":"IBAN","otherAccountRoutingAddress":"DE91 1000 0000 0123 4567 89","otherAccountSecondaryRoutingScheme":"IBAN","otherAccountSecondaryRoutingAddress":"DE91 1000 0000 0123 4567 89"},"to_transfer_to_phone":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"mobile_phone_number":"+44 07972 444 876"}},"to_transfer_to_atm":{"value":{"currency":"EUR","amount":"0"},"description":"String","message":"String","from":{"mobile_phone_number":"+44 07972 444 876","nickname":"String"},"to":{"legal_name":"Eveline Tripman","date_of_birth":"20181230","mobile_phone_number":"+44 07972 444 876","kyc_document":{"type":"String","number":"String"}}},"to_transfer_to_account":{"value":{"currency":"EUR","amount":"0"},"description":"String","transfer_type":"String","future_date":"20181230","to":{"name":"String","bank_code":"String","branch_number":"String","account":{"number":"String","iban":"String"}}},"to_sepa_credit_transfers":{"debtorAccount":{"iban":"12345"},"instructedAmount":{"currency":"EUR","amount":"0"},"creditorAccount":{"iban":"54321"},"creditorName":"John Miles"},"to_agent":{"bank_id":"gh.29.uk","agent_number":"5987953"},"value":{"currency":"EUR","amount":"100"},"description":"Description of the object. Maximum length is 2000. It can be any characters here."},"transaction_ids":["902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"],"status":"COMPLETED","start_date":"1099-12-31T21:00:00Z","end_date":"1099-12-31T21:00:00Z","challenges":[{"id":"2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","allowed_attempts":3,"challenge_type":"OBP_TRANSACTION_REQUEST_CHALLENGE","link":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge"}],"charge":{"summary":"Rent the flat","value":{"currency":"EUR","amount":"0"}},"attributes":[{"name":"ACCOUNT_MANAGEMENT_FEE","value":"5987953"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-10001: Incorrect json format.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-40002: Insufficient authorisation to create TransactionRequest. The Transaction Request could not be created because the login user doesn't have access to the view of the from account or the consumer doesn't have the access to the view of the from account or the login user does not have the `CanCreateAnyTransactionRequest` role or the view does not have the permission can_add_transaction_request_to_any_account or the view does not have the permission can_add_transaction_request_to_beneficiary.","OBP-40001: Invalid value for TRANSACTION_REQUEST_TYPE","OBP-10001: Incorrect json format.","OBP-10002: Invalid Number. Could not convert value to a number.","OBP-40008: Can't send a payment with a value of 0 or less.","OBP-40003: Transaction Request Currency must be the same as From Account Currency.","OBP-00003: Transaction Requests is disabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"card":{"type":"object","properties":{"card_number":{"type":"string"},"cvv":{"type":"string"},"card_type":{"type":"string"},"name_on_card":{"type":"string"},"brand":{"type":"string"},"expiry_month":{"type":"string"},"expiry_year":{"type":"string"}}},"to":{"type":"object","properties":{"counterparty_id":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"type":{"type":"string"},"challenges":{"type":"array","items":{"type":"object","properties":{"challenge_type":{"type":"string"},"link":{"type":"string"},"id":{"type":"string"},"allowed_attempts":{"type":"integer"},"user_id":{"type":"string"}}}},"status":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"charge":{"type":"object","properties":{"summary":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"transaction_ids":{"type":"array","items":{"type":"string"}},"from":{"type":"object","properties":{"bank_id":{"type":"string"},"account_id":{"type":"string"}}},"details":{"type":"object","properties":{"to_sandbox_tan":{"type":"object","properties":{"account_id":{"type":"string"},"bank_id":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to_transfer_to_phone":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"to":{"type":"object","properties":{"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa":{"type":"object","properties":{"iban":{"type":"string"}}},"to_simple":{"type":"object","properties":{"otherBankRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingAddress":{"type":"string"},"otherBranchRoutingScheme":{"type":"string"},"otherAccountRoutingScheme":{"type":"string"},"otherAccountRoutingAddress":{"type":"string"},"otherBankRoutingScheme":{"type":"string"},"otherBranchRoutingAddress":{"type":"string"},"otherAccountSecondaryRoutingScheme":{"type":"string"}}},"to_counterparty":{"type":"object","properties":{"counterparty_id":{"type":"string"}}},"to_agent":{"type":"object","properties":{"bank_id":{"type":"string"},"agent_number":{"type":"string"}}},"description":{"type":"string"},"to_transfer_to_account":{"type":"object","properties":{"to":{"type":"object","properties":{"name":{"type":"string"},"account":{"type":"object","properties":{"number":{"type":"string"},"iban":{"type":"string"}}},"bank_code":{"type":"string"},"branch_number":{"type":"string"}}},"transfer_type":{"type":"string"},"description":{"type":"string"},"future_date":{"type":"string"},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}}}},"to_sepa_credit_transfers":{"type":"object","properties":{"instructedAmount":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"debtorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorAccount":{"type":"object","properties":{"iban":{"type":"string"}}},"creditorName":{"type":"string"}}},"to_transfer_to_atm":{"type":"object","properties":{"description":{"type":"string"},"message":{"type":"string"},"from":{"type":"object","properties":{"nickname":{"type":"string"},"mobile_phone_number":{"type":"string"}}},"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"to":{"type":"object","properties":{"date_of_birth":{"type":"string"},"kyc_document":{"type":"object","properties":{"type":{"type":"string"},"number":{"type":"string"}}},"legal_name":{"type":"string"},"mobile_phone_number":{"type":"string"}}}}}}},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/transaction-request-types/CARD/transaction-requests","connector_methods":[]},{"operation_id":"OBPv1.2.1-deleteCounterpartyUrl","implemented_by":{"version":"OBPv1.2.1","function":"deleteCounterpartyUrl"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","summary":"Delete url of other bank account","description":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\n\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"User Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[OTHER_ACCOUNT_ID](/glossary#other_account_id): \n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","the view does not allow metadata access","the view does not allow deleting a url","URL cannot be deleted","OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":[]},{"operation_id":"OBPv2.0.0-publicAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/public","summary":"Get Public Accounts at Bank","description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\nbank_id: gh.29.uk
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nlabel: My Account
\n\n\n","description_markdown":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.\n\nUser Authentication is Optional. The User need not be logged in.\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[**accounts**](/glossary#accounts): \n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**label**](/glossary#): My Account\n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views_available**](/glossary#views_available): \n\n\n","success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/public","connector_methods":[]},{"operation_id":"OBPv1.4.0-getBankLevelDynamicResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getBankLevelDynamicResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/resource-docs/API_VERSION/obp","summary":"Get Bank Level Dynamic Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
\nYou can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
\nSee the Resource Doc endpoint for more information.
\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds
\nStatic Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic\n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n\n You may need some other language resource docs, now we support en_GB and es_ES at the moment.\n \n You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters. \n\nSee the Resource Doc endpoint for more information.\n\nNote: Dynamic Resource Docs are cached, TTL is 3600 seconds\n Static Resource Docs are cached, TTL is 3600 seconds\n\n\nFollowing are more examples:\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all\nhttps://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221\n\nUpdate Transaction Request Attribute
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Update Transaction Request Attribute\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"HOUSE_RENT","attribute_type":"STRING","value":"123456789"},"success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"STRING","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_request_body":{"type":"object","properties":{"attribute_type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanUpdateTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-createCounterparty","implemented_by":{"version":"OBPv4.0.0","function":"createCounterparty"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Create Counterparty (Explicit)","description":"This endpoint creates an (Explicit) Counterparty for an Account.
\nFor an introduction to Counterparties in OBP see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\ncurrency: EUR
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nis_beneficiary: false
\nkey: CustomerNumber
\nname: ACCOUNT_MANAGEMENT_FEE
\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\nvalue: 5987953
\nJSON response body fields:
\n\n\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\ncurrency: EUR
\ndate: 2020-01-27
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\n\nis_beneficiary: false
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\n\nmore_info: More information about this fee
\nname: ACCOUNT_MANAGEMENT_FEE
\n\nother_account_routing_address: DE89370400440532013000
\nother_account_routing_scheme: IBAN
\nother_account_secondary_routing_address:
\nother_account_secondary_routing_scheme:
\n\n\n\n\n\n\nprovider: ETHEREUM
\n\n\n\n\nurl: http://www.example.com/id-docs/123/image.png
\nuser:
\nusername: felixsmith
\nvalue: 5987953
\n","description_markdown":"This endpoint creates an (Explicit) Counterparty for an Account.\n\nFor an introduction to Counterparties in OBP see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bespoke**](/glossary#bespoke): \n\n\n\n[**corporate_location**](/glossary#corporate_location): 10\n\n\n\n[**counterparty_id**](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**created_by_user_id**](/glossary#created_by_user_id): \n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**image_url**](/glossary#image_url): \n\n\n\n[**is_beneficiary**](/glossary#): false\n\n\n\n[**key**](/glossary#): CustomerNumber\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**metadata**](/glossary#metadata): \n\n\n\n[**more_info**](/glossary#more_info): More information about this fee\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**open_corporates_url**](/glossary#open_corporates_url): \n\n\n\n[**other_account_routing_address**](/glossary#other_account_routing_address): DE89370400440532013000\n\n\n\n[**other_account_routing_scheme**](/glossary#other_account_routing_scheme): IBAN\n\n\n\n[**other_account_secondary_routing_address**](/glossary#other_account_secondary_routing_address): \n\n\n\n[**other_account_secondary_routing_scheme**](/glossary#other_account_secondary_routing_scheme): \n\n\n\n[**other_bank_routing_address**](/glossary#other_bank_routing_address): \n\n\n\n[**other_bank_routing_scheme**](/glossary#other_bank_routing_scheme): \n\n\n\n[**other_branch_routing_address**](/glossary#other_branch_routing_address): \n\n\n\n[**other_branch_routing_scheme**](/glossary#other_branch_routing_scheme): \n\n\n\n[**physical_location**](/glossary#physical_location): \n\n\n\n[**private_alias**](/glossary#private_alias): \n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**public_alias**](/glossary#public_alias): \n\n\n\n[**this_account_id**](/glossary#this_account_id): \n\n\n\n[**this_bank_id**](/glossary#this_bank_id): \n\n\n\n[**this_view_id**](/glossary#this_view_id): \n\n\n\n[**url**](/glossary#): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**username**](/glossary#): felixsmith\n\n\n\n[**value**](/glossary#): 5987953\n\n\n","example_request_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}]},"success_response_body":{"name":"CounterpartyName","description":"My landlord","currency":"EUR","created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","this_bank_id":"gh.29.uk","this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","this_view_id":"owner","counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh","other_bank_routing_scheme":"OBP","other_bank_routing_address":"gh.29.uk","other_branch_routing_scheme":"OBP","other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e","other_account_routing_scheme":"IBAN","other_account_routing_address":"DE89370400440532013000","other_account_secondary_routing_scheme":"IBAN","other_account_secondary_routing_address":"DE89370400440532013000","is_beneficiary":true,"bespoke":[{"key":"englishName","value":"english Name"}],"metadata":{"public_alias":"String","more_info":"String","url":"String","image_url":"String","open_corporates_url":"String","corporate_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1099-12-31T21:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"private_alias":"String"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-10001: Incorrect json format.","OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"typed_request_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"bespoke":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"created_by_user_id":{"type":"string"},"other_account_routing_address":{"type":"string"},"name":{"type":"string"},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"type":"string"},"currency":{"type":"string"},"other_account_secondary_routing_address":{"type":"string"},"counterparty_id":{"type":"string"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"corporate_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"image_url":{"type":"string"}}},"other_account_routing_scheme":{"type":"string"},"description":{"type":"string"},"other_bank_routing_address":{"type":"string"},"other_branch_routing_scheme":{"type":"string"},"this_account_id":{"type":"string"},"other_account_secondary_routing_scheme":{"type":"string"},"is_beneficiary":{"type":"boolean"},"other_branch_routing_address":{"type":"string"},"this_view_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountAttribute","implemented_by":{"version":"OBPv3.1.0","function":"createAccountAttribute"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attribute","summary":"Create Account Attribute","description":"Create Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nPRODUCT_CODE: 1234BW
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\nJSON response body fields:
\n\nname: ACCOUNT_MANAGEMENT_FEE
\nproduct_code: 1234BW
\ntype:
\nvalue: 5987953
\nproduct_instance_code: product_instance_code
\n","description_markdown":"Create Account Attribute\n\n\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Account Attribute is linked to its Account by ACCOUNT_ID\n\n\n \n\nTypical account attributes might be:\n\nISIN (for International bonds)\nVKN (for German bonds)\nREDCODE (markit short code for credit derivative)\nLOAN_ID (e.g. used for Anacredit reporting)\n\nISSUE_DATE (When the bond was issued in the market)\nMATURITY_DATE (End of life time of a product)\nTRADABLE\n\nSee [FPML](http://www.fpml.org/) for more examples.\n\nThe type field must be one of \"STRING\", \"INTEGER\", \"DOUBLE\" or DATE_WITH_DAY\"\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[PRODUCT_CODE](/glossary#product_code): 1234BW\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_attribute_id**](/glossary#account_attribute_id): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**product_code**](/glossary#product_code): 1234BW\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n\n[product_instance_code](/glossary#): product_instance_code\n\n\n","example_request_body":{"name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"},"success_response_body":{"product_code":"1234BW","account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23","product_instance_code":"LKJL98769F"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"value":{"type":"string"},"product_code":{"type":"string"},"account_attribute_id":{"type":"string"},"product_instance_code":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"}}},"roles":[{"role":"CanCreateAccountAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attribute","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete a MethodRouting specified by METHOD_ROUTING_ID.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":[]},{"operation_id":"OBPv4.0.0-createBankLevelDynamicMessageDoc","implemented_by":{"version":"OBPv4.0.0","function":"createBankLevelDynamicMessageDoc"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/dynamic-message-docs","summary":"Create Bank Level Dynamic Message Doc","description":"Create a Bank Level Dynamic Message Doc.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\nJSON response body fields:
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nprocess: obp.getBank
\n","description_markdown":"Create a Bank Level Dynamic Message Doc.\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**process**](/glossary#process): obp.getBank\n\n\n","example_request_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"success_response_body":{"outbound_avro_schema":"","inbound_avro_schema":"","adapter_implementation":"","dynamic_message_doc_id":"","description":"Description of the object. Maximum length is 2000. It can be any characters here.","process":"obp.getBank","outbound_topic":"","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","message_format":"","example_outbound_message":{},"inbound_topic":"","example_inbound_message":{},"bank_id":"gh.29.uk","programming_lang":"Scala"},"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-Message-Doc"],"typed_request_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"example_outbound_message":{"type":"object","properties":{}},"outbound_topic":{"type":"string"},"example_inbound_message":{"type":"object","properties":{}},"bank_id":{"type":"string"},"inbound_topic":{"type":"string"},"programming_lang":{"type":"string"},"dynamic_message_doc_id":{"type":"string"},"process":{"type":"string"},"outbound_avro_schema":{"type":"string"},"method_body":{"type":"string"},"description":{"type":"string"},"message_format":{"type":"string"},"adapter_implementation":{"type":"string"},"inbound_avro_schema":{"type":"string"}}},"roles":[{"role":"CanCreateBankLevelDynamicMessageDoc","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/banks/BANK_ID/dynamic-message-docs","connector_methods":[]},{"operation_id":"OBPv2.2.0-getCurrentFxRate","implemented_by":{"version":"OBPv2.2.0","function":"getCurrentFxRate"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE","summary":"Get Current FxRate","description":"Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
\nOBP may try different sources of FX rate information depending on the Connector in operation.
\nFor example we want to convert EUR => USD:
\nOBP will:
\n1st try - Connector (database, core banking system or external FX service)
\n2nd try part 1 - fallbackexchangerates/eur.json
\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
\n3rd try - Hardcoded map of FX rates.
![\"FX](\"https://user-images.githubusercontent.com/485218/60005085-1eded600-966e-11e9-96fb-798b102d9ad0.png\")
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nTO_CURRENCY_CODE: EUR
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\n\n\nto_currency_code: EUR
\n","description_markdown":"Get the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE\n\nOBP may try different sources of FX rate information depending on the Connector in operation.\n\nFor example we want to convert EUR => USD:\n\nOBP will:\n1st try - Connector (database, core banking system or external FX service)\n2nd try part 1 - fallbackexchangerates/eur.json\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)\n3rd try - Hardcoded map of FX rates.\n\n\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[FROM_CURRENCY_CODE](/glossary#from_currency_code): \n\n\n\n[TO_CURRENCY_CODE](/glossary#to_currency_code): EUR\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**conversion_value**](/glossary#conversion_value): 100\n\n\n\n[**effective_date**](/glossary#effective_date): 2020-01-27\n\n\n\n[**from_currency_code**](/glossary#from_currency_code): \n\n\n\n[**inverse_conversion_value**](/glossary#inverse_conversion_value): 50\n\n\n\n[**to_currency_code**](/glossary#to_currency_code): EUR\n\n\n","success_response_body":{"bank_id":"gh.29.uk","from_currency_code":"EUR","to_currency_code":"GBP","conversion_value":1.001,"inverse_conversion_value":0.998,"effective_date":"1099-12-31T21:00:00Z"},"error_response_bodies":["OBP-10003: Invalid Currency Value. Expected a 3-letter ISO Currency Code (e.g., 'USD', 'EUR'), 'lovelace' (Cardano), or 'ETH' (Ethereum). Refer to ISO 4217 currency codes: https://www.iso.org/iso-4217-currency-codes.html","OBP-20001: User not logged in. Authentication is required!","OBP-10004: ISO Currency code combination not supported for FX. Please modify the FROM_CURRENCY_CODE or TO_CURRENCY_CODE. ","OBP-50000: Unknown Error."],"tags":["FX"],"typed_success_response_body":{"type":"object","properties":{"to_currency_code":{"type":"string"},"from_currency_code":{"type":"string"},"bank_id":{"type":"string"},"inverse_conversion_value":{"type":"number"},"effective_date":{"type":"string","format":"date-time"},"conversion_value":{"type":"number"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE","connector_methods":[]},{"operation_id":"OBPv5.0.0-getSystemView","implemented_by":{"version":"OBPv5.0.0","function":"getSystemView"},"request_verb":"GET","request_url":"/obp/v5.0.0/system-views/VIEW_ID","summary":"Get System View","description":"Get System View
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nVIEW_ID: owner
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n","description_markdown":"Get System View\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_grant_access_to_views**](/glossary#): can_grant_access_to_views\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_revoke_access_to_views**](/glossary#): can_revoke_access_to_views\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","success_response_body":{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"],"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":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-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["View-System"],"typed_success_response_body":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}},"roles":[{"role":"CanGetSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/system-views/VIEW_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-deleteExplicitCounterparty","implemented_by":{"version":"OBPv4.0.0","function":"deleteExplicitCounterparty"},"request_verb":"POST","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Delete Counterparty (Explicit)","description":"This endpoint deletes the Counterparty on the Account / View specified by the COUNTERPARTY_ID.
\nIt also deletes any related Counterparty Metadata.
The User calling this endpoint must have access to the View specified in the URL and that View must have the permission can_delete_counterparty.
For a general introduction to Counterparties in OBP see here
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nCOUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"This endpoint deletes the Counterparty on the Account / View specified by the COUNTERPARTY_ID.\nIt also deletes any related Counterparty Metadata.\n\nThe User calling this endpoint must have access to the View specified in the URL and that View must have the permission `can_delete_counterparty`.\n\nFor a general introduction to Counterparties in OBP see [here](/glossary#Counterparties)\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[COUNTERPARTY_ID](/glossary#): 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["Counterparty","Account"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","connector_methods":[]},{"operation_id":"OBPv3.1.0-answerConsentChallenge","implemented_by":{"version":"OBPv3.1.0","function":"answerConsentChallenge"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge","summary":"Answer Consent Challenge","description":"An OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
This endpoint is used to confirm a Consent previously created.
\nThe User must supply a code that was sent out of band (OOB) for example via an SMS.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCONSENT_ID: 9d429899-24f5-42c8-8565-943ffa6a7947
\nJSON request body fields:
\n\nJSON response body fields:
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\n","description_markdown":"An OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, rejected, REVOKED, EXPIRED, received, valid, revokedByPsu, expired, terminatedByTpp, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\n\nThis endpoint is used to confirm a Consent previously created.\n\nThe User must supply a code that was sent out of band (OOB) for example via an SMS.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[CONSENT_ID](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**answer**](/glossary#answer): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n","example_request_body":{"answer":"12345678"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"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-10001: Incorrect json format.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_request_body":{"type":"object","properties":{"answer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge","connector_methods":[]},{"operation_id":"OBPv4.0.0-createUserWithRoles","implemented_by":{"version":"OBPv4.0.0","function":"createUserWithRoles"},"request_verb":"POST","request_url":"/obp/v4.0.0/user-entitlements","summary":"Create (DAuth) User with Roles","description":"This endpoint is used as part of the DAuth solution to grant Entitlements for Roles to a smart contract on the blockchain.
\nPut the smart contract address in username
\nFor provider use "dauth"
\nThis endpoint will create the User with username and provider if the User does not already exist.
\nThen it will create Entitlements i.e. grant Roles to the User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\ni.e. Entitlements are used to create / consume system or bank level resources where as views / account access are used to consume / create customer level resources.
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nNote: The Roles actually granted will depend on the Roles that the calling user has.
\nIf you try to grant Entitlements to a user that already exist (duplicate entitilements) you will get an error.
\nFor information about DAuth see below:
\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n) your-RSA-key-pair
\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nbank_id: gh.29.uk
\nprovider: ETHEREUM
\n\nroles: CanCreateMyUser
\nusername: felixsmith
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\nlist:
\n\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\n","description_markdown":"This endpoint is used as part of the DAuth solution to grant Entitlements for Roles to a smart contract on the blockchain.\n\nPut the smart contract address in username\n\nFor provider use \"dauth\"\n\nThis endpoint will create the User with username and provider if the User does not already exist.\n\nThen it will create Entitlements i.e. grant Roles to the User.\n\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)\n\ni.e. Entitlements are used to create / consume system or bank level resources where as views / account access are used to consume / create customer level resources.\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\nNote: The Roles actually granted will depend on the Roles that the calling user has.\n\nIf you try to grant Entitlements to a user that already exist (duplicate entitilements) you will get an error.\n\nFor information about DAuth see below:\n\n\nDAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User".
\nIn the future, it might be possible to be more specific and pin specific actors (wallets) that are acting within the smart contract, but so far, one smart contract acts on behalf of one User.
\nThus, if a smart contract "X" calls the OBP API using the DAuth header, OBP will get or create a user called X and the call will proceed in the context of that User "X".
\nDAuth is invoked by the REST client (caller) including a specific header (see step 3 below) in any OBP REST call.
\nWhen OBP receives the DAuth token, it creates or gets a User with a username based on the smart_contract_address and the provider based on the network_name. The combination of username and provider is unique in OBP.
\nIf you are calling OBP-API via an API3 Airnode, the Airnode will take care of constructing the required header.
\nWhen OBP detects a DAuth header / token it first checks if the Consumer is allowed to make such a call. OBP will validate the Consumer ip address and signature etc.
\nNote: The DAuth flow does not require an explicit POST like Direct Login to create the token.
\nPermissions may be assigned to an OBP User at any time, via the UserAuthContext, Views, Entitlements to Roles or Consents.
\nNote: DAuth is NOT enabled on this instance!
\nNote: The DAuth client is responsible for creating a token which will be trusted by OBP absolutely!
\nTo use DAuth:
\nSet up properties in your props file
\n# -- DAuth --------------------------------------\n# Define secret used to validate JWT token\n# jwt.public_key_rsa=path-to-the-pem-file\n# Enable/Disable DAuth communication at all\n# In case isn't defined default value is false\n# allow_dauth=false\n# Define comma separated list of allowed IP addresses\n# dauth.host=127.0.0.1\n# -------------------------------------- DAuth--\nPlease keep in mind that property jwt.public_key_rsa is used to validate JWT token to check it is not changed or corrupted during transport.
\nThe following videos are available:
\n* DAuth in local environment
HEADER:ALGORITHM & TOKEN TYPE
\n{\n "alg": "RS256",\n "typ": "JWT"\n}\nPAYLOAD:DATA
\n{\n "smart_contract_address": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "network_name": "AIRNODE.TESTNET.ETHEREUM",\n "msg_sender": "0xe12340927f1725E7734CE288F8367e1Bb143E90fhku767",\n "consumer_key": "0x1234a4ec31e89cea54d1f125db7536e874ab4a96b4d4f6438668b6bb10a6adb",\n "timestamp": "2021-11-04T14:13:40Z",\n "request_id": "0Xe876987694328763492876348928736497869273649"\n}\nVERIFY SIGNATURE
\nRSASHA256(\n base64UrlEncode(header) + "." +\n base64UrlEncode(payload),\n\n) your-RSA-key-pair\nHere is an example token:
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k\nUsing your favorite http client:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current
\nBody
\nLeave Empty!
\nHeaders:
\n DAuth: your-jwt-from-step-above\nHere is it all together:
\nGET https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current HTTP/1.1
\nHost: localhost:8080
\nUser-Agent: curl/7.47.0
\nAccept: /
\nDAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k
CURL example
\ncurl -v -H 'DAuth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFydF9jb250cmFjdF9hZGRyZXNzIjoiMHhlMTIzNDI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGJiM0YwNTEyMjQiLCJuZXR3b3JrX25hbWUiOiJFVEhFUkVVTSIsIm1zZ19zZW5kZXIiOiIweGUxMjM0MDkyN2YxNzI1RTc3MzRDRTI4OEY4MzY3ZTFCYjE0M0U5MGZoa3U3NjciLCJjb25zdW1lcl9rZXkiOiIweDEyMzRhNGVjMzFlODljZWE1NGQxZjEyNWRiNzUzNmU4NzRhYjRhOTZiNGQ0ZjY0Mzg2NjhiNmJiMTBhNmFkYiIsInRpbWVzdGFtcCI6IjIwMjEtMTEtMDRUMTQ6MTM6NDBaIiwicmVxdWVzdF9pZCI6IjBYZTg3Njk4NzY5NDMyODc2MzQ5Mjg3NjM0ODkyODczNjQ5Nzg2OTI3MzY0OSJ9.XSiQxjEVyCouf7zT8MubEKsbOBZuReGVhnt9uck6z6k' https://obp-api-sandbox.nmbbank.co.tz/obp/v3.0.0/users/current\nYou should receive a response like:
\n{\n "user_id": "4c4d3175-1e5c-4cfd-9b08-dcdc209d8221",\n "email": "",\n "provider_id": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "provider": "ETHEREUM",\n "username": "0xe123425E7734CE288F8367e1Bb143E90bb3F051224",\n "entitlements": {\n "list": []\n }\n}\nThe file, dauth.scala handles the DAuth,
\nWe:
\n-> Check if Props allow_dauth is true\n -> Check if DAuth header exists\n -> Check if getRemoteIpAddress is OK\n -> Look for "token"\n -> parse the JWT token and getOrCreate the user\n -> get the data of the user\nParameter names and values are case sensitive.
\nEach parameter MUST NOT appear more than once per request.
Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
\nIt represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
\nUser Authentication is Optional. The User need not be logged in.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\ndate: 2020-01-27
\n\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nlatitude: 38.8951
\nlongitude: -77.0364
\nprovider: ETHEREUM
\nuser:
\n\n","description_markdown":"Returns the \"where\" Geo tag added to the transaction TRANSACTION_ID made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\nIt represents the location where the transaction has been initiated.\n\nAuthentication via OAuth is required if the view is not public.\n\nUser Authentication is Optional. The User need not be logged in.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**display_name**](/glossary#display_name): \n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**latitude**](/glossary#latitude): 38.8951\n\n\n\n[**longitude**](/glossary#longitude): -77.0364\n\n\n\n[**provider**](/glossary#provider): ETHEREUM\n\n\n\n[**user**](/glossary#User): \n\n\n\n[**where**](/glossary#where): \n\n\n","success_response_body":{"where":{"latitude":1.231,"longitude":1.231,"date":"1099-12-31T21:00:00Z","user":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","provider":"http://127.0.0.1:8080","display_name":"OBP"}}},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission:","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction"],"typed_success_response_body":{"type":"object","properties":{"where":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":[]},{"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.
\nglossary-item-not-found
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nglossary-item-not-found\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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-getTransactionRequestAttributeById","implemented_by":{"version":"OBPv4.0.0","function":"getTransactionRequestAttributeById"},"request_verb":"GET","request_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","summary":"Get Transaction Request Attribute By Id","description":"Get Transaction Request Attribute By Id
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\n\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nJSON response body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\ntransaction_request_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ntype:
\nvalue: 5987953
\n","description_markdown":"Get Transaction Request Attribute By Id\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[ATTRIBUTE_ID](/glossary#Adapter.card_attribute_id): \n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TRANSACTION_REQUEST_ID](/glossary#): 8138a7e4-6d02-40e3-a129-0b2bf89de9f1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**transaction_request_attribute_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**type**](/glossary#type): \n\n\n\n[**value**](/glossary#): 5987953\n\n\n","success_response_body":{"transaction_request_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","name":"HOUSE_RENT","type":"STRING","value":"123456789"},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Transaction-Request"],"typed_success_response_body":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"transaction_request_attribute_id":{"type":"string"},"value":{"type":"string"}}},"roles":[{"role":"CanGetTransactionRequestAttributeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/transaction-requests/TRANSACTION_REQUEST_ID/attributes/ATTRIBUTE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-buildDynamicEndpointTemplate","implemented_by":{"version":"OBPv4.0.0","function":"buildDynamicEndpointTemplate"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/dynamic-resource-docs/endpoint-code","summary":"Create Dynamic Resource Doc endpoint code","description":"Create a Dynamic Resource Doc endpoint code.
\ncopy the response and past to PractiseEndpoint, So you can have the benefits of
\nauto compilation and debug
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON request body fields:
\nname: ACCOUNT_MANAGEMENT_FEE
\nJSON response body fields:
\ncode: 125
\n","description_markdown":"Create a Dynamic Resource Doc endpoint code.\n\ncopy the response and past to PractiseEndpoint, So you can have the benefits of\nauto compilation and debug\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**JSON request body fields:**\n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**code**](/glossary#code): 125\n\n\n","example_request_body":{"request_verb":"POST","request_url":"/my_user/MY_USER_ID","example_request_body":{"name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]},"success_response_body":{"my_user_id":"some_id_value","name":"Jhon","age":12,"hobby":["coding"],"_optional_fields_":["hobby"]}},"success_response_body":{"code":"println%28%22hello%22%29"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Dynamic-Resource-Doc"],"typed_request_body":{"type":"object","properties":{"request_verb":{"type":"string"},"example_request_body":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"integer"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"success_response_body":{"type":"object","properties":{"name":{"type":"string"},"hobby":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}},"my_user_id":{"type":"string"},"age":{"type":"integer"},"_optional_fields_":{"type":"array","items":{"type":"object","properties":{"s":{"type":"string"}}}}}},"request_url":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"code":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/management/dynamic-resource-docs/endpoint-code","connector_methods":[]},{"operation_id":"OBPv5.1.0-getAgent","implemented_by":{"version":"OBPv5.1.0","function":"getAgent"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","summary":"Get Agent","description":"Get Agent.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nAGENT_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nagent_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nagent_number: 5987953
\nbank_id: gh.29.uk
\ncurrency: EUR
\nis_confirmed_agent: is_confirmed_agent
\nis_pending_agent: is_pending_agent
\nlegal_name: Eveline Tripman
\nmobile_phone_number: +49 30 901820
\n","description_markdown":"Get Agent.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[AGENT_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\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[**agent_id**](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[**agent_number**](/glossary#): 5987953\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**currency**](/glossary#): EUR\n\n\n\n[**is_confirmed_agent**](/glossary#): is_confirmed_agent\n\n\n\n[**is_pending_agent**](/glossary#): is_pending_agent\n\n\n\n[**legal_name**](/glossary#): Eveline Tripman\n\n\n\n[**mobile_phone_number**](/glossary#mobile_phone_number): +49 30 901820\n\n\n","success_response_body":{"agent_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","bank_id":"gh.29.uk","legal_name":"Eveline Tripman","mobile_phone_number":"+49 30 901820","agent_number":"5987953","currency":"EUR","is_confirmed_agent":false,"is_pending_agent":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-30201: Agent not found. Please specify a valid value for AGENT_ID. ","OBP-30325: Agent Account Link not found.","OBP-50000: Unknown Error."],"tags":["Account"],"typed_success_response_body":{"type":"object","properties":{"agent_id":{"type":"string"},"is_pending_agent":{"type":"boolean"},"currency":{"type":"string"},"bank_id":{"type":"string"},"legal_name":{"type":"string"},"agent_number":{"type":"string"},"mobile_phone_number":{"type":"string"},"is_confirmed_agent":{"type":"boolean"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/agents/AGENT_ID","connector_methods":[]},{"operation_id":"OBPv5.0.0-getViewsForBankAccount","implemented_by":{"version":"OBPv5.0.0","function":"getViewsForBankAccount"},"request_verb":"GET","request_url":"/obp/v5.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","summary":"Get Views for Account","description":"Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
\nData: When a view moderates a set of data, some fields my contain the value null rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
\nAction: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
\nMetadata:
\nTransaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n\n\n\ncan_add_counterparty: false
\n\ncan_add_image_url: false
\ncan_add_more_info: false
\n\n\n\n\ncan_add_tag: false
\ncan_add_transaction_request_to_any_account:
\ncan_add_transaction_request_to_own_account: false
\n\n\ncan_create_direct_debit: false
\n\n\ncan_delete_corporate_location: false
\ncan_delete_image: false
\n\n\ncan_delete_where_tag: false
\ncan_edit_owner_comment: false
\ncan_grant_access_to_views: can_grant_access_to_views
\ncan_query_available_funds: false
\ncan_revoke_access_to_views: can_revoke_access_to_views
\n\ncan_see_bank_account_bank_name: false
\ncan_see_bank_account_credit_limit: false
\ncan_see_bank_account_currency:
\n\ncan_see_bank_account_label: false
\ncan_see_bank_account_national_identifier:
\ncan_see_bank_account_number: false
\ncan_see_bank_account_owners: false
\ncan_see_bank_account_routing_address:
\ncan_see_bank_account_routing_scheme:
\ncan_see_bank_account_swift_bic:
\n\ncan_see_bank_routing_address: false
\n\n\ncan_see_corporate_location: false
\ncan_see_image_url: false
\ncan_see_images: false
\n\n\ncan_see_other_account_bank_name:
\n\n\ncan_see_other_account_metadata:
\ncan_see_other_account_national_identifier: false
\ncan_see_other_account_number: false
\ncan_see_other_account_routing_address: false
\ncan_see_other_account_routing_scheme:
\ncan_see_other_account_swift_bic: false
\ncan_see_other_bank_routing_address:
\ncan_see_other_bank_routing_scheme:
\n\n\n\n\n\ncan_see_transaction_amount: false
\n\n\ncan_see_transaction_description: false
\ncan_see_transaction_finish_date:
\n\ncan_see_transaction_other_bank_account:
\ncan_see_transaction_start_date:
\ncan_see_transaction_this_bank_account:
\n\ncan_see_url: false
\ncan_see_where_tag: false
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\nis_system: true
\n\n\n\n\n","description_markdown":"#Views\n\n\nViews in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.\n\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.\n\n**Data:** When a view moderates a set of data, some fields my contain the value `null` rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.\n\nThere is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.\n\n**Action:** When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.\n\n**Metadata:**\nTransaction metadata (like images, tags, comments, etc.) will appears *ONLY* on the view where they have been created e.g. comments posted to the public view only appear on the public view.\n\nThe other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).\n\n# All\n*Optional*\n\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\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[**alias**](/glossary#alias): \n\n\n\n[**can_add_comment**](/glossary#can_add_comment): \n\n\n\n[**can_add_corporate_location**](/glossary#can_add_corporate_location): \n\n\n\n[**can_add_counterparty**](/glossary#can_add_counterparty): false\n\n\n\n[**can_add_image**](/glossary#can_add_image): \n\n\n\n[**can_add_image_url**](/glossary#can_add_image_url): false\n\n\n\n[**can_add_more_info**](/glossary#can_add_more_info): false\n\n\n\n[**can_add_open_corporates_url**](/glossary#can_add_open_corporates_url): \n\n\n\n[**can_add_physical_location**](/glossary#can_add_physical_location): \n\n\n\n[**can_add_private_alias**](/glossary#can_add_private_alias): \n\n\n\n[**can_add_public_alias**](/glossary#can_add_public_alias): \n\n\n\n[**can_add_tag**](/glossary#can_add_tag): false\n\n\n\n[**can_add_transaction_request_to_any_account**](/glossary#can_add_transaction_request_to_any_account): \n\n\n\n[**can_add_transaction_request_to_own_account**](/glossary#can_add_transaction_request_to_own_account): false\n\n\n\n[**can_add_url**](/glossary#can_add_url): \n\n\n\n[**can_add_where_tag**](/glossary#can_add_where_tag): \n\n\n\n[**can_create_direct_debit**](/glossary#can_create_direct_debit): false\n\n\n\n[**can_create_standing_order**](/glossary#can_create_standing_order): \n\n\n\n[**can_delete_comment**](/glossary#can_delete_comment): \n\n\n\n[**can_delete_corporate_location**](/glossary#can_delete_corporate_location): false\n\n\n\n[**can_delete_image**](/glossary#can_delete_image): false\n\n\n\n[**can_delete_physical_location**](/glossary#can_delete_physical_location): \n\n\n\n[**can_delete_tag**](/glossary#can_delete_tag): \n\n\n\n[**can_delete_where_tag**](/glossary#can_delete_where_tag): false\n\n\n\n[**can_edit_owner_comment**](/glossary#can_edit_owner_comment): false\n\n\n\n[**can_grant_access_to_views**](/glossary#): can_grant_access_to_views\n\n\n\n[**can_query_available_funds**](/glossary#can_query_available_funds): false\n\n\n\n[**can_revoke_access_to_views**](/glossary#): can_revoke_access_to_views\n\n\n\n[**can_see_bank_account_balance**](/glossary#can_see_bank_account_balance): \n\n\n\n[**can_see_bank_account_bank_name**](/glossary#can_see_bank_account_bank_name): false\n\n\n\n[**can_see_bank_account_credit_limit**](/glossary#can_see_bank_account_credit_limit): false\n\n\n\n[**can_see_bank_account_currency**](/glossary#can_see_bank_account_currency): \n\n\n\n[**can_see_bank_account_iban**](/glossary#can_see_bank_account_iban): \n\n\n\n[**can_see_bank_account_label**](/glossary#can_see_bank_account_label): false\n\n\n\n[**can_see_bank_account_national_identifier**](/glossary#can_see_bank_account_national_identifier): \n\n\n\n[**can_see_bank_account_number**](/glossary#can_see_bank_account_number): false\n\n\n\n[**can_see_bank_account_owners**](/glossary#can_see_bank_account_owners): false\n\n\n\n[**can_see_bank_account_routing_address**](/glossary#can_see_bank_account_routing_address): \n\n\n\n[**can_see_bank_account_routing_scheme**](/glossary#can_see_bank_account_routing_scheme): \n\n\n\n[**can_see_bank_account_swift_bic**](/glossary#can_see_bank_account_swift_bic): \n\n\n\n[**can_see_bank_account_type**](/glossary#can_see_bank_account_type): \n\n\n\n[**can_see_bank_routing_address**](/glossary#can_see_bank_routing_address): false\n\n\n\n[**can_see_bank_routing_scheme**](/glossary#can_see_bank_routing_scheme): \n\n\n\n[**can_see_comments**](/glossary#can_see_comments): \n\n\n\n[**can_see_corporate_location**](/glossary#can_see_corporate_location): false\n\n\n\n[**can_see_image_url**](/glossary#can_see_image_url): false\n\n\n\n[**can_see_images**](/glossary#can_see_images): false\n\n\n\n[**can_see_more_info**](/glossary#can_see_more_info): \n\n\n\n[**can_see_open_corporates_url**](/glossary#can_see_open_corporates_url): \n\n\n\n[**can_see_other_account_bank_name**](/glossary#can_see_other_account_bank_name): \n\n\n\n[**can_see_other_account_iban**](/glossary#can_see_other_account_iban): \n\n\n\n[**can_see_other_account_kind**](/glossary#can_see_other_account_kind): \n\n\n\n[**can_see_other_account_metadata**](/glossary#can_see_other_account_metadata): \n\n\n\n[**can_see_other_account_national_identifier**](/glossary#can_see_other_account_national_identifier): false\n\n\n\n[**can_see_other_account_number**](/glossary#can_see_other_account_number): false\n\n\n\n[**can_see_other_account_routing_address**](/glossary#can_see_other_account_routing_address): false\n\n\n\n[**can_see_other_account_routing_scheme**](/glossary#can_see_other_account_routing_scheme): \n\n\n\n[**can_see_other_account_swift_bic**](/glossary#can_see_other_account_swift_bic): false\n\n\n\n[**can_see_other_bank_routing_address**](/glossary#can_see_other_bank_routing_address): \n\n\n\n[**can_see_other_bank_routing_scheme**](/glossary#can_see_other_bank_routing_scheme): \n\n\n\n[**can_see_owner_comment**](/glossary#can_see_owner_comment): \n\n\n\n[**can_see_physical_location**](/glossary#can_see_physical_location): \n\n\n\n[**can_see_private_alias**](/glossary#can_see_private_alias): \n\n\n\n[**can_see_public_alias**](/glossary#can_see_public_alias): \n\n\n\n[**can_see_tags**](/glossary#can_see_tags): \n\n\n\n[**can_see_transaction_amount**](/glossary#can_see_transaction_amount): false\n\n\n\n[**can_see_transaction_balance**](/glossary#can_see_transaction_balance): \n\n\n\n[**can_see_transaction_currency**](/glossary#can_see_transaction_currency): \n\n\n\n[**can_see_transaction_description**](/glossary#can_see_transaction_description): false\n\n\n\n[**can_see_transaction_finish_date**](/glossary#can_see_transaction_finish_date): \n\n\n\n[**can_see_transaction_metadata**](/glossary#can_see_transaction_metadata): \n\n\n\n[**can_see_transaction_other_bank_account**](/glossary#can_see_transaction_other_bank_account): \n\n\n\n[**can_see_transaction_start_date**](/glossary#can_see_transaction_start_date): \n\n\n\n[**can_see_transaction_this_bank_account**](/glossary#can_see_transaction_this_bank_account): \n\n\n\n[**can_see_transaction_type**](/glossary#can_see_transaction_type): \n\n\n\n[**can_see_url**](/glossary#can_see_url): false\n\n\n\n[**can_see_where_tag**](/glossary#can_see_where_tag): false\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**is_system**](/glossary#): true\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**short_name**](/glossary#short_name): \n\n\n\n[**views**](/glossary#views): \n\n\n\n[is_firehose](/glossary#is_firehose): \n\n\n","success_response_body":{"views":[{"id":"1234","short_name":"short_name","description":"description","metadata_view":"owner","is_public":true,"is_system":true,"alias":"No","hide_metadata_if_alias_used":true,"can_grant_access_to_views":["owner"],"can_revoke_access_to_views":["owner"],"can_add_comment":true,"can_add_corporate_location":true,"can_add_image":true,"can_add_image_url":true,"can_add_more_info":true,"can_add_open_corporates_url":true,"can_add_physical_location":true,"can_add_private_alias":true,"can_add_public_alias":true,"can_add_tag":true,"can_add_url":true,"can_add_where_tag":true,"can_delete_comment":true,"can_add_counterparty":true,"can_delete_corporate_location":true,"can_delete_image":true,"can_delete_physical_location":true,"can_delete_tag":true,"can_delete_where_tag":true,"can_edit_owner_comment":true,"can_see_bank_account_balance":true,"can_query_available_funds":true,"can_see_bank_account_bank_name":true,"can_see_bank_account_currency":true,"can_see_bank_account_iban":true,"can_see_bank_account_label":true,"can_see_bank_account_national_identifier":true,"can_see_bank_account_number":true,"can_see_bank_account_owners":true,"can_see_bank_account_swift_bic":true,"can_see_bank_account_type":true,"can_see_comments":true,"can_see_corporate_location":true,"can_see_image_url":true,"can_see_images":true,"can_see_more_info":true,"can_see_open_corporates_url":true,"can_see_other_account_bank_name":true,"can_see_other_account_iban":true,"can_see_other_account_kind":true,"can_see_other_account_metadata":true,"can_see_other_account_national_identifier":true,"can_see_other_account_number":true,"can_see_other_account_swift_bic":true,"can_see_owner_comment":true,"can_see_physical_location":true,"can_see_private_alias":true,"can_see_public_alias":true,"can_see_tags":true,"can_see_transaction_amount":true,"can_see_transaction_balance":true,"can_see_transaction_currency":true,"can_see_transaction_description":true,"can_see_transaction_finish_date":true,"can_see_transaction_metadata":true,"can_see_transaction_other_bank_account":true,"can_see_transaction_start_date":true,"can_see_transaction_this_bank_account":true,"can_see_transaction_type":true,"can_see_url":true,"can_see_where_tag":true,"can_see_bank_routing_scheme":true,"can_see_bank_routing_address":true,"can_see_bank_account_routing_scheme":true,"can_see_bank_account_routing_address":true,"can_see_other_bank_routing_scheme":true,"can_see_other_bank_routing_address":true,"can_see_other_account_routing_scheme":true,"can_see_other_account_routing_address":true,"can_add_transaction_request_to_own_account":true,"can_add_transaction_request_to_any_account":true,"can_see_bank_account_credit_limit":true,"can_create_direct_debit":true,"can_create_standing_order":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_success_response_body":{"type":"object","properties":{"views":{"type":"array","items":{"type":"object","properties":{"can_see_other_account_swift_bic":{"type":"boolean"},"can_see_where_tag":{"type":"boolean"},"can_see_url":{"type":"boolean"},"can_create_direct_debit":{"type":"boolean"},"can_see_bank_account_swift_bic":{"type":"boolean"},"can_see_bank_account_routing_address":{"type":"boolean"},"can_see_tags":{"type":"boolean"},"can_see_transaction_balance":{"type":"boolean"},"can_delete_corporate_location":{"type":"boolean"},"can_add_image_url":{"type":"boolean"},"can_see_public_alias":{"type":"boolean"},"can_add_transaction_request_to_own_account":{"type":"boolean"},"can_add_comment":{"type":"boolean"},"can_see_other_bank_routing_scheme":{"type":"boolean"},"description":{"type":"string"},"can_see_corporate_location":{"type":"boolean"},"can_see_other_account_bank_name":{"type":"boolean"},"can_see_more_info":{"type":"boolean"},"can_add_counterparty":{"type":"boolean"},"is_system":{"type":"boolean"},"can_see_physical_location":{"type":"boolean"},"can_query_available_funds":{"type":"boolean"},"can_edit_owner_comment":{"type":"boolean"},"can_see_private_alias":{"type":"boolean"},"can_see_bank_account_credit_limit":{"type":"boolean"},"can_see_other_account_routing_address":{"type":"boolean"},"can_see_bank_account_balance":{"type":"boolean"},"can_add_public_alias":{"type":"boolean"},"can_see_bank_routing_scheme":{"type":"boolean"},"can_see_bank_account_owners":{"type":"boolean"},"can_see_other_account_metadata":{"type":"boolean"},"can_delete_physical_location":{"type":"boolean"},"hide_metadata_if_alias_used":{"type":"boolean"},"can_see_transaction_this_bank_account":{"type":"boolean"},"can_see_image_url":{"type":"boolean"},"can_see_transaction_type":{"type":"boolean"},"can_see_images":{"type":"boolean"},"can_see_transaction_amount":{"type":"boolean"},"metadata_view":{"type":"string"},"can_see_transaction_metadata":{"type":"boolean"},"can_see_comments":{"type":"boolean"},"can_see_other_account_iban":{"type":"boolean"},"can_add_image":{"type":"boolean"},"can_see_bank_account_routing_scheme":{"type":"boolean"},"can_see_bank_account_type":{"type":"boolean"},"can_see_other_account_kind":{"type":"boolean"},"can_see_bank_account_currency":{"type":"boolean"},"can_add_where_tag":{"type":"boolean"},"can_see_transaction_start_date":{"type":"boolean"},"can_see_bank_account_label":{"type":"boolean"},"can_add_private_alias":{"type":"boolean"},"can_see_transaction_currency":{"type":"boolean"},"can_revoke_access_to_views":{"type":"array","items":{"type":"string"}},"can_add_more_info":{"type":"boolean"},"can_delete_comment":{"type":"boolean"},"can_create_standing_order":{"type":"boolean"},"can_see_other_bank_routing_address":{"type":"boolean"},"can_grant_access_to_views":{"type":"array","items":{"type":"string"}},"can_see_transaction_other_bank_account":{"type":"boolean"},"can_see_bank_account_number":{"type":"boolean"},"can_add_corporate_location":{"type":"boolean"},"alias":{"type":"string"},"can_add_url":{"type":"boolean"},"short_name":{"type":"string"},"can_delete_where_tag":{"type":"boolean"},"is_public":{"type":"boolean"},"can_see_owner_comment":{"type":"boolean"},"can_see_transaction_finish_date":{"type":"boolean"},"can_see_open_corporates_url":{"type":"boolean"},"can_add_physical_location":{"type":"boolean"},"can_see_bank_account_iban":{"type":"boolean"},"can_see_other_account_national_identifier":{"type":"boolean"},"can_see_bank_routing_address":{"type":"boolean"},"can_delete_image":{"type":"boolean"},"can_add_transaction_request_to_any_account":{"type":"boolean"},"can_add_tag":{"type":"boolean"},"id":{"type":"string"},"can_see_other_account_routing_scheme":{"type":"boolean"},"can_add_open_corporates_url":{"type":"boolean"},"can_delete_tag":{"type":"boolean"},"can_see_transaction_description":{"type":"boolean"},"can_see_bank_account_national_identifier":{"type":"boolean"},"can_see_other_account_number":{"type":"boolean"},"can_see_bank_account_bank_name":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","connector_methods":[]},{"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.
\nIntroduction:
\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\nTo use this endpoint, please supply a valid json-schema in the request body.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nOPERATION_ID: OBPv4.0.0-getBanks
\nJSON response body fields:
\n$schema: $schema
\nadditionalProperties: additionalProperties
\ndescription: Description of the object. 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\nIntroduction:\n\nJSON Schema is "a vocabulary that allows you to annotate and validate JSON documents".
\nBy applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For example, you can set minimum / maximum lengths of fields and constrain values to certain lists or regular expressions.
\nSee JSONSchema.org for more information about the JSON Schema standard.
\nTo create a JSON Schema from an any JSON Request body you can use JSON Schema Net
\n(The video link below shows how to use that)
\nNote: OBP Dynamic Entities also use JSON Schema Validation so you don't need to additionally wrap the resulting endpoints with extra JSON Schema Validation but you could do.
\nYou can apply JSON schema validations to any OBP endpoint's request body using the POST and PUT endpoints listed in the link below.
\nPLEASE SEE the following video explanation: JSON schema validation of request for Static and Dynamic Endpoints and Entities
\n\n\n\nTo use this endpoint, please supply a valid json-schema in the request body.\n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nJSON response body fields:
\n","description_markdown":"Verify Request and Sign Response of a current call.\n\n \n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv5.1.0-getCustomView","implemented_by":{"version":"OBPv5.1.0","function":"getCustomView"},"request_verb":"GET","request_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","summary":"Get Custom View","description":"Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
\nData: When a view moderates a set of data, some fields my contain the value null rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
\nAction: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
\nMetadata:
\nTransaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTARGET_VIEW_ID: TARGET_VIEW_ID
\nVIEW_ID: owner
\nJSON response body fields:
\n\nallowed_permissions: allowed_permissions
\ndescription: Description of the object. Maximum length is 2000. It can be any characters here.
\nhide_metadata_if_alias_used: false
\nid: d8839721-ad8f-45dd-9f78-2080414b93f9
\nis_public: false
\n\nname: ACCOUNT_MANAGEMENT_FEE
\n","description_markdown":"#Views\n\n\nViews in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.\n\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.\n\n**Data:** When a view moderates a set of data, some fields my contain the value `null` rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.\n\nThere is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.\n\n**Action:** When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.\n\n**Metadata:**\nTransaction metadata (like images, tags, comments, etc.) will appears *ONLY* on the view where they have been created e.g. comments posted to the public view only appear on the public view.\n\nThe other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).\n\n# All\n*Optional*\n\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated. and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[TARGET_VIEW_ID](/glossary#): TARGET_VIEW_ID\n\n\n\n[VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**alias**](/glossary#alias): \n\n\n\n[**allowed_permissions**](/glossary#): allowed_permissions\n\n\n\n[**description**](/glossary#description): Description of the object. Maximum length is 2000. It can be any characters here.\n\n\n\n[**hide_metadata_if_alias_used**](/glossary#hide_metadata_if_alias_used): false\n\n\n\n[**id**](/glossary#id): d8839721-ad8f-45dd-9f78-2080414b93f9\n\n\n\n[**is_public**](/glossary#is_public): false\n\n\n\n[**metadata_view**](/glossary#metadata_view): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n","success_response_body":{"id":"owner","name":"owner","description":"This view is for the owner for the account.","metadata_view":"","is_public":false,"alias":"public","hide_metadata_if_alias_used":false,"allowed_permissions":["can_edit_owner_comment","can_see_transaction_this_bank_account","can_see_transaction_other_bank_account","can_see_transaction_metadata","can_see_transaction_amount","can_see_transaction_type","can_see_transaction_currency","can_see_transaction_start_date","can_see_transaction_finish_date","can_see_transaction_balance","can_see_comments","can_see_tags","can_see_images","can_see_bank_account_owners","can_see_bank_account_type","can_see_bank_account_balance","can_see_bank_account_currency","can_see_bank_account_label","can_see_bank_account_national_identifier","can_see_bank_account_swift_bic","can_see_bank_account_iban","can_see_bank_account_number","can_see_bank_account_bank_name","can_see_other_account_national_identifier","can_see_other_account_swift_bic","can_see_other_account_iban","can_see_other_account_bank_name","can_see_other_account_number","can_see_other_account_metadata","can_see_other_account_kind","can_see_more_info","can_see_url","can_see_image_url","can_see_open_corporates_url","can_see_corporate_location","can_see_physical_location","can_see_public_alias","can_see_private_alias","can_add_more_info","can_add_url","can_add_image_url","can_add_open_corporates_url","can_add_corporate_location","can_add_physical_location","can_add_public_alias","can_add_private_alias","can_delete_corporate_location","can_delete_physical_location","can_add_comment","can_delete_comment","can_add_tag","can_delete_tag","can_add_image","can_delete_image","can_add_where_tag","can_see_where_tag","can_delete_where_tag","can_see_bank_routing_scheme","can_see_bank_routing_address","can_see_bank_account_routing_scheme","can_see_bank_account_routing_address","can_see_other_bank_routing_scheme","can_see_other_bank_routing_address","can_see_other_account_routing_scheme","can_see_other_account_routing_address","can_query_available_funds","can_add_transaction_request_to_own_account","can_add_transaction_request_to_any_account","can_see_bank_account_credit_limit","can_create_direct_debit","can_create_standing_order","can_add_transaction_request_to_any_account","can_see_transaction_request_types","can_see_transaction_requests","can_see_available_views_for_bank_account","can_update_bank_account_label","can_create_custom_view","can_delete_custom_view","can_update_custom_view","can_see_views_with_permissions_for_one_user","can_see_views_with_permissions_for_all_users","can_grant_access_to_custom_views","can_revoke_access_to_custom_views","can_see_transaction_status"]},"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.","OBP-50000: Unknown Error."],"tags":["View-Custom","Account"],"typed_success_response_body":{"type":"object","properties":{"allowed_permissions":{"type":"array","items":{"type":"string"}},"hide_metadata_if_alias_used":{"type":"boolean"},"description":{"type":"string"},"is_public":{"type":"boolean"},"metadata_view":{"type":"string"},"name":{"type":"string"},"alias":{"type":"string"},"id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/target-views/TARGET_VIEW_ID","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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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: Description of the object. 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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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): Description of the object. 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":"Description of the object. 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":"Description of the object. 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":{"description":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"}}},"typed_success_response_body":{"type":"object","properties":{"api_collection_id":{"type":"string"},"api_collection_name":{"type":"string"},"is_sharable":{"type":"boolean"},"description":{"type":"string"},"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-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.
\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.
\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\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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":"OBPv5.0.0-createConsentByConsentRequestIdImplicit","implemented_by":{"version":"OBPv5.0.0","function":"createConsentByConsentRequestIdImplicit"},"request_verb":"POST","request_url":"/obp/v5.0.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents","summary":"Create Consent By CONSENT_REQUEST_ID (IMPLICIT)","description":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.
\nPlease note that the Consent cannot elevate the privileges logged in user already have.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nURL Parameters:
\nCONSENT_REQUEST_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nIMPLICIT: IMPLICIT
\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsent_id: 9d429899-24f5-42c8-8565-943ffa6a7947
\ncounterparty_ids: counterparty_ids
\njwt: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4
\n\nview_id: owner
\naccount_access: account_access
\nconsent_request_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nhelper_info: helper_info
\n","description_markdown":"This endpoint continues the process of creating a Consent. It starts the SCA flow which changes the status of the consent from INITIATED to ACCEPTED or REJECTED.\nPlease note that the Consent cannot elevate the privileges logged in user already have. \n\n\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\n\n\n**URL Parameters:**\n\n[CONSENT_REQUEST_ID](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[IMPLICIT](/glossary#): IMPLICIT\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**account_id**](/glossary#): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**consent_id**](/glossary#consent_id): 9d429899-24f5-42c8-8565-943ffa6a7947\n\n\n\n[**counterparty_ids**](/glossary#): counterparty_ids\n\n\n\n[**jwt**](/glossary#jwt): eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4\n\n\n\n[**status**](/glossary#status): \n\n\n\n[**view_id**](/glossary#): owner\n\n\n\n[account_access](/glossary#): account_access\n\n\n\n[consent_request_id](/glossary#consent_request_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[helper_info](/glossary#): helper_info\n\n\n","success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED","consent_request_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","account_access":{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner","helper_info":{"counterparty_ids":["9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh"]}}},"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-10001: Incorrect json format.","OBP-35029: The CONSENT_REQUEST_ID is invalid. ","OBP-35009: Only SMS, EMAIL and IMPLICIT are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number:","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2"],"typed_success_response_body":{"type":"object","properties":{"account_access":{"type":"object","properties":{"helper_info":{"type":"object","properties":{"counterparty_ids":{"type":"array","items":{"type":"string"}}}},"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}},"consent_request_id":{"type":"string"},"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents","connector_methods":[]}]}