{"resource_docs":[{"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
\nthe public alias was deleted.

\n

The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

alias:

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Creates the public alias for the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\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#other_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-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-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":"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.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON 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#other_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":"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.

\n

Authentication via OAuth is required if the view is not public.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

URL: http://www.example.com/id-docs/123/image.png

\n

corporate_location: 10

\n

date: 2020-01-27

\n

display_name:

\n

id: d8839721-ad8f-45dd-9f78-2080414b93f9

\n

image_URL:

\n

latitude: 38.8951

\n

longitude: -77.0364

\n

more_info: More information about this fee

\n

open_corporates_URL:

\n

physical_location:

\n

private_alias:

\n

provider: ETHEREUM

\n

public_alias:

\n

user:

\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#other_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#Customer.url): 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":"1100-01-01T00: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":"1100-01-01T00: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":{"image_URL":{"type":"string"},"corporate_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"URL":{"type":"string"},"open_corporates_URL":{"type":"string"},"physical_location":{"type":"object","properties":{"longitude":{"type":"number"},"date":{"type":"string","format":"date-time"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"public_alias":{"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":"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.)

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\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#other_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":"OBPv2.2.0-getExplicitCounterpartyById","implemented_by":{"version":"OBPv2.2.0","function":"getExplicitCounterpartyById"},"request_verb":"GET","request_url":"/obp/v2.2.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID","summary":"Get Counterparty by Counterparty Id (Explicit)","description":"

Information returned about the Counterparty specified by COUNTERPARTY_ID:

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

bespoke:

\n

corporate_location: 10

\n

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

\n

created_by_user_id:

\n

date: 2020-01-27

\n

description: Description of the object. Maximum length is 2000. It can be any characters here.

\n

id: d8839721-ad8f-45dd-9f78-2080414b93f9

\n

image_url:

\n

is_beneficiary: false

\n

key: CustomerNumber

\n

latitude: 38.8951

\n

longitude: -77.0364

\n

metadata:

\n

more_info: More information about this fee

\n

name: ACCOUNT_MANAGEMENT_FEE

\n

open_corporates_url:

\n

other_account_routing_address: DE89370400440532013000

\n

other_account_routing_scheme: IBAN

\n

other_account_secondary_routing_address:

\n

other_account_secondary_routing_scheme:

\n

other_bank_routing_address:

\n

other_bank_routing_scheme:

\n

other_branch_routing_address:

\n

other_branch_routing_scheme:

\n

physical_location:

\n

private_alias:

\n

provider: ETHEREUM

\n

public_alias:

\n

this_account_id:

\n

this_bank_id:

\n

this_view_id:

\n

url: http://www.example.com/id-docs/123/image.png

\n

user:

\n

username: felixsmith

\n

value: 5987953

\n","description_markdown":"Information returned about the Counterparty specified by COUNTERPARTY_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#other_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[**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#Adapter.key): 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#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#user): \n\n\n\n[**username**](/glossary#User.username): felixsmith\n\n\n\n[**value**](/glossary#Adapter.value): 5987953\n\n\n","success_response_body":{"name":"CounterpartyName","description":"My landlord","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":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00: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-50000: Unknown Error."],"tags":["Counterparty","Payment Initiation Service (PIS)","Counterparty-Metadata","PSD2"],"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"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"type":"string"}}},"this_bank_id":{"type":"string"},"other_bank_routing_scheme":{"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/COUNTERPARTY_ID","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/EXPLICIT_COUNTERPARTY_ID","summary":"Get Counterparty by Id (Explicit)","description":"

This endpoint returns a single Counterparty on an Account View specified by its COUNTERPARTY_ID:

\n

For a general introduction to Counterparties in OBP, see here

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

EXPLICIT_COUNTERPARTY_ID: EXPLICIT_COUNTERPARTY_ID

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

bespoke:

\n

corporate_location: 10

\n

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

\n

created_by_user_id:

\n

currency: EUR

\n

date: 2020-01-27

\n

description: Description of the object. Maximum length is 2000. It can be any characters here.

\n

id: d8839721-ad8f-45dd-9f78-2080414b93f9

\n

image_url:

\n

is_beneficiary: false

\n

key: CustomerNumber

\n

latitude: 38.8951

\n

longitude: -77.0364

\n

metadata:

\n

more_info: More information about this fee

\n

name: ACCOUNT_MANAGEMENT_FEE

\n

open_corporates_url:

\n

other_account_routing_address: DE89370400440532013000

\n

other_account_routing_scheme: IBAN

\n

other_account_secondary_routing_address:

\n

other_account_secondary_routing_scheme:

\n

other_bank_routing_address:

\n

other_bank_routing_scheme:

\n

other_branch_routing_address:

\n

other_branch_routing_scheme:

\n

physical_location:

\n

private_alias:

\n

provider: ETHEREUM

\n

public_alias:

\n

this_account_id:

\n

this_bank_id:

\n

this_view_id:

\n

url: http://www.example.com/id-docs/123/image.png

\n

user:

\n

username: felixsmith

\n

value: 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#other_account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[EXPLICIT_COUNTERPARTY_ID](/glossary#): EXPLICIT_COUNTERPARTY_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[**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#Adapter.key): 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#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n[**user**](/glossary#user): \n\n\n\n[**username**](/glossary#User.username): felixsmith\n\n\n\n[**value**](/glossary#Adapter.value): 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":"1100-01-01T00:00:00Z","user":{"id":"123","provider":"http://127.0.0.1:8080","username":"felixsmith"}},"physical_location":{"latitude":11.45,"longitude":11.45,"date":"1100-01-01T00: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"},"metadata":{"type":"object","properties":{"private_alias":{"type":"string"},"physical_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"url":{"type":"string"},"public_alias":{"type":"string"},"open_corporates_url":{"type":"string"},"more_info":{"type":"string"},"corporate_location":{"type":"object","properties":{"user":{"type":"object","properties":{"provider":{"type":"string"},"id":{"type":"string"},"username":{"type":"string"}}},"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"}}},"image_url":{"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/EXPLICIT_COUNTERPARTY_ID","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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON 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#other_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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n","description_markdown":"Deletes the public alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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 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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\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#other_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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

image_URL:

\n

JSON response body fields:

\n

success:

\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#other_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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

alias:

\n","description_markdown":"Returns the private alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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-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 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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON 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#other_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-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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\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#other_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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n","description_markdown":"Deletes the private alias of the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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 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-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.)

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

URL: http://www.example.com/id-docs/123/image.png

\n

JSON response body fields:

\n

success:

\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#other_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#Customer.url): 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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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-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 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":"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.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

alias:

\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#other_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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n","description_markdown":"Delete image 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#other_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-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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

alias:

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Creates a private alias for the other account OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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-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 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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

latitude: 38.8951

\n

longitude: -77.0364

\n

physical_location:

\n

JSON response body fields:

\n

success:

\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#other_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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

corporate_location: 10

\n

latitude: 38.8951

\n

longitude: -77.0364

\n

JSON response body fields:

\n

success:

\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#other_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":"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 counterparty from the perspective of the account e.g. My dentist

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

more_info: More information about this fee

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Add a description of the counterparty from the perspective 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#other_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":"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 counterparty from the perspective of the account e.g. My dentist

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Update the more info description of the counterparty from the perspective 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#other_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.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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Update the 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#other_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-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 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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON 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#other_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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\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#other_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":"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.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON 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#other_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":"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

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON request body fields:

\n

open_corporates_URL:

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Add open corporates url to 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#other_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-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 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":"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.

\n

User Authentication is Required. The User must be logged in. The Application must also be authenticated.
\nAuthentication is required if the view is not public.

\n

URL Parameters:

\n

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

\n

BANK_ID: gh.29.uk

\n

OTHER_ACCOUNT_ID:

\n

VIEW_ID: owner

\n

JSON response body fields:

\n

success:

\n","description_markdown":"Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.\n\nUser Authentication is Required. The User must be logged in. The Application must also be authenticated.\nAuthentication is required if the view is not public.\n\n\n**URL Parameters:**\n\n[ACCOUNT_ID](/glossary#other_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.","OBP-20001: User not logged in. Authentication is required!","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":[]}]}