{"resource_docs":[{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Update the geolocation of the counterparty's registered address\n\nAuthentication is Mandatory\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
Authentication is Optional
\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
\ndate: 2020-01-27
\nlatitude: 38.8951
\nlongitude: -77.0364
\nReturns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.
\nAuthentication is Optional
Authentication is required if the view is not public.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [URL](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"Bank_ID","address":"gh.29.uk"},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"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":"2017-09-19T00: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":"2017-09-19T00: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","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"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"}}}}},"public_alias":{"type":"string"},"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"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"Add geocoordinates of the counterparty's main location\n\nAuthentication is Mandatory\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* [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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n\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\nAuthentication is Mandatory\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#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"jsonString":"{}"},"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":"2017-09-19T00: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":"2017-09-19T00: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_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"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"}}}}},"public_alias":{"type":"string"},"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"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.)
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nAuthentication is Mandatory\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Add a url that points to the logo of the counterparty\n\nAuthentication is Mandatory\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\n\n**JSON response body fields:**\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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"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
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Update the url that points to the logo of the counterparty\n\nAuthentication is Optional\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"operation_id":"OBPv4.0.0-getExplictCounterpartiesForAccount","implemented_by":{"version":"OBPv4.0.0","function":"getExplictCounterpartiesForAccount"},"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 (Explicit) for the account / view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nInformation returned about the Counterparty specified by COUNTERPARTY_ID:
\nAuthentication is Mandatory
\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:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nDelete open corporate url of other bank account
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete open corporate url of other bank account\n\nAuthentication is Mandatory\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Add a description of the counter party from the perpestive of the account e.g. My dentist\n\nAuthentication is Mandatory\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\n\n**JSON response body fields:**\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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL 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 private alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\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
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Creates the public alias for the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [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","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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"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/counterparties/COUNTERPARTY_NAME","summary":"Get Counterparty by name for any account (Explicit) ","description":"Authentication is Mandatory
\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:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nUpdate the more info description of the counter party from the perpestive of the account e.g. My dentist
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Update the more info description of the counter party from the perpestive of the account e.g. My dentist\n\nAuthentication is Mandatory\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Returns the private alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"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_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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":"Create Counterparty (Explicit) for an Account.
\nIn OBP, there are two types of Counterparty.
\nExplicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
\nImplicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
\nExplicit Counterparties are created for the account / view
\nThey are how the user of the view (e.g. account owner) refers to the other side of the transaction
name : the human readable name (e.g. Piano teacher, Miss Nipa)
\ndescription : the human readable name (e.g. Piano teacher, Miss Nipa)
\ncurrency : counterparty account currency (e.g. EUR, GBP, USD, ...)
\nbank_routing_scheme : eg: bankId or bankCode or any other strings
\nbank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
\naccount_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
\nother_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
\nother_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
\nother_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
\nbespoke.key : any info-key you want to add to this counterparty
\nbespoke.value : any info-value you want to add to this counterparty
\nThe view specified by VIEW_ID must have the canAddCounterparty permission
\nA minimal example for TransactionRequestType == COUNTERPARTY
\n{
\n"name": "Tesobe1",
\n"description": "Good Company",
\n"currency": "EUR",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"is_beneficiary": true,
\n"other_account_secondary_routing_scheme": "",
\n"other_account_secondary_routing_address": "",
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
A minimal example for TransactionRequestType == SEPA
\n{
\n"name": "Tesobe2",
\n"description": "Good Company",
\n"currency": "EUR",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"other_account_secondary_routing_scheme": "IBAN",
\n"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
\n"is_beneficiary": true,
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\ncurrency: EUR
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nUpdate open corporate url of other bank account
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Update open corporate url of other bank account\n\nAuthentication is Mandatory\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"Add the geolocation of the counterparty's registered address\n\nAuthentication is Mandatory\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* [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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"operation_id":"OBPv4.0.0-createCounterpartyForAnyAccount","implemented_by":{"version":"OBPv4.0.0","function":"createCounterpartyForAnyAccount"},"request_verb":"POST","request_url":"/obp/v4.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties","summary":"Create Counterparty for any account (Explicit)","description":"Create Counterparty for any Account. (Explicit)
\nIn OBP, there are two types of Counterparty.
\nExplicit Counterparties (those here) which we create explicitly and are used in COUNTERPARTY Transaction Requests
\nImplicit Counterparties (AKA Other Accounts) which are generated automatically from the other sides of Transactions.
\nExplicit Counterparties are created for the account / view
\nThey are how the user of the view (e.g. account owner) refers to the other side of the transaction
name : the human readable name (e.g. Piano teacher, Miss Nipa)
\ndescription : the human readable name (e.g. Piano teacher, Miss Nipa)
\ncurrency : counterparty account currency (e.g. EUR, GBP, USD, ...)
\nbank_routing_scheme : eg: bankId or bankCode or any other strings
\nbank_routing_address : eg: gh.29.uk
, must be valid sandbox bankIds
account_routing_scheme : eg: AccountId or AccountNumber or any other strings
\naccount_routing_address : eg: 1d65db7c-a7b2-4839-af41-95
, must be valid accountIds
other_account_secondary_routing_scheme : eg: IBan or any other strings
\nother_account_secondary_routing_address : if it is an IBAN, it should be unique for each counterparty.
\nother_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode.
\nother_branch_routing_address : eg: branch-id-123
or you can leave it empty, not useful in sandbox mode.
is_beneficiary : must be set to true
in order to send payments to this counterparty
bespoke: It supports a list of key-value, you can add it to the counterparty.
\nbespoke.key : any info-key you want to add to this counterparty
\nbespoke.value : any info-value you want to add to this counterparty
\nThe view specified by VIEW_ID must have the canAddCounterparty permission
\nA minimal example for TransactionRequestType == COUNTERPARTY
\n{
\n"name": "Tesobe1",
\n"description": "Good Company",
\n"currency": "EUR",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"is_beneficiary": true,
\n"other_account_secondary_routing_scheme": "",
\n"other_account_secondary_routing_address": "",
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
A minimal example for TransactionRequestType == SEPA
\n{
\n"name": "Tesobe2",
\n"description": "Good Company",
\n"currency": "EUR",
\n"other_bank_routing_scheme": "OBP",
\n"other_bank_routing_address": "gh.29.uk",
\n"other_account_routing_scheme": "OBP",
\n"other_account_routing_address": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n"other_account_secondary_routing_scheme": "IBAN",
\n"other_account_secondary_routing_address": "DE89 3704 0044 0532 0130 00",
\n"is_beneficiary": true,
\n"other_branch_routing_scheme": "",
\n"other_branch_routing_address": "",
\n"bespoke": []
\n}
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\ncurrency: EUR
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nA url which represents the counterparty (home page url etc.)
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"A url which represents the counterparty (home page url etc.)\n\nAuthentication is Mandatory\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* [URL](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n\n\n**JSON response body fields:**\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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/url","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"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.
\nAuthentication is Optional
\nAuthentication is Mandatory if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Returns the public alias of the other account OTHER_ACCOUNT_ID.\nAuthentication is Optional\nAuthentication is Mandatory 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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"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","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"alias":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Update geocoordinates of the counterparty's main location\n\nAuthentication is Mandatory\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","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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL 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 public alias of the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
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:
\n\n","description_markdown":"Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID.\nAuthentication is Optional\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#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"other_accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","holder":{"name":"OBP","is_alias":true},"bank_routing":{"scheme":"Bank_ID","address":"gh.29.uk"},"account_routings":[{"scheme":"AccountNumber","address":"4930396"}],"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":"2017-09-19T00: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":"2017-09-19T00: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","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"other_accounts":{"type":"array","items":{"type":"object","properties":{"holder":{"type":"object","properties":{"is_alias":{"type":"boolean"},"name":{"type":"string"}}},"id":{"type":"string"},"metadata":{"type":"object","properties":{"image_URL":{"type":"string"},"URL":{"type":"string"},"open_corporates_URL":{"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"}}}}},"public_alias":{"type":"string"},"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"}}}}},"private_alias":{"type":"string"},"more_info":{"type":"string"}}},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\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\nAuthentication is Mandatory\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/corporate_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete image url of other bank account\n\nAuthentication is Optional\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Counterparty-Metadata","Counterparty"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/image_url","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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":"Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Authentication is Mandatory\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete physical location of other bank account\n\nAuthentication is Mandatory\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","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"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"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/physical_location","connector_methods":["obp.getCounterpartyByCounterpartyIdLegacy","obp.getCounterpartyFromTransaction","obp.getBankAccountOld"]},{"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.
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Creates a private alias for the other account OTHER_ACCOUNT_ID.\n\nAuthentication is Optional\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* [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","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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/private_alias","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"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
\nAuthentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Add open corporates url to other bank account\n\nAuthentication is Optional\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\n\n**JSON response body fields:**\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","New-Style"],"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/v4.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/open_corporates_url","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]}]}