{"resource_docs":[{"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
\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/v3.1.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":"OBPv2.0.0-getKycDocuments","implemented_by":{"version":"OBPv2.0.0","function":"getKycDocuments"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_documents","summary":"Get Customer KYC Documents","description":"Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
\nGet a list of documents that affirm the identity of the customer
\nPassport, driving licence etc.
\nAuthentication is Optional
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nissue_date: 2020-01-27
\nGet the logged in user
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nDelete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/users/USER_ID/auth-context/USER_AUTH_CONTEXT_ID","connector_methods":["obp.deleteUserAuthContextById","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-updateAccountLabel","implemented_by":{"version":"OBPv1.2.1","function":"updateAccountLabel"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account Label","description":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account'\n\n\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\n\n**JSON request body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"id":"123123","label":"label","bank_id":"gh.29.uk"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","user does not have access to owner view on account"],"tags":["Account"],"typed_request_body":{"type":"object","properties":{"id":{"type":"string"},"bank_id":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID","connector_methods":["obp.updateAccountLabel","obp.getBankAccountOld"]},{"operation_id":"OBPv3.1.0-getMeeting","implemented_by":{"version":"OBPv3.1.0","function":"getMeeting"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings/MEETING_ID","summary":"Get Meeting","description":"Get Meeting specified by BANK_ID / MEETING_ID
\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nwhen: 2020-01-27
\nReturns the list of the permissions at BANK_ID for account ACCOUNT_ID, with each time a pair composed of the user and the views that he has access to.
\nAuthentication is Mandatory
\nand the user needs to have access to the owner view.
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nUpdate an existing view on a bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nCreate a Tax Residence for a Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create a Tax Residence for a Customer specified by CUSTOMER_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"domain":"Enter some domain","tax_number":"Enter some number"},"success_response_body":{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-50000: Unknown Error."],"tags":["Customer","KYC","New-Style"],"typed_request_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}},"roles":[{"role":"CanCreateTaxResidence","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residence","connector_methods":["obp.createTaxResidence","obp.getCustomerByCustomerId","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createCardAttribute","implemented_by":{"version":"OBPv3.1.0","function":"createCardAttribute"},"request_verb":"POST","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID/attribute","summary":"Create Card Attribute","description":"Create Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON request body fields:
\nJSON response body fields:
\nattribute_type: STRING
\nbank_id: gh.29.uk
\ncard_attribute_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nvalue: 5987953
\nAdd 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/v3.1.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"]},{"operation_id":"OBPv3.1.0-getCreditLimitRequests","implemented_by":{"version":"OBPv3.1.0","function":"getCreditLimitRequests"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests","summary":"Get Credit Limit Order Requests ","description":"NOTE: This endpoint currently only returns example data.
\nGet Credit Limit Order Requests
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nGet Credit Limit Order Requests \n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"rank_amount_1":"String","nominal_interest_1":"String","rank_amount_2":"String","nominal_interest_2":"String"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Customer","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"nominal_interest_1":{"type":"string"},"rank_amount_1":{"type":"string"},"rank_amount_2":{"type":"string"},"nominal_interest_2":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests","connector_methods":["obp.getBankAccountsForUser"]},{"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/v3.1.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":"OBPv3.0.0-addScope","implemented_by":{"version":"OBPv3.0.0","function":"addScope"},"request_verb":"POST","request_url":"/obp/v3.0.0/consumers/CONSUMER_ID/scopes","summary":"Create Scope for a Consumer","description":"Create Scope. Grant Role to Consumer.
\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\nCreates 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/v3.1.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":"OBPv3.1.0-getAllEntitlements","implemented_by":{"version":"OBPv3.1.0","function":"getAllEntitlements"},"request_verb":"GET","request_url":"/obp/v3.1.0/entitlements","summary":"Get all Entitlements","description":"Login is required.
\nPossible filter on the role field:
\neg: /entitlements?role=CanGetCustomer
\nAuthentication is Mandatory
\nJSON response body fields:
\nDelete 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/v3.1.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-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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/public_alias","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getPermissionForUserForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getPermissionForUserForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID","summary":"Get Account access for User","description":"Returns the list of the views at BANK_ID for account ACCOUNT_ID that a user identified by PROVIDER_ID at their provider PROVIDER has access to.
\nAll url parameters must be %-encoded, which is often especially relevant for USER_ID and PROVIDER.
Authentication is Mandatory
\nThe user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nSearch the data warehouse and get row level results.
\nAuthentication is Mandatory
\nCanSearchWarehouse entitlement is required. You can request the Role below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE
\nPOST /search/warehouse/INDEX1,INDEX2
\nPOST /search/warehouse/ALL
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Search the data warehouse and get row level results.\n\nAuthentication is Mandatory\n\nCanSearchWarehouse entitlement is required. You can request the Role below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\n\nPOST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE\n\nPOST /search/warehouse/INDEX1,INDEX2\n\nPOST /search/warehouse/ALL\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Data-Warehouse","New-Style"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchWarehouse","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/search/warehouse/INDEX","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getAccountApplications","implemented_by":{"version":"OBPv3.1.0","function":"getAccountApplications"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications","summary":"Get Account Applications","description":"Get the Account Applications.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nUpdate an existing branch for a bank account (Authenticated access).
\nAuthentication is Mandatory
URL Parameters:
\n\nJSON response body fields:
\n\n","description_markdown":"Update an existing branch for a bank account (Authenticated access).\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [BRANCH_ID](/glossary#Branch.branch_id): DERBY6\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [country](/glossary#country_code): country\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n","example_request_body":{"bank_id":"gh.29.fi","name":"OBP","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"meta":{"license":{"id":"5","name":"TESOBE"}},"lobby":{"hours":"5"},"drive_up":{"hours":"5"}},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","name":"String","address":{"line_1":"Osloer Straße 16/17","line_2":"Wedding","line_3":"","city":"Berlin","state":"Berlin Brandenburg","postcode":"13359","country":"DE"},"location":{"latitude":11.45,"longitude":11.45},"lobby":{"hours":"5"},"drive_up":{"hours":"5"},"meta":{"license":{"id":"5","name":"TESOBE"}},"branch_routing":{"scheme":"BranchNumber","address":"678"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Branch"],"typed_request_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"bank_id":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"name":{"type":"string"},"id":{"type":"string"},"address":{"type":"object","properties":{"line_3":{"type":"string"},"country":{"type":"string"},"city":{"type":"string"},"line_2":{"type":"string"},"line_1":{"type":"string"},"state":{"type":"string"},"postcode":{"type":"string"}}},"drive_up":{"type":"object","properties":{"hours":{"type":"string"}}},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"branch_routing":{"type":"object","properties":{"address":{"type":"string"},"scheme":{"type":"string"}}},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"roles":[{"role":"CanUpdateBranch","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":["obp.createOrUpdateBranch","obp.getBankLegacy"]},{"operation_id":"OBPv3.1.0-updateAccount","implemented_by":{"version":"OBPv3.1.0","function":"updateAccount"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/banks/BANK_ID/accounts/ACCOUNT_ID","summary":"Update Account","description":"Update the account.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\nlabel: My Account
\nGet 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/v3.1.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":"OBPv3.1.0-getBankAccountsBalances","implemented_by":{"version":"OBPv3.1.0","function":"getBankAccountsBalances"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/balances","summary":"Get Accounts Balances","description":"Get the Balances for the Accounts of the current User at one bank.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\noverall_balance: 10
\noverall_balance_date: 2020-01-27
\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/v3.1.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":"OBPv3.1.0-getFirehoseCustomers","implemented_by":{"version":"OBPv3.1.0","function":"getFirehoseCustomers"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/firehose/customers","summary":"Get Firehose Customers","description":"Get Customers that has a firehose View.
\nAllows bulk access to customers.
\nUser must have the CanUseFirehoseAtAnyBank Role
Possible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nrelationship_status: single
\nGet Account Webhooks.
\nPossible custom URL parameters for pagination:
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nGet the Addresses of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\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":"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/v3.1.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.4.0-getResourceDocsSwagger","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsSwagger"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/swagger","summary":"Get Swagger documentation","description":"Returns documentation about the RESTful resources on this server in Swagger format.
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank
\n(All endpoints are given one or more tags which for used in grouping)
\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById
\n(Each endpoint is implemented in the OBP Scala code by a 'function')
\nSee the Resource Doc endpoint for more information.
\nFollowing are more examples:
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Returns documentation about the RESTful resources on this server in Swagger format.\n\nAPI_VERSION is the version you want documentation about e.g. v3.0.0\n\nYou may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank\n\n(All endpoints are given one or more tags which for used in grouping)\n\nYou may filter this endpoint using the 'functions' url parameter e.g. ?functions=getBanks,bankById\n\n(Each endpoint is implemented in the OBP Scala code by a 'function')\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById\n\n \n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/resource-docs/API_VERSION/swagger","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCustomerByCustomerId","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerByCustomerId"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID","summary":"Get Customer by CUSTOMER_ID","description":"Gets the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nvalue: 5987953
\nGet all the scopes for an consumer specified by CONSUMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nThis will the datails of the card.
\nIt shows the account infomation which linked the the card.
\nAlso shows the card attributes of the card.
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nattribute_type: STRING
\nbank_id: gh.29.uk
\ncancelled: true
\ncard_attribute_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\non_hot_list: false
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nvalue: 5987953
\nThis endpoint provides example message docs in swagger format.
\nIt is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
\nThat is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
\nOBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nGet the Consumer specified by CONSUMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nCreates OBP user.
\nNo authorisation (currently) required.
Mimics current webform to Register.
\nRequires username(email) and password.
\nReturns 409 error if username not unique.
\nMay require validation of email address.
\nAuthentication is Mandatory
\nJSON request body fields:
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet Accounts which have a firehose view assigned to them.
\nThis endpoint allows bulk access to accounts.
\nRequires the CanUseFirehoseAtAnyBank Role
\nTo be shown on the list, each Account must have a firehose View linked to it.
\nA firehose view has is_firehose = true
\nFor VIEW_ID try 'owner'
\noptional request parameters for filter with attributes
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8
to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be _timestamp_
\nURL params example:
\n/banks/some-bank-id/firehose/accounts/views/owner?manager=John&count=8&_timestamp_=1596762180358
Authentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\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
\ndate: 2020-01-27
\nis_beneficiary: true
\nkey: CustomerNumber
\nlatitude: 38.8951
\nlongitude: -77.0364
\nusername: felixsmith
\nvalue: 5987953
\nGet status of Credit Card orders
\nGet all orders
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nReturns transaction requests for account specified by ACCOUNT_ID at bank specified by BANK_ID.
\nThe VIEW_ID specified must be 'owner' and the user must have access to this view.
\nVersion 2.0.0 now returns charge information.
\nTransaction Requests serve to initiate transactions that may or may not proceed. They contain information including:
\nPSD2 Context: PSD2 requires transparency of charges to the customer.
\nThis endpoint provides the charge that would be applied if the Transaction Request proceeds - and a record of that charge there after.
\nThe customer can proceed with the Transaction by answering the security challenge.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\niban: DE91 1000 0000 0123 4567 89
\nlegal_name: Eveline Tripman
\nstart_date: 2020-01-27
\nvalue: 5987953
\nReturns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns information about a financial Product offered by the bank specified by BANK_ID and PRODUCT_CODE including:\n\n* Name\n* Code\n* Parent Product Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"bank_id":"gh.29.uk","code":"product_code","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"5","name":"TESOBE"}},"product_attributes":[{"product_code":"saving1","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]},"error_response_bodies":["OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"product_code":{"type":"string"}}}},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"},"category":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":["obp.getProduct","obp.getProductAttributesByBankAndCode","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-deleteTaxResidence","implemented_by":{"version":"OBPv3.1.0","function":"deleteTaxResidence"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","summary":"Delete Tax Residence","description":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\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-50000: Unknown Error."],"tags":["Customer","KYC","New-Style"],"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/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax_residencies/TAX_RESIDENCE_ID","connector_methods":["obp.deleteTaxResidence","obp.getCustomerByCustomerId","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getCustomerByCustomerNumber","implemented_by":{"version":"OBPv3.1.0","function":"getCustomerByCustomerNumber"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/customer-number","summary":"Get Customer by CUSTOMER_NUMBER","description":"Gets the Customer specified by CUSTOMER_NUMBER.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nvalue: 5987953
\nCreate an Address for a Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\nCreate or Update a Product Collection at the Bank.
\nUse Product Collections to create Product "Baskets", "Portfolios", "Indices", "Collections", "Underlyings-lists", "Buckets" etc. etc.
\nThere is a many to many relationship between Products and Product Collections:
\nA Product can exist in many Collections
\nA Collection can contain many Products.
\nA collection has collection code, one parent Product and one or more child Products.
\nProduct hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Create or Update a Product Collection at the Bank.\n\nUse Product Collections to create Product \"Baskets\", \"Portfolios\", \"Indices\", \"Collections\", \"Underlyings-lists\", \"Buckets\" etc. etc.\n\nThere is a many to many relationship between Products and Product Collections:\n\n* A Product can exist in many Collections\n\n* A Collection can contain many Products.\n\nA collection has collection code, one parent Product and one or more child Products.\n\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"parent_product_code":"A","children_product_codes":["B","C","D"]},"success_response_body":{"product_collection":[{"collection_code":"C","product_code":"D","items":[{"member_product_code":"A"},{"member_product_code":"B"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product-Collection","Product","New-Style"],"typed_request_body":{"type":"object","properties":{"parent_product_code":{"type":"string"},"children_product_codes":{"type":"array","items":{"type":"string"}}}},"typed_success_response_body":{"type":"object","properties":{"product_collection":{"type":"array","items":{"type":"object","properties":{"collection_code":{"type":"string"},"product_code":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"member_product_code":{"type":"string"}}}}}}}}},"roles":[{"role":"CanMaintainProductCollection","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":["obp.getProducts","obp.getOrCreateProductCollectionItem","obp.getOrCreateProductCollection","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getSystemView","implemented_by":{"version":"OBPv3.1.0","function":"getSystemView"},"request_verb":"GET","request_url":"/obp/v3.1.0/system-views/VIEW_ID","summary":"Get System View","description":"Get System View
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nReturns 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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateCustomerEmail","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerEmail"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/email","summary":"Update the email of a Customer","description":"Update an email of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nIn Sandbox mode, any string that can be converted to a positive integer will be accepted as an answer.
\nThis endpoint totally depends on createTransactionRequest, it need get the following data from createTransactionRequest response body.
\n1)TRANSACTION_REQUEST_TYPE
: is the same as createTransactionRequest request URL .
2)TRANSACTION_REQUEST_ID
: is the id
field in createTransactionRequest response body.
3) id
: is challenge.id
field in createTransactionRequest response body.
4) answer
: must be 123
. if it is in sandbox mode. If it kafka mode, the answer can be got by phone message or other security ways.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_REQUEST_ID: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1
\nTRANSACTION_REQUEST_TYPE: SEPA
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nstart_date: 2020-01-27
\nvalue: 5987953
\nGet the all MethodRoutings.
\nQuery url parameters:
\neg:
\nhttps://api.ttk.com.mk/obp/v3.1.0/management/method_routings?active=true
\nhttps://api.ttk.com.mk/obp/v3.1.0/management/method_routings?method_name=getBank
Authentication is Mandatory
\nJSON response body fields:
\n\n","description_markdown":"Get the all MethodRoutings.\n\nQuery url parameters:\n\n* method_name: filter with method_name\n* active: if active = true, it will show all the webui_ props. Even if they are set yet, we will return all the default webui_ props\n\neg: \nhttps://api.ttk.com.mk/obp/v3.1.0/management/method_routings?active=true\nhttps://api.ttk.com.mk/obp/v3.1.0/management/method_routings?method_name=getBank\n\n\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"method_routings":[{"is_bank_id_exact_match":false,"method_name":"getBanks","connector_name":"rest_vMar2019","method_routing_id":"method-routing-id","bank_id_pattern":"some_bank_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Method-Routing","API","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"method_routings":{"type":"array","items":{"type":"object","properties":{"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"connector_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetMethodRoutings","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/method_routings","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.2.0-createFx","implemented_by":{"version":"OBPv2.2.0","function":"createFx"},"request_verb":"PUT","request_url":"/obp/v2.2.0/banks/BANK_ID/fx","summary":"Create Fx","description":"Create or Update Fx for the Bank.
\nExample:
\n“from_currency_code”:“EUR”,
\n“to_currency_code”:“USD”,
\n“conversion_value”: 1.136305,
\n“inverse_conversion_value”: 1 / 1.136305 = 0.8800454103431737,
Thus 1 Euro = 1.136305 US Dollar
\nand
\n1 US Dollar = 0.8800 Euro
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\nGet user by USER_ID
\nAuthentication is Mandatory
\nCanGetAnyUser entitlement is required,
URL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nUpdate the mobile number of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nCreate 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)
\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"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"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:
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nJSON response body fields:
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\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 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/v3.1.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":"OBPv3.0.0-getViewsForBankAccount","implemented_by":{"version":"OBPv3.0.0","function":"getViewsForBankAccount"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views","summary":"Get Views for Account","description":"Views in Open Bank Project provide a mechanism for fine grained access control and delegation to Accounts and Transactions. Account holders use the 'owner' view by default. Delegated access is made through other views for example 'accountants', 'share-holders' or 'tagging-application'. Views can be created via the API and each view has a list of entitlements.
\nViews on accounts and transactions filter the underlying data to redact certain fields for certain users. For instance the balance on an account may be hidden from the public. The way to know what is possible on a view is determined in the following JSON.
\nData: When a view moderates a set of data, some fields my contain the value null
rather than the original value. This indicates either that the user is not allowed to see the original data or the field is empty.
There is currently one exception to this rule; the 'holder' field in the JSON contains always a value which is either an alias or the real name - indicated by the 'is_alias' field.
\nAction: When a user performs an action like trying to post a comment (with POST API call), if he is not allowed, the body response will contain an error message.
\nMetadata:
\nTransaction metadata (like images, tags, comments, etc.) will appears ONLY on the view where they have been created e.g. comments posted to the public view only appear on the public view.
The other account metadata fields (like image_URL, more_info, etc.) are unique through all the views. Example, if a user edits the 'more_info' field in the 'team' view, then the view 'authorities' will show the new value (if it is allowed to do it).
\nOptional
\nReturns the list of the views created for account ACCOUNT_ID at BANK_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nGrants the User identified by PROVIDER_ID at PROVIDER access to the view VIEW_ID at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER and PROVIDER_ID.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nGranting access to a public view will return an error message, as the user already has access.
\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:
\nGet Transaction Types for the bank specified by BANK_ID:
\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Get Transaction Types for the bank specified by BANK_ID:\n\nLists the possible Transaction Types available at the bank (as opposed to Transaction Request Types which are the possible ways Transactions can be created by this API Server).\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_types":[{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_types":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/transaction-types","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateCustomerCreditRatingAndSource","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerCreditRatingAndSource"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit-rating-and-source","summary":"Update the credit rating and source of a Customer","description":"Update the credit rating and source of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_number: 5987953
\nLink a User to a Customer
\nAuthentication is Mandatory
\nCanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.
\nURL Parameters:
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nThis endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
Authentication is Mandatory
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"email": "eveline@example.com"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
URL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalid_from: 2020-01-27
\nview_id: owner
\nJSON response body fields:
\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\" or \"EMAIL\". \"EMAIL\" is used for testing purposes.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nAuthentication is Mandatory\n\nExample 1: \n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"email\": \"eveline@example.com\"\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [EMAIL](/glossary#developer_email): felixsmith@example.com\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [account_id](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n* [email](/glossary#developer_email): felixsmith@example.com\n\n\n\n* [valid_from](/glossary#valid_from): 2020-01-27\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":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","email":"felixsmith@example.com","valid_from":"2024-03-07T13:59:21Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-35009: Only SMS and EMAIL are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"email":{"type":"string"},"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"valid_from":{"type":"string","format":"date-time"},"everything":{"type":"boolean"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/EMAIL","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"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 information about ATM for a single bank specified by BANK_ID and ATM_ID including:
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nhas_deposit_capability: true
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\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/v3.1.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-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/v3.1.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-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/v3.1.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.4.0-getTransactionRequestTypes","implemented_by":{"version":"OBPv1.4.0","function":"getTransactionRequestTypes"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","summary":"Get Transaction Request Types for Account","description":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.
\nThese are the ways this API Server can create a Transaction via a Transaction Request
\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)
A Transaction Request Type internally determines:
\nFor instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.
\nThis approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.
\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":"Returns the Transaction Request Types that the account specified by ACCOUNT_ID and view specified by VIEW_ID has access to.\n\nThese are the ways this API Server can create a Transaction via a Transaction Request\n(as opposed to Transaction Types which include external types too e.g. for Transactions created by core banking etc.)\n\n A Transaction Request Type internally determines:\n\n * the required Transaction Request 'body' i.e. fields that define the 'what' and 'to' of a Transaction Request,\n * the type of security challenge that may be be raised before the Transaction Request proceeds, and\n * the threshold of that challenge.\n\n For instance in a 'SANDBOX_TAN' Transaction Request, for amounts over 1000 currency units, the user must supply a positive integer to complete the Transaction Request and create a Transaction.\n\n This approach aims to provide only one endpoint for initiating transactions, and one that handles challenges, whilst still allowing flexibility with the payload and internal logic.\n \n \n\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* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"transaction_request_types":[{"value":"10","charge":{"summary":"The bank fixed charge","value":{"currency":"EUR","amount":"0"}}}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.","Please specify a valid value for CURRENCY of your Bank Account. ","Current user does not have access to the view ","account not found at bank","user does not have access to owner view","OBP-40018: Sorry, Transaction Requests are not enabled in this API instance.","OBP-50000: Unknown Error."],"tags":["Transaction-Request","Payment Initiation Service (PIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"transaction_request_types":{"type":"array","items":{"type":"object","properties":{"charge":{"type":"object","properties":{"value":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"}}},"value":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types","connector_methods":["obp.getTransactionRequestTypes","obp.getTransactionRequestTypeCharges","obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getObpConnectorLoopback","implemented_by":{"version":"OBPv3.1.0","function":"getObpConnectorLoopback"},"request_verb":"GET","request_url":"/obp/v3.1.0/connector/loopback","summary":"Get Connector Status (Loopback)","description":"This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable.
\nCurrently this is only implemented for Kafka based connectors.
\nFor Kafka based connectors, this endpoint writes a message to Kafka and reads it again.
\nIn the future, this endpoint may also return information about database connections etc.
\nAuthentication is Mandatory
\nJSON response body fields:
\nGet User Login Status.
\nAuthentication is Mandatory
URL Parameters:
\nJSON response body fields:
\nReturns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID).
\nAuthentication is Optional
\nAuthentication is required if the view is not public.
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndate: 2020-01-27
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nPosts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.
\n${authenticationRequiredMessage(false)}
\nAuthentication is required since the comment is linked with the user.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n\n","description_markdown":"Posts a comment about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\n${authenticationRequiredMessage(false)}\n\nAuthentication is required since the comment is linked with the user.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","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-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getBranches","implemented_by":{"version":"OBPv3.0.0","function":"getBranches"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches","summary":"Get Branches for a Bank","description":"Returns information about branches for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 50 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nYou can also use the follow url query parameters:
city - string, find Branches those in this city, optional
\nwithinMetersOf - number, find Branches within given meters distance, optional
\nnote: withinMetersOf, nearLatitude and nearLongitude either all empty or all have value.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nCreate a message for the customer specified by CUSTOMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Create a message for the customer specified by CUSTOMER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"message":"String","from_department":"String","from_person":"String"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer-Message","Customer","Person"],"typed_request_body":{"type":"object","properties":{"message":{"type":"string"},"from_department":{"type":"string"},"from_person":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customer/CUSTOMER_ID/messages","connector_methods":["obp.createMessage","obp.getCustomerByCustomerId","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getUsers","implemented_by":{"version":"OBPv3.0.0","function":"getUsers"},"request_verb":"GET","request_url":"/obp/v3.0.0/users","summary":"Get all Users","description":"Get all users
\nAuthentication is Mandatory
\nCanGetAnyUser entitlement is required,
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nAdd a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\nexpiry_date: 2021-01-27
\nissue_date: 2020-01-27
\nCreate a MethodRouting.
\nAuthentication is Mandatory
\nExplaination of Fields:
\nnote:
\nIf connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
JSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Create a MethodRouting.\n\n\nAuthentication is Mandatory\n\nExplaination of Fields:\n\n* method_name is required String value, current supported value: [mapped | stored_procedure_vDec2019 | rest_vMar2019]\n* connector_name is required String value\n* is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false\n* bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex\n* parameters is optional array of key value pairs. You can set some paremeters for this method\n\nnote:\n\n* if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = \"some\\-id_pattern_\\d+\"\n\nIf connector name start with rest, parameters can contain \"outBoundMapping\" and \"inBoundMapping\", convert OutBound and InBound json structure.\nfor example:\n outBoundMapping example, convert json from source to target:\n![Snipaste_outBoundMapping](https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png)\nBuild OutBound json value rules:\n1 set cId value with: outboundAdapterCallContext.correlationId value\n2 set bankId value with: concat bankId.value value with string helloworld\n3 set originalJson value with: whole source json, note: the field value expression is $root\n\n\n inBoundMapping example, convert json from source to target:\n![inBoundMapping](https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png)\nBuild InBound json value rules:\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with \"$default\", remove \"$default\" from field name, not change the value\n3 set fullName value with: concat string full: with result.name value\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].\n\n\n**JSON request body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"is_bank_id_exact_match":false,"method_name":"getBank","connector_name":"rest_vMar2019","bank_id_pattern":"some_bankId_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"success_response_body":{"is_bank_id_exact_match":false,"method_name":"getBank","connector_name":"rest_vMar2019","method_routing_id":"this-method-routing-Id","bank_id_pattern":"some_bankId_.*","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-10021: Incorrect Connector name.","OBP-10022: Incorrect Connector method name.","OBP-50000: Unknown Error."],"tags":["Method-Routing","API","New-Style"],"typed_request_body":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"connector_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"method_name":{"type":"string"},"bank_id_pattern":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"is_bank_id_exact_match":{"type":"boolean"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}},"roles":[{"role":"CanCreateMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/method_routings","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateSystemView","implemented_by":{"version":"OBPv3.1.0","function":"updateSystemView"},"request_verb":"PUT","request_url":"/obp/v3.1.0/system-views/VIEW_ID","summary":"Update System View","description":"Update an existing view on a bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe json sent is the same as during view creation (above), with one difference: the 'name' field
\nof a view is not editable (it is only set when a view is created)
URL Parameters:
\nJSON response body fields:
\nReturns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
\nIt represents the location where the transaction has been initiated.
Authentication via OAuth is required if the view is not public.
\nAuthentication 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:
\n\n","description_markdown":"Returns the \"where\" Geo tag added to the transaction TRANSACTION_ID made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\nIt represents the location where the transaction has been initiated.\n\nAuthentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [date](/glossary#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":{"where":{"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-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"where":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"longitude":{"type":"number"},"latitude":{"type":"number"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-getKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"getKycMedia"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_media","summary":"Get KYC Media for a customer","description":"Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nGet the Tax Residences of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Get the Tax Residences of the Customer specified by CUSTOMER_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"tax_residence":[{"domain":"Enter some domain","tax_number":"Enter some number","tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Customer","KYC","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"tax_residence":{"type":"array","items":{"type":"object","properties":{"tax_number":{"type":"string"},"domain":{"type":"string"},"tax_residence_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/tax-residences","connector_methods":["obp.getTaxResidence","obp.getCustomerByCustomerId","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createProduct","implemented_by":{"version":"OBPv3.1.0","function":"createProduct"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE","summary":"Create Product","description":"Create or Update Product for the Bank.
\nTypical Super Family values / Asset classes are:
\nDebt
\nEquity
\nFX
\nCommodity
\nDerivative
Product hiearchy vs Product Collections:
\nYou can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.
\nYou can define a collection (also known as baskets or buckets) of products using Product Collections.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Create or Update Product for the Bank.\n\n\nTypical Super Family values / Asset classes are:\n\nDebt\nEquity\nFX\nCommodity\nDerivative\n\n\n\nProduct hiearchy vs Product Collections:\n\n* You can define a hierarchy of products - so that a child Product inherits attributes of its parent Product - using the parent_product_code in Product.\n\n* You can define a collection (also known as baskets or buckets) of products using Product Collections.\n\n \n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"name":"product name","parent_product_code":"parent product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"5","name":"TESOBE"}}},"success_response_body":{"bank_id":"gh.29.uk","code":"product_code","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"5","name":"TESOBE"}},"product_attributes":[{"product_code":"saving1","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Product","New-Style"],"typed_request_body":{"type":"object","properties":{"super_family":{"type":"string"},"description":{"type":"string"},"details":{"type":"string"},"more_info_url":{"type":"string"},"family":{"type":"string"},"parent_product_code":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"},"category":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"super_family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"product_code":{"type":"string"}}}},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"},"category":{"type":"string"}}},"roles":[{"role":"CanCreateProduct","requires_bank_id":true},{"role":"CanCreateProductAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE","connector_methods":["obp.getProduct","obp.createOrUpdateProduct","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-getEntitlementsByBankAndUser","implemented_by":{"version":"OBPv2.1.0","function":"getEntitlementsByBankAndUser"},"request_verb":"GET","request_url":"/obp/v2.1.0/banks/BANK_ID/users/USER_ID/entitlements","summary":"Get Entitlements for User at Bank","description":"Get Entitlements specified by BANK_ID and USER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\nGet the Account Application.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet the all WebUiProps key values, those props key with "webui_" can be stored in DB, this endpoint get all from DB.
\nurl query parameter:
\nactive: It must be a boolean string. and If active = true, it will show
\ncombination of explicit (inserted) + implicit (default) method_routings.
eg:
\nhttps://api.ttk.com.mk/obp/v3.1.0/management/webui_props
\nhttps://api.ttk.com.mk/obp/v3.1.0/management/webui_props?active=true
Authentication is Mandatory
\nJSON response body fields:
\nReturns information about ATMs for a single bank specified by BANK_ID including:
\nPagination:
\nBy default, 100 records are returned.
\nYou can use the url query parameters limit and offset for pagination
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nhas_deposit_capability: true
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nReturns the account owner description of the transaction moderated by the view.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication 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:
\n","description_markdown":"Returns the account owner description of the transaction [moderated](#1_2_1-getViewsForBankAccount) by the view.\n\nAuthentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"narrative":"narative"},"error_response_bodies":["OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateMethodRouting","implemented_by":{"version":"OBPv3.1.0","function":"updateMethodRouting"},"request_verb":"PUT","request_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","summary":"Update MethodRouting","description":"Update a MethodRouting.
\nAuthentication is Mandatory
\nExplaination of Fields:
\nif bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = "some-id_pattern_\\d+"
\nIf connector name start with rest, parameters can contain "outBoundMapping" and "inBoundMapping", to convert OutBound and InBound json structure.
\nfor example:
\noutBoundMapping example, convert json from source to target:
\n
\nBuild OutBound json value rules:
\n1 set cId value with: outboundAdapterCallContext.correlationId value
\n2 set bankId value with: concat bankId.value value with string helloworld
\n3 set originalJson value with: whole source json, note: the field value expression is $root
inBoundMapping example, convert json from source to target:
\n
\nBuild InBound json value rules:
\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with "$default", remove "$default" from field name, not change the value
\n3 set fullName value with: concat string full: with result.name value
\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].
URL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Update a MethodRouting.\n\n\nAuthentication is Mandatory\n\nExplaination of Fields:\n\n* method_name is required String value, current supported value: [mapped | stored_procedure_vDec2019 | rest_vMar2019]\n* connector_name is required String value\n* is_bank_id_exact_match is required boolean value, if bank_id_pattern is exact bank_id value, this value is true; if bank_id_pattern is null or a regex, this value is false\n* bank_id_pattern is optional String value, it can be null, a exact bank_id or a regex\n* parameters is optional array of key value pairs. You can set some paremeters for this method\nnote:\n\n* if bank_id_pattern is regex, special characters need to do escape, for example: bank_id_pattern = \"some\\-id_pattern_\\d+\"\n\nIf connector name start with rest, parameters can contain \"outBoundMapping\" and \"inBoundMapping\", to convert OutBound and InBound json structure.\nfor example:\n outBoundMapping example, convert json from source to target:\n![Snipaste_outBoundMapping](https://user-images.githubusercontent.com/2577334/75248007-33332e00-580e-11ea-8d2a-d1856035fa24.png)\nBuild OutBound json value rules:\n1 set cId value with: outboundAdapterCallContext.correlationId value\n2 set bankId value with: concat bankId.value value with string helloworld\n3 set originalJson value with: whole source json, note: the field value expression is $root\n\n\n inBoundMapping example, convert json from source to target:\n![inBoundMapping](https://user-images.githubusercontent.com/2577334/75248199-a9d02b80-580e-11ea-9238-e073264e9170.png)\nBuild InBound json value rules:\n1 and 2 set inboundAdapterCallContext and status value: because field name ends with \"$default\", remove \"$default\" from field name, not change the value\n3 set fullName value with: concat string full: with result.name value\n4 set bankRoutingScheme value: because source value is Array, but target value is not Array, the mapping field name must ends with [0].\n\n\n**URL Parameters:**\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"is_bank_id_exact_match":true,"method_name":"getBank","connector_name":"rest_vMar2019","bank_id_pattern":"some_bankId","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"success_response_body":{"is_bank_id_exact_match":true,"method_name":"getBank","connector_name":"rest_vMar2019","method_routing_id":"this-method-routing-Id","bank_id_pattern":"some_bankId","parameters":[{"key":"url","value":"http://mydomain.com/xxx"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10001: Incorrect json format.","OBP-10021: Incorrect Connector name.","OBP-10022: Incorrect Connector method name.","OBP-50000: Unknown Error."],"tags":["Method-Routing","API","New-Style"],"typed_request_body":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"connector_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"is_bank_id_exact_match":{"type":"boolean"},"method_name":{"type":"string"},"parameters":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"key":{"type":"string"}}}},"bank_id_pattern":{"type":"string"},"method_routing_id":{"type":"string"},"connector_name":{"type":"string"}}},"roles":[{"role":"CanUpdateMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-deleteScope","implemented_by":{"version":"OBPv3.0.0","function":"deleteScope"},"request_verb":"DELETE","request_url":"/obp/v3.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID","summary":"Delete Consumer Scope","description":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Scope","Role","Entitlement","New-Style"],"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/v3.1.0/consumers/CONSUMER_ID/scope/SCOPE_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-createTransactionRequestFreeForm","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestFreeForm"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/FREE_FORM/transaction-requests","summary":"Create Transaction Request (FREE_FORM)","description":"Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"AED":0.1688,
\n"INR":3.3513,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":0.192964,
\n"INR":18.3255,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"JPY":113.161,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\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:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\niban: DE91 1000 0000 0123 4567 89
\nlegal_name: Eveline Tripman
\nstart_date: 2020-01-27
\nvalue: 5987953
\nSearch the API calls made to this API instance via Elastic Search.
\nLogin is required.
\nCanSearchMetrics entitlement is required to search metrics data.
\nparameters:
\nesType - elasticsearch type
\nsimple query:
\nq - plain_text_query
\ndf - default field to search
\nsort - field to sort on
\nsize - number of hits returned, default 10
\nfrom - show hits starting from
\njson query:
\nsource - JSON_query_(URL-escaped)
\nexample usage:
\n/search/metrics/q=findThis
\nor:
\n/search/metrics/source={"query":{"query_string":{"query":"findThis"}}}
\nNote!!
\nThe whole JSON query string MUST be URL-encoded:
\netc..
\nOnly q, source and esType are passed to Elastic
\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Search the API calls made to this API instance via Elastic Search.\n\nLogin is required.\n\nCanSearchMetrics entitlement is required to search metrics data.\n\n\nparameters:\n\n esType - elasticsearch type\n\n simple query:\n\n q - plain_text_query\n\n df - default field to search\n\n sort - field to sort on\n\n size - number of hits returned, default 10\n\n from - show hits starting from\n\n json query:\n\n source - JSON_query_(URL-escaped)\n\n\nexample usage:\n\n /search/metrics/q=findThis\n\nor:\n\n /search/metrics/source={\"query\":{\"query_string\":{\"query\":\"findThis\"}}}\n\n\nNote!!\n\nThe whole JSON query string MUST be URL-encoded:\n\n* For { use %7B\n* For } use %7D\n* For : use %3A\n* For \" use %22\n\netc..\n\n\n\nOnly q, source and esType are passed to Elastic\n\nElastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html\n\nElastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html\n\n\n \n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","API"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/search/metrics","connector_methods":[]},{"operation_id":"OBPv3.1.0-createAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"createAccountWebhook"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Create an Account Webhook","description":"Create an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nGet basic information about the Adapter listening on behalf of this bank.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nReturns transactions list (Core info) of the account specified by ACCOUNT_ID.
\nAuthentication is Mandatory
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nDelete the Auth Contexts of a User specified by USER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete the Auth Contexts of a User specified by USER_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/users/USER_ID/auth-context","connector_methods":["obp.deleteUserAuthContexts","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-sandboxDataImport","implemented_by":{"version":"OBPv2.1.0","function":"sandboxDataImport"},"request_verb":"POST","request_url":"/obp/v2.1.0/sandbox/data-import","summary":"Create sandbox","description":"Import bulk data into the sandbox (Authenticated access).
\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.
\nThe user needs to have CanCreateSandbox entitlement.
\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.
\nAn example of an import set of data (json) can be found here
\nAuthentication is Mandatory
JSON request body fields:
\nIBAN: DE91 1000 0000 0123 4567 89
\naccount_number: 546387432
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncompleted: 2020-01-27
\ncurrency: EUR
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\nnew_balance: 20
\npassword: password
\nposted: 2020-01-27
\nuser_name: felixsmith
\nvalue: 5987953
\nJSON response body fields:
\n","description_markdown":"Import bulk data into the sandbox (Authenticated access).\n\nThis call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS.\n\nThe user needs to have CanCreateSandbox entitlement.\n\nNote: This is a monolithic call. You could also use a combination of endpoints including create bank, create user, create account and create transaction request to create similar data.\n\nAn example of an import set of data (json) can be found [here](https://raw.githubusercontent.com/OpenBankProject/OBP-API/develop/obp-api/src/main/scala/code/api/sandbox/example_data/2016-04-28/example_import.json)\nAuthentication is Mandatory\n\n\n**JSON request body fields:**\n\n\n\n* [IBAN](/glossary#Account.iban): DE91 1000 0000 0123 4567 89\n\n\n\n* [account_number](/glossary#can_see_other_account_number): 546387432\n\n\n\n* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [balance](/glossary#new_balance): 10\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [completed](/glossary#completed): 2020-01-27\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [email](/glossary#developer_email): felixsmith@example.com\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n\n* [new_balance](/glossary#new_balance): 20\n\n\n\n* [password](/glossary#User.password): password\n\n\n\n* [posted](/glossary#posted): 2020-01-27\n\n\n\n* [user_name](/glossary#): felixsmith\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"banks":[{"id":"bank1","short_name":"bank 1","full_name":"Bank 1 Inc.","logo":"http://example.com/logo","website":"http://example.com"},{"id":"bank2","short_name":"bank 2","full_name":"Bank 2 Inc.","logo":"http://example.com/logo2","website":"http://example.com/2"}],"users":[{"email":"user1@example.com","password":"TESOBE520berlin123!","user_name":"User 1"},{"email":"user2@example.com","password":"TESOBE520berlin123!","user_name":"User 2"}],"accounts":[{"id":"account1","bank":"bank1","label":"Account 1 at Bank 1","number":"1","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"1234567890","owners":["User 1"],"generate_public_view":true,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account2","bank":"bank1","label":"Account 2 at Bank 1","number":"2","type":"current","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"91234567890","owners":["User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true},{"id":"account1","bank":"bank2","label":"Account 1 at Bank 2","number":"22","type":"savings","balance":{"currency":"EUR","amount":"1000.00"},"IBAN":"21234567890","owners":["User 1","User 2"],"generate_public_view":false,"generate_accountants_view":true,"generate_auditors_view":true}],"transactions":[{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank2"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartNameTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"account_number":"123456-AVB"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"blankCounterpartAccountNumberTransaction","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Piano Repair"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-with-counterparty","this_account":{"id":"account1","bank":"bank1"},"counterparty":{"name":"Acme Inc.","account_number":"12345-B"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}},{"id":"transaction-without-counterparty","this_account":{"id":"account1","bank":"bank1"},"details":{"type":"SEPA","description":"some description","posted":"2012-03-07T00:00:00.001Z","completed":"2012-04-07T00:00:00.001Z","new_balance":"1244.00","value":"-135.33"}}],"branches":[{"id":"branch1","bank_id":"bank1","name":"Genel Müdürlük","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}},{"id":"branch2","bank_id":"bank1","name":"Manchester","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}},"lobby":{"hours":"M-TH 8:30-3:30, F 9-5"},"driveUp":{"hours":"M-Th 8:30-5:30, F-8:30-6, Sat 9-12"}}],"atms":[{"id":"atm1","bank_id":"bank1","name":"Ashbourne Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"id":"atm2","bank_id":"bank1","name":"Manchester Atm 1","address":{"line_1":"5 Some Street","line_2":"Rosy Place","line_3":"Sunny Village","city":"Ashbourne","county":"Derbyshire","state":"","post_code":"WHY RU4","country_code":"UK"},"location":{"latitude":52.556198,"longitude":13.384099},"meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"products":[{"bank_id":"bank1","code":"prd1","name":"product 1","category":"cat1","family":"fam1","super_family":"sup fam 1","more_info_url":"www.example.com/index1","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}},{"bank_id":"bank1","code":"prd2","name":"Product 2","category":"cat2","family":"fam2","super_family":"sup fam 2","more_info_url":"www.example.com/index2","meta":{"license":{"id":"pddl","name":"Open Data Commons Public Domain Dedication and License (PDDL)"}}}],"crm_events":[{"id":"ASDFHJ47YKJH","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"2017-09-19T02:31:05.000Z"},{"id":"KIFJA76876AS","bank_id":"bank1","customer":{"name":"James Brown","number":"698761728934"},"category":"Call","detail":"Check mortgage","channel":"Phone","actual_date":"2017-09-19T02:31:05.000Z"}]},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-00002: Data import is disabled for this API instance.","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Sandbox","API"],"typed_request_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"IBAN":{"type":"string"},"generate_accountants_view":{"type":"boolean"},"owners":{"type":"array","items":{"type":"string"}},"generate_public_view":{"type":"boolean"},"bank":{"type":"string"},"id":{"type":"string"},"generate_auditors_view":{"type":"boolean"},"label":{"type":"string"},"number":{"type":"string"},"balance":{"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string"}}},"type":{"type":"string"}}}},"branches":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"driveUp":{"type":"object","properties":{"hours":{"type":"string"}}},"lobby":{"type":"object","properties":{"hours":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"this_account":{"type":"object","properties":{"id":{"type":"string"},"bank":{"type":"string"}}},"details":{"type":"object","properties":{"value":{"type":"string"},"new_balance":{"type":"string"},"type":{"type":"string"},"completed":{"type":"string"},"posted":{"type":"string"},"description":{"type":"string"}}}}}},"products":{"type":"array","items":{"type":"object","properties":{"family":{"type":"string"},"name":{"type":"string"},"category":{"type":"string"},"bank_id":{"type":"string"},"super_family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"code":{"type":"string"},"more_info_url":{"type":"string"}}}},"atms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"location":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}},"address":{"type":"object","properties":{"line_2":{"type":"string"},"county":{"type":"string"},"line_3":{"type":"string"},"state":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"line_1":{"type":"string"},"city":{"type":"string"}}},"bank_id":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"id":{"type":"string"}}}},"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"user_name":{"type":"string"},"password":{"type":"string"}}}},"banks":{"type":"array","items":{"type":"object","properties":{"full_name":{"type":"string"},"short_name":{"type":"string"},"logo":{"type":"string"},"website":{"type":"string"},"id":{"type":"string"}}}},"crm_events":{"type":"array","items":{"type":"object","properties":{"actual_date":{"type":"string","format":"date-time"},"channel":{"type":"string"},"bank_id":{"type":"string"},"customer":{"type":"object","properties":{"number":{"type":"string"},"name":{"type":"string"}}},"category":{"type":"string"},"id":{"type":"string"},"detail":{"type":"string"}}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanCreateSandbox","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/sandbox/data-import","connector_methods":[]},{"operation_id":"OBPv3.1.0-getCreditLimitRequestByRequestId","implemented_by":{"version":"OBPv3.1.0","function":"getCreditLimitRequestByRequestId"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests/REQUEST_ID","summary":"Get Credit Limit Order Request By Request Id","description":"NOTE: This endpoint currently only returns example data.
\n Get Credit Limit Order Request By Request Id\n
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \n Get Credit Limit Order Request By Request Id\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"rank_amount_1":"String","nominal_interest_1":"String","rank_amount_2":"String","nominal_interest_2":"String"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Customer","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"nominal_interest_1":{"type":"string"},"rank_amount_1":{"type":"string"},"rank_amount_2":{"type":"string"},"nominal_interest_2":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests/REQUEST_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateCustomerNumber","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerNumber"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/number","summary":"Update the number of a Customer","description":"Update the number of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nUpdate Card at bank specified by CARD_ID .
\nAuthentication is Mandatory
URL Parameters:
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncancelled: true
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\non_hot_list: false
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nReturns information about the financial products offered by a bank specified by BANK_ID including:
\nCan filter with attributes name and values.
\nURL params example: /banks/some-bank-id/products?manager=John&count=8
Authentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns information about the financial products offered by a bank specified by BANK_ID including:\n\n* Name\n* Code\n* Parent Product Code\n* Category\n* Family\n* Super Family\n* More info URL\n* Description\n* Terms and Conditions\n* License the data under this endpoint is released under\n\nCan filter with attributes name and values.\nURL params example: /banks/some-bank-id/products?manager=John&count=8\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"products":[{"bank_id":"gh.29.uk","code":"product_code","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"5","name":"TESOBE"}},"product_attributes":[{"product_code":"saving1","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30011: Product not found. Please specify a valid value for PRODUCT_CODE.","OBP-50000: Unknown Error."],"tags":["Product","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"product_code":{"type":"string"}}}},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"},"category":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/products","connector_methods":["obp.getProducts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-addTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"addTagForViewOnTransaction"},"request_verb":"POST","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Add a tag","description":"Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nAuthentication is required as the tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n\n","description_markdown":"Posts a tag about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nAuthentication is required as the tag is linked with the user.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"value":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-deleteCardForBank","implemented_by":{"version":"OBPv3.1.0","function":"deleteCardForBank"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID","summary":"Delete Card","description":"Delete a Card at bank specified by CARD_ID .
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete a Card at bank specified by CARD_ID .\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CARD_ID](/glossary#Adapter.card_id): 36f8a9e6-c2b1-407a-8bd0-421b7119307e \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-20006: User is missing one or more roles: ","OBP-10015: Allowed values are: ","OBP-50000: Unknown Error."],"tags":["Card","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanCreateCardsForBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/banks/BANK_ID/cards/CARD_ID","connector_methods":["obp.deletePhysicalCardForBank","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-deleteCustomerAddress","implemented_by":{"version":"OBPv3.1.0","function":"deleteCustomerAddress"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","summary":"Delete Customer Address","description":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\n","description_markdown":"Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Customer","KYC","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteCustomerAddress","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/addresses/CUSTOMER_ADDRESS_ID","connector_methods":["obp.deleteCustomerAddress","obp.getCustomerByCustomerId","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getServerJWK","implemented_by":{"version":"OBPv3.1.0","function":"getServerJWK"},"request_verb":"GET","request_url":"/obp/v3.1.0/certs","summary":"Get JSON Web Key (JWK)","description":"Get the server's public JSON Web Key (JWK) set and certificate chain.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get the server's public JSON Web Key (JWK) set and certificate chain.\n It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.\n\n \n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"kty":"RSA","e":"AQAB","use":"sig","kid":"fr6-BxXH5gikFeZ2O6rGk0LUmJpukeswASN_TMW8U_s","n":"hrB0OWqg6AeNU3WCnhheG18R5EbQtdNYGOaSeylTjkj2lZr0_vkhNVYvase-CroxO4HOT06InxTYwLnmJiyv2cZxReuoVjTlk--olGu-9MZooiFiqWez0JzndyKxQ27OiAjFsMh0P04kaUXeHKhXRfiU7K2FqBshR1UlnWe7iHLkq2p9rrGjxQc7ff0w-Uc0f-8PWg36Y2Od7s65493iVQwnI13egqMaSvgB1s8_dgm08noEjhr8C5m1aKmr5oipWEPNi-SBV2VNuiCLR1IEPuXq0tOwwZfv31t34KPO-2H2bbaWmzGJy9mMOGqoNrbXyGiUZoyeHRELaNtm1GilyQ"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"kid":{"type":"string"},"use":{"type":"string"},"n":{"type":"string"},"e":{"type":"string"},"kty":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/certs","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-root","implemented_by":{"version":"OBPv1.2.1","function":"root"},"request_verb":"GET","request_url":"/obp/v1.2.1/root","summary":"Get API Info (root)","description":"Returns information about:
\nAuthentication is Optional
\nJSON response body fields:
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nUpdates 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/v3.1.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-getPrivateAccountIdsbyBankId","implemented_by":{"version":"OBPv3.0.0","function":"getPrivateAccountIdsbyBankId"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/account_ids/private","summary":"Get Accounts at Bank (IDs only)","description":"Returns only the list of accounts ids at BANK_ID that the user has access to.
\nEach account must have at least one private View.
\nFor each account the API returns its account ID.
\nIf you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Returns only the list of accounts ids at BANK_ID that the user has access to.\n\nEach account must have at least one private View.\n\nFor each account the API returns its account ID.\n\nIf you want to see more information on the Views, use the Account Detail call.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts/account_ids/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/account_ids/private","connector_methods":["obp.getCoreBankAccounts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-getMetrics","implemented_by":{"version":"OBPv2.1.0","function":"getMetrics"},"request_verb":"GET","request_url":"/obp/v2.1.0/management/metrics","summary":"Get Metrics","description":"Get the all metrics
\nrequire CanReadMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
\n2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z
\n3 limit (for pagination: defaults to 50) eg:limit=200
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\n5 sort_by (defaults to date field) eg: sort_by=date
\npossible values:
\n"url",
\n"date",
\n"user_name",
\n"app_name",
\n"developer_email",
\n"implemented_by_partial_function",
\n"implemented_in_version",
\n"consumer_id",
\n"verb"
6 direction (defaults to date desc) eg: direction=desc
\neg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=10000&offset=0&anon=false&app_name=TeatApp&implemented_in_version=v2.1.0&verb=POST&user_id=c7b6cb47-cb96-4441-8801-35b57456753a&user_name=susan.uk.29@example.com&consumer_id=78
\nOther filters:
\n7 consumer_id (if null ignore)
\n8 user_id (if null ignore)
\n9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n10 url (if null ignore), note: can not contain '&'.
\n11 app_name (if null ignore)
\n12 implemented_by_partial_function (if null ignore),
\n13 implemented_in_version (if null ignore)
\n14 verb (if null ignore)
\n15 correlation_id (if null ignore)
\n16 duration (if null ignore) non digit chars will be silently omitted
\nAuthentication is Mandatory
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nuser_name: felixsmith
\nShould be able to filter on the following fields
\neg:/management/banks/BANK_ID/cards?customer_id=66214b8e-259e-44ad-8868-3eb47be70646&account_id=8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
\n1 customer_id should be valid customer_id, otherwise, it will return an empty card list.
\n2 account_id should be valid account_id , otherwise, it will return an empty card list.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncancelled: true
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\non_hot_list: false
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nAdd a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: true
\nUpdates 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/v3.1.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":"OBPv3.1.0-getProductCollection","implemented_by":{"version":"OBPv3.1.0","function":"getProductCollection"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","summary":"Get Product Collection","description":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns information about the financial Product Collection specified by BANK_ID and COLLECTION_CODE:\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"collection_code":"A","products":[{"bank_id":"gh.29.uk","code":"product_code","parent_product_code":"parent","name":"product name","category":"category","family":"family","super_family":"super family","more_info_url":"www.example.com/prod1/more-info.html","details":"Details","description":"Description","meta":{"license":{"id":"5","name":"TESOBE"}},"product_attributes":[{"product_code":"saving1","product_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","name":"OVERDRAFT_START_DATE","type":"DATE_WITH_DAY","value":"2012-04-23"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Product-Collection","Product","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"products":{"type":"array","items":{"type":"object","properties":{"super_family":{"type":"string"},"product_attributes":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"product_attribute_id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"product_code":{"type":"string"}}}},"description":{"type":"string"},"details":{"type":"string"},"code":{"type":"string"},"parent_product_code":{"type":"string"},"bank_id":{"type":"string"},"more_info_url":{"type":"string"},"family":{"type":"string"},"meta":{"type":"object","properties":{"license":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}},"name":{"type":"string"},"category":{"type":"string"}}}},"collection_code":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/product-collections/COLLECTION_CODE","connector_methods":["obp.getProductCollectionItemsTree","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-getCommentsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getCommentsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","summary":"Get comments","description":"Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the transaction TRANSACTION_ID comments made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n\nAuthentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"comments":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-createTransactionType","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionType"},"request_verb":"PUT","request_url":"/obp/v2.1.0/banks/BANK_ID/transaction-types","summary":"Create Transaction Type at bank","description":"Create Transaction Types for the bank specified by BANK_ID:
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Create Transaction Types for the bank specified by BANK_ID:\n\n * id : Unique transaction type id across the API instance. SHOULD be a UUID. MUST be unique.\n * bank_id : The bank that supports this TransactionType\n * short_code : A short code (SHOULD have no-spaces) which MUST be unique across the bank. May be stored with Transactions to link here\n * summary : A succinct summary\n * description : A longer description\n * charge : The charge to the customer for each one of these\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [amount](/glossary#temporary_requested_current_amount): 10.12\n\n\n\n* [currency](/glossary#can_see_transaction_currency): EUR\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"id":{"value":"123"},"bank_id":"gh.29.uk","short_code":"PlaceholderString","summary":"PlaceholderString","description":"PlaceholderString","charge":{"currency":"EUR","amount":"0"}},"success_response_body":{"id":{"value":"123"},"bankId":{"value":"gh.uk.9j"},"shortCode":"80080","summary":"SANDBOX_TAN","description":"This is the sandbox mode, charging litter money.","charge":{"currency":"EUR","amount":"100"}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-40005: Insufficient authorisation to Create Transaction Type offered by the bank. The Request could not be created because you don't have access to CanCreateTransactionType.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Bank"],"typed_request_body":{"type":"object","properties":{"description":{"type":"string"},"short_code":{"type":"string"},"bank_id":{"type":"string"},"summary":{"type":"string"},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"typed_success_response_body":{"type":"object","properties":{"bankId":{"type":"object","properties":{"value":{"type":"string"}}},"charge":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"string"}}},"summary":{"type":"string"},"shortCode":{"type":"string"},"description":{"type":"string"},"id":{"type":"object","properties":{"value":{"type":"string"}}}}},"roles":[{"role":"CanCreateTransactionType","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/transaction-types","connector_methods":["obp.getBankLegacy"]},{"operation_id":"OBPv3.1.0-updateCustomerData","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerData"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/data","summary":"Update the other data of a Customer","description":"Update the other data of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nGets all Customers that are linked to a User.
\nAuthentication is Mandatory
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nCreate Card at bank specified by BANK_ID .
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nname_on_card: SusanSmith
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncancelled: true
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\ncard_type: Credit
\ncollected: 2020-01-27
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\non_hot_list: false
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nGet all Entitlement Requests
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nThis endpoint starts the process of creating a Consent.
\nThe Consent is created in an INITIATED state.
\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
When the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.
\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
Authentication is Mandatory
\nExample 1:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
Please note that consumer_id is optional field
\nExample 2:
\n{
\n"everything": true,
\n"views": [],
\n"entitlements": [],
\n"email": "eveline@example.com"
\n}
Please note if everything=false you need to explicitly specify views and entitlements
\nExample 3:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com"
\n}
URL Parameters:
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalid_from: 2020-01-27
\nview_id: owner
\nJSON response body fields:
\n","description_markdown":"This endpoint starts the process of creating a Consent.\n\nThe Consent is created in an INITIATED state.\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\" or \"EMAIL\". \"EMAIL\" is used for testing purposes.\n\nWhen the Consent is created, OBP (or a backend system) stores the challenge so it can be checked later against the value supplied by the User with the Answer Consent Challenge endpoint.\n\n\n\nAn OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\nAuthentication is Mandatory\n\nExample 1: \n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\nPlease note that consumer_id is optional field\nExample 2:\n{\n \"everything\": true,\n \"views\": [],\n \"entitlements\": [],\n \"email\": \"eveline@example.com\"\n}\n\nPlease note if everything=false you need to explicitly specify views and entitlements\nExample 3:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\"\n}\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [account_id](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [consumer_id](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n* [valid_from](/glossary#valid_from): 2020-01-27\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":{"everything":false,"views":[{"bank_id":"gh.29.uk","account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],"consumer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh","phone_number":"+44 07972 444 876","valid_from":"2024-03-07T13:59:21Z","time_to_live":3600},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-35009: Only SMS and EMAIL are supported as SCA methods. ","OBP-35013: Consents can only contain Roles that you already have access to.","OBP-35014: Consents can only contain Views that you already have access to.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20058: Consumer is disabled.","OBP-00010: Missing props value at this API instance - ","OBP-35010: SMS server is not working or SMS server can not send the message to the phone number: ","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"entitlements":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}}},"phone_number":{"type":"string"},"everything":{"type":"boolean"},"valid_from":{"type":"string","format":"date-time"},"views":{"type":"array","items":{"type":"object","properties":{"bank_id":{"type":"string"},"view_id":{"type":"string"},"account_id":{"type":"string"}}}},"consumer_id":{"type":"string"},"time_to_live":{"type":"integer"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/SMS","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-bankById","implemented_by":{"version":"OBPv3.0.0","function":"bankById"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID","summary":"Get Bank","description":"Get the bank specified by BANK_ID
\nReturns information about a single bank specified by BANK_ID including:
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Get the bank specified by BANK_ID\nReturns information about a single bank specified by BANK_ID including:\n\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routings":[{"scheme":"Bank_ID","address":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error.","OBP-30001: Bank not found. Please specify a valid value for BANK_ID."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"bank_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID","connector_methods":["obp.getBank"]},{"operation_id":"OBPv3.1.0-revokeConsent","implemented_by":{"version":"OBPv3.1.0","function":"revokeConsent"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/CONSENT_ID/revoke","summary":"Revoke Consent","description":"An OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
Revoke Consent for current user specified by CONSENT_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"An OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\n\nRevoke Consent for current user specified by CONSENT_ID\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"REJECTED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"status":{"type":"string"},"consent_id":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/my/consents/CONSENT_ID/revoke","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateAccountApplicationStatus","implemented_by":{"version":"OBPv3.1.0","function":"updateAccountApplicationStatus"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications/ACCOUNT_APPLICATION_ID","summary":"Update Account Application Status","description":"Update an Account Application status
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet public accounts at all banks (Anonymous access).
\nReturns accounts that contain at least one public view (a view where is_public is true)
\nFor each account the API returns the ID and the available views.
Authentication is Optional
\nJSON response body fields:
\n\n","description_markdown":"Get public accounts at all banks (Anonymous access).\nReturns accounts that contain at least one public view (a view where is_public is true)\nFor each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30066: Could not get accounts.","OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/accounts/public","connector_methods":[]},{"operation_id":"OBPv3.0.0-getPublicAccountById","implemented_by":{"version":"OBPv3.0.0","function":"getPublicAccountById"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/public/accounts/ACCOUNT_ID/VIEW_ID/account","summary":"Get Public Account by Id","description":"Returns information about an account that has a public view.
\nThe account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nvalue: 5987953
\nUpdates the description of the transaction TRANSACTION_ID.
\nAuthentication via OAuth is required if the view is not public.
\nAuthentication 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:
\n","description_markdown":"Updates the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-addSocialMediaHandle","implemented_by":{"version":"OBPv2.0.0","function":"addSocialMediaHandle"},"request_verb":"POST","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Add Social Media Handle","description":"Add a social media handle for the customer specified by CUSTOMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Add a social media handle for the customer specified by CUSTOMER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [customer_number](/glossary#): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"customer_number":"5987953","type":"PlaceholderString","handle":"PlaceholderString","date_added":"2017-09-19T00:00:00Z","date_activated":"2017-09-19T00:00:00Z"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.","OBP-20006: User is missing one or more roles: ","OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.","OBP-50000: Unknown Error."],"tags":["Customer"],"typed_request_body":{"type":"object","properties":{"type":{"type":"string"},"customer_number":{"type":"string"},"date_activated":{"type":"string","format":"date-time"},"handle":{"type":"string"},"date_added":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"roles":[{"role":"CanAddSocialMediaHandle","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","connector_methods":["obp.getBankLegacy"]},{"operation_id":"OBPv3.1.0-enableDisableAccountWebhook","implemented_by":{"version":"OBPv3.1.0","function":"enableDisableAccountWebhook"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/account-web-hooks","summary":"Enable/Disable an Account Webhook","description":"Enable/Disable an Account Webhook
\nWebhooks are used to call external URLs when certain events happen.
\nAccount Webhooks focus on events around accounts.
\nFor instance, a webhook could be used to notify an external service if a balance changes on an account.
\nThis functionality is work in progress! Please note that only implemented trigger is: OnBalanceChange
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nbank_id: gh.29.uk
\nGrants the user identified by PROVIDER_ID at their provider PROVIDER access to a list of views at BANK_ID for account ACCOUNT_ID.
\nAll url parameters must be %-encoded, which is often especially relevant for PROVIDER_ID and PROVIDER.
\nAuthentication is Mandatory
\nThe User needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createProductAttribute","implemented_by":{"version":"OBPv3.1.0","function":"createProductAttribute"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute","summary":"Create Product Attribute","description":"Create Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nTypical product attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\nGet Calls limits per Consumer.
\nAuthentication is Mandatory
URL Parameters:
\nJSON response body fields:
\n","description_markdown":"Get Calls limits per Consumer.\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"per_second_call_limit":"-1","per_minute_call_limit":"-1","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1","current_state":{"per_second":{"calls_made":-1,"reset_in_seconds":-1},"per_minute":{"calls_made":-1,"reset_in_seconds":-1},"per_hour":{"calls_made":-1,"reset_in_seconds":-1},"per_day":{"calls_made":-1,"reset_in_seconds":-1},"per_week":{"calls_made":-1,"reset_in_seconds":-1},"per_month":{"calls_made":-1,"reset_in_seconds":-1}}},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30023: Cannot update Consumer ","OBP-50000: Unknown Error."],"tags":["Consumer","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"current_state":{"type":"object","properties":{"per_week":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_day":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_minute":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_month":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_second":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}},"per_hour":{"type":"object","properties":{"reset_in_seconds":{"type":"integer"},"calls_made":{"type":"integer"}}}}},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}},"roles":[{"role":"CanSetCallLimits","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/consumers/CONSUMER_ID/consumer/call-limits","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.2.0-createBank","implemented_by":{"version":"OBPv2.2.0","function":"createBank"},"request_verb":"POST","request_url":"/obp/v2.2.0/banks","summary":"Create Bank","description":"Create a new bank (Authenticated access).
\nAuthentication is Mandatory
JSON request body fields:
\nlogo_url: logo_url
\nwebsite_url: website_url
\nJSON response body fields:
\nlogo_url: logo_url
\nwebsite_url: website_url
\nUpdate an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ninsert_date: 2020-01-27
\nSet the API call limits for a Consumer:
\nPer Second
\nPer Minute
\nPer Hour
\nPer Week
\nPer Month
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Set the API call limits for a Consumer:\n\nPer Second\nPer Minute\nPer Hour\nPer Week\nPer Month\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"from_date":"2017-09-19T00:00:00Z","to_date":"2017-09-19T00:00:00Z","per_second_call_limit":"-1","per_minute_call_limit":"-1","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1"},"success_response_body":{"from_date":"2017-09-19T00:00:00Z","to_date":"2017-09-19T00:00:00Z","per_second_call_limit":"-1","per_minute_call_limit":"-1","per_hour_call_limit":"-1","per_day_call_limit":"-1","per_week_call_limit":"-1","per_month_call_limit":"-1"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-20014: Invalid Consumer ID. Please specify a valid value for CONSUMER_ID.","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-20006: User is missing one or more roles: ","OBP-30023: Cannot update Consumer ","OBP-50000: Unknown Error."],"tags":["Consumer","New-Style"],"typed_request_body":{"type":"object","properties":{"from_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"to_date":{"type":"string","format":"date-time"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"from_date":{"type":"string","format":"date-time"},"per_week_call_limit":{"type":"string"},"per_day_call_limit":{"type":"string"},"per_second_call_limit":{"type":"string"},"per_month_call_limit":{"type":"string"},"to_date":{"type":"string","format":"date-time"},"per_hour_call_limit":{"type":"string"},"per_minute_call_limit":{"type":"string"}}},"roles":[{"role":"CanSetCallLimits","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/consumers/CONSUMER_ID/consumer/call-limits","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-privateAccountsAtOneBank","implemented_by":{"version":"OBPv3.0.0","function":"privateAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts/private","summary":"Get Accounts at Bank (Minimal)","description":"Returns the minimal list of private accounts at BANK_ID that the user has access to.
\nFor each account, the API returns the ID, routing addresses and the views available to the current user.
If you want to see more information on the Views, use the Account Detail call.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts/private?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\naccount_type: AC
\nbank_id: gh.29.uk
\nlabel: My Account
\nInformation returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
\nMore details about the data moderation by the view here.
\nPSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
\nThis call provides balance and other account information via delegated authentication using OAuth.
Authentication is required if the 'is_public' field in view (VIEW_ID) is not set to true
.
Authentication is Optional
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncurrency: EUR
\nlabel: My Account
\nvalue: 5987953
\nGet the all metrics
\nrequire CanGetConnectorMetrics role
\nFilters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics
\nShould be able to filter on the following metrics fields
\neg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2
\n1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z
\n2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z
\n3 limit (for pagination: defaults to 1000) eg:limit=2000
\n4 offset (for pagination: zero index, defaults to 0) eg: offset=10
\neg: /management/connector/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=100&offset=300
\nOther filters:
\n5 connector_name (if null ignore)
\n6 function_name (if null ignore)
\n7 correlation_id (if null ignore)
\nAuthentication is Mandatory
\nJSON response body fields:
\ncorrelation_id: 1flssoftxq0cr1nssr68u0mioj
\ndate: 2020-01-27
\nSpecial instructions for COUNTERPARTY:
\nWhen using a COUNTERPARTY to create a Transaction Request, specificy the counterparty_id in the body of the request.
\nThe routing details of the counterparty will be forwarded for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"AED":0.1688,
\n"INR":3.3513,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":0.192964,
\n"INR":18.3255,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"JPY":113.161,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\namount: 10.12
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\nvalue: 5987953
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\niban: DE91 1000 0000 0123 4567 89
\nlegal_name: Eveline Tripman
\nstart_date: 2020-01-27
\nvalue: 5987953
\nDelete a WebUiProps specified by WEB_UI_PROPS_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete a WebUiProps specified by WEB_UI_PROPS_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\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-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["WebUi-Props","API","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteWebUiProps","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/webui_props/WEB_UI_PROPS_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-dataWarehouseStatistics","implemented_by":{"version":"OBPv3.0.0","function":"dataWarehouseStatistics"},"request_verb":"POST","request_url":"/obp/v3.0.0/search/warehouse/statistics/INDEX/FIELD","summary":"Data Warehouse Statistics","description":"Search the data warehouse and get statistical aggregations over a warehouse field
\nDoes a stats aggregation over some numeric field:
\n\nAuthentication is Mandatory
\nCanSearchWarehouseStats Role is required. You can request this below.
\nElastic (search) is used in the background. See links below for syntax.
\nExamples of usage:
\nPOST /search/warehouse/statistics/INDEX/FIELD
\nPOST /search/warehouse/statistics/ALL/FIELD
\n{ Any valid elasticsearch query DSL in the body }
\n\n\n\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Search the data warehouse and get statistical aggregations over a warehouse field\n\nDoes a stats aggregation over some numeric field:\n\nhttps://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html\n\nAuthentication is Mandatory\n\nCanSearchWarehouseStats Role is required. You can request this below.\n\nElastic (search) is used in the background. See links below for syntax.\n\nExamples of usage:\n\nPOST /search/warehouse/statistics/INDEX/FIELD\n\nPOST /search/warehouse/statistics/ALL/FIELD\n\n{ Any valid elasticsearch query DSL in the body }\n\n\n[Elasticsearch query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n\n[Elastic simple query](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-body.html)\n\n[Elastic aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-aggregations.html)\n\n\n**URL Parameters:**\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"query":{"match_all":{}}},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Data-Warehouse","New-Style"],"typed_request_body":{"type":"object","properties":{"query":{"type":"object","properties":{"match_all":{"type":"object","properties":{}}}}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanSearchWarehouseStatistics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/search/warehouse/statistics/INDEX/FIELD","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-createAtm","implemented_by":{"version":"OBPv3.0.0","function":"createAtm"},"request_verb":"POST","request_url":"/obp/v3.0.0/banks/BANK_ID/atms","summary":"Create ATM","description":"Create ATM for the Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nbank_id: gh.29.uk
\nhas_deposit_capability: true
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nJSON response body fields:
\nbank_id: gh.29.uk
\nhas_deposit_capability: true
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nDelete 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/v3.1.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-removePermissionForUserForBankAccountForOneView","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForOneView"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","summary":"Revoke access to one View","description":"Revokes access to a View on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Revokes access to a View on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [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. ","could not save the privilege","user does not have access to owner view on account","OBP-50000: Unknown Error."],"tags":["View-(Custom)","Account","User","Entitlement","OwnerViewRequired"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views/VIEW_ID","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-addKycMedia","implemented_by":{"version":"OBPv2.0.0","function":"addKycMedia"},"request_verb":"PUT","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/kyc_media/KYC_MEDIA_ID","summary":"Add KYC Media","description":"Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nCreates a "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\n\nJSON response body fields:
\n","description_markdown":"Creates a \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [latitude](/glossary#latitude): 38.8951\n\n\n\n* [longitude](/glossary#longitude): -77.0364\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission: ","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"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/v3.1.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-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/v3.1.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":"OBPv3.1.0-deleteSystemView","implemented_by":{"version":"OBPv3.1.0","function":"deleteSystemView"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/system-views/VIEW_ID","summary":"Delete System View","description":"Deletes the system view specified by VIEW_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Deletes the system view specified by VIEW_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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-50000: Unknown Error.","user does not have owner access","OBP-20006: User is missing one or more roles: "],"tags":["View-(System)","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanCreateSystemView","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/system-views/VIEW_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.1.0-createTransactionRequestSandboxTan","implemented_by":{"version":"OBPv2.1.0","function":"createTransactionRequestSandboxTan"},"request_verb":"POST","request_url":"/obp/v2.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transaction-request-types/SANDBOX_TAN/transaction-requests","summary":"Create Transaction Request (SANDBOX_TAN)","description":"When using SANDBOX_TAN, the payee is set in the request body.
\nMoney goes into the BANK_ID and ACCOUNT_ID specified in the request body.
\nInitiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"AED":0.1688,
\n"INR":3.3513,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":0.192964,
\n"INR":18.3255,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"JPY":113.161,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\nvalue: 5987953
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\niban: DE91 1000 0000 0123 4567 89
\nlegal_name: Eveline Tripman
\nstart_date: 2020-01-27
\nvalue: 5987953
\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.
\nThe actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nwhen: 2020-01-27
\nReturns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_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
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndate: 2020-01-27
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nAdd a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nsatisfied: true
\nGet metrics about the top consumers of the API usage e.g. total count, consumer_id and app_name.
\nShould be able to filter on the following fields
\ne.g.: /management/metrics/top-consumers?from_date=2023-03-07T13:59:25.537Z&to_date=2024-03-07T13:59:25.537Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n&limit=100
1 from_date (defaults to the one year ago): eg:from_date=2023-03-07T13:59:25.537Z
\n2 to_date (defaults to the current date) eg:to_date=2024-03-07T13:59:25.537Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\n16 limit (for pagination: defaults to 50) eg:limit=200
\nAuthentication is Mandatory
\nJSON response body fields:
\nDeletes the where tag of the transaction TRANSACTION_ID made on view.
\nAuthentication is Mandatory
\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the where tag of the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe user must either have owner privileges for this account, or must be the user that posted the geo tag.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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: ","OBP-20001: User not logged in. Authentication is required!","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","there is no tag to delete","Delete not completed","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateCustomerIdentity","implemented_by":{"version":"OBPv3.1.0","function":"updateCustomerIdentity"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/identity","summary":"Update the identity data of a Customer","description":"Update the identity data of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nInformation returned about the account specified by ACCOUNT_ID:
\nThis call returns the owner view and requires access to that view.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\namount: 10.12
\nbalance: 10
\nbank_id: gh.29.uk
\ncurrency: EUR
\nlabel: My Account
\nCreate Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.
\nThe User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.
\nIf the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.
\nIf the PUT body USER_ID is not specified, the account will be owned by the logged in User.
\nThe 'product_code' field SHOULD be a product_code from Product.
\nIf the 'product_code' matches a product_code from Product, account attributes will be created that match the Product Attributes.
Note: The Amount MUST be zero.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbalance: 10
\nbranch_id: DERBY6
\ncurrency: EUR
\nlabel: My Account
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nvalue: 5987953
\nPosts an image about a transaction TRANSACTION_ID on a view VIEW_ID.
\nAuthentication is Mandatory
\nThe image is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nlabel: My Account
\nJSON response body fields:
\n\n","description_markdown":"Posts an image about a transaction TRANSACTION_ID on a [view](#1_2_1-getViewsForBankAccount) VIEW_ID.\n\nAuthentication is Mandatory\n\nThe image is linked with the user.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [URL](/glossary#Customer.url): http://www.example.com/id-docs/123/image.png\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\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* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"label":"String","URL":"String"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","date":"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-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-10017: Incorrect URL Format. ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"URL":{"type":"string"},"label":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getAggregateMetrics","implemented_by":{"version":"OBPv3.0.0","function":"getAggregateMetrics"},"request_verb":"GET","request_url":"/obp/v3.0.0/management/aggregate-metrics","summary":"Get Aggregate Metrics","description":"Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.
\nShould be able to filter on the following fields
\neg: /management/aggregate-metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the day before the current date): eg:from_date=2017-09-19T02:31:05.000Z
\n2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.000Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Returns aggregate metrics on api usage eg. total count, response time (in ms), etc.\n\nShould be able to filter on the following fields\n\neg: /management/aggregate-metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&consumer_id=5\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions\n&verb=GET&anon=false&app_name=MapperPostman\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n1 from_date (defaults to the day before the current date): eg:from_date=2017-09-19T02:31:05.000Z\n\n2 to_date (defaults to the current date) eg:to_date=2017-09-19T02:31:05.000Z\n\n3 consumer_id (if null ignore)\n\n4 user_id (if null ignore)\n\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n6 url (if null ignore), note: can not contain '&'.\n\n7 app_name (if null ignore)\n\n8 implemented_by_partial_function (if null ignore),\n\n9 implemented_in_version (if null ignore)\n\n10 verb (if null ignore)\n\n11 correlation_id (if null ignore)\n\n12 duration (if null ignore) non digit chars will be silently omitted\n\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%\n\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"count":7076,"average_response_time":65.21,"minimum_response_time":1.0,"maximum_response_time":9039.0},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Metric","Aggregate-Metrics","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"count":{"type":"integer"},"average_response_time":{"type":"number"},"maximum_response_time":{"type":"number"},"minimum_response_time":{"type":"number"}}},"roles":[{"role":"CanReadAggregateMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/aggregate-metrics","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getUser","implemented_by":{"version":"OBPv3.0.0","function":"getUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/email/EMAIL/terminator","summary":"Get Users by Email Address","description":"Get users by email address
\nAuthentication is Mandatory
\nCanGetAnyUser entitlement is required,
URL Parameters:
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet the KYC statuses for a customer specified by CUSTOMER_ID over time.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nok: true
\nReturns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n\n","description_markdown":"Returns the transaction TRANSACTION_ID images made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [URL](/glossary#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* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"images":[{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","label":"NONE","URL":"www.openbankproject.com","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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"images":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"URL":{"type":"string"},"id":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}},"label":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.4.0-getResourceDocsObp","implemented_by":{"version":"OBPv1.4.0","function":"getResourceDocsObp"},"request_verb":"GET","request_url":"/obp/v1.4.0/resource-docs/API_VERSION/obp","summary":"Get Resource Docs","description":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.
\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.
\nThis endpoint is used by OBP API Explorer to display and work with the API documentation.
\nMost (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)
\nAPI_VERSION is the version you want documentation about e.g. v3.0.0
\nYou may filter this endpoint with tags parameter e.g. ?tags=Account,Bank
\nYou may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics
\nFor possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.
\nYou may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
\nif set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en and zh , e.g. ?language=zh
\nSee the Resource Doc endpoint for more information.
\nFollowing are more examples:
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh
\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
Authentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests.\n\nThis is the native data format used to document OBP endpoints. Each endpoint has a Resource Doc (a Scala case class) defined in the source code.\n\n This endpoint is used by OBP API Explorer to display and work with the API documentation.\n\n Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.)\n\n API_VERSION is the version you want documentation about e.g. v3.0.0\n\n You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank\n\n You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics\n\n For possible function values, see implemented_by.function in the JSON returned by this endpoint or the OBP source code or the footer of the API Explorer which produces a comma separated list of functions that reflect the server or filtering by API Explorer based on tags etc.\n\n You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic \n if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.\n \n You may need some other language resource docs, now we support en and zh , e.g. ?language=zh\n\nSee the Resource Doc endpoint for more information.\n\nFollowing are more examples:\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?tags=Account,Bank\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v3.1.0/obp?functions=getBanks,bankById\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?language=zh\nhttps://api.ttk.com.mk/obp/v3.1.0/resource-docs/v4.0.0/obp?content=static,dynamic,all\n\nUpdate Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nUpdate 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/v3.1.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":"OBPv3.1.0-deleteMethodRouting","implemented_by":{"version":"OBPv3.1.0","function":"deleteMethodRouting"},"request_verb":"DELETE","request_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","summary":"Delete MethodRouting","description":"Delete a MethodRouting specified by METHOD_ROUTING_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete a MethodRouting specified by METHOD_ROUTING_ID.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error."],"tags":["Method-Routing","API","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteMethodRouting","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/method_routings/METHOD_ROUTING_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createSystemView","implemented_by":{"version":"OBPv3.1.0","function":"createSystemView"},"request_verb":"POST","request_url":"/obp/v3.1.0/system-views","summary":"Create System View","description":"Create a system view
\nAuthentication is Mandatory and the user needs to have access to the CanCreateSystemView entitlement.
\nThe 'alias' field in the JSON can take one of two values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
Please note that system views cannot be public. In case you try to set it you will get the error OBP-30258: System view cannot be public
\nJSON request body fields:
\nJSON response body fields:
\nUpdate the credit limit of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nUpdate the Branch of the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nAdd 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/v3.1.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.3.0-getCards","implemented_by":{"version":"OBPv1.3.0","function":"getCards"},"request_verb":"GET","request_url":"/obp/v1.3.0/cards","summary":"Get cards for the current user","description":"Returns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc.
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_card_number: 364435172576215
\nbank_id: gh.29.uk
\ncan_see_images: true
\ncancelled: true
\ncollected: 2020-01-27
\nenabled: true
\nexpires_date: 2021-01-27
\nissue_number: 1
\nlabel: My Account
\nname_on_card: SusanSmith
\non_hot_list: false
\nposted: 2020-01-27
\nrequested_date: 2020-01-27
\nserial_number: 1324234
\nvalid_from_date: 2020-01-27
\nCreate a WebUiProps.
\nAuthentication is Mandatory
\nExplaination of Fields:
\nThe line break and double quotations should do escape, example:
\n\n{"name": "webui_some", "value": "this value\nhave "line break" and double quotations."}\n\n
\nshould do escape like this:
\n\n{"name": "webui_some", "value": "this value\\nhave \\"line break\\" and double quotations."}\n\n
\nInsert image examples:
\n// set width=100 and height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="100" height="50" />"}\n\n// only set height=50\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="" height="50" />"}\n\n// only width=20%\n{"name": "webui_some_pic", "value": "here is a picture <img alt="hello" src="http://somedomain.com/images/pic.png" width="20%" height="" />"}\n\n
\nJSON request body fields:
\nJSON response body fields:
\nDeletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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. ","OBP-30022: The current view does not have the permission: ","OBP-20001: User not logged in. Authentication is required!","You must be able to see images in order to delete them","Image not found for this transaction","Deleting images not permitted for this view","Deleting images not permitted for the current user","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/images/IMAGE_ID","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-publicAccountsAtOneBank","implemented_by":{"version":"OBPv2.0.0","function":"publicAccountsAtOneBank"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/accounts/public","summary":"Get Public Accounts at Bank","description":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Account-Public","Account","PublicData","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/public","connector_methods":["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/v3.1.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-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/v3.1.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":"OBPv3.0.0-getEntitlementsForCurrentUser","implemented_by":{"version":"OBPv3.0.0","function":"getEntitlementsForCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.0.0/my/entitlements","summary":"Get Entitlements for the current User","description":"Get Entitlements for the current User.
\nAuthentication is Mandatory
\nJSON response body fields:
\nGet Entitlement Requests for the current User.
\nAuthentication is Mandatory
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nDelete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/comments/COMMENT_ID","connector_methods":["obp.checkBankAccountExists","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/v3.1.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":"OBPv3.1.0-checkFundsAvailable","implemented_by":{"version":"OBPv3.1.0","function":"checkFundsAvailable"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/funds-available","summary":"Check Available Funds","description":"Check Available Funds
\nMandatory URL parameters:
Authentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\nReturns all available roles
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Returns all available roles\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"roles":[{"role":"CanCreateBranch","requires_bank_id":true}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Role","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"requires_bank_id":{"type":"boolean"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/roles","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getUserByUsername","implemented_by":{"version":"OBPv3.0.0","function":"getUserByUsername"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/username/USERNAME","summary":"Get User by USERNAME","description":"Get user by USERNAME
\nAuthentication is Mandatory
\nCanGetAnyUser entitlement is required,
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet the list of the Transaction Request Types supported by the bank.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nGet information about the Rate Limiting setup on this OBP Instance such as:
\nIs rate limiting enabled and active?
\nWhat backend is used to keep track of the API calls (e.g. REDIS).
Authentication is Mandatory
\nJSON response body fields:
\nDeletes 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/v3.1.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":"OBPv2.0.0-getKycChecks","implemented_by":{"version":"OBPv2.0.0","function":"getKycChecks"},"request_verb":"GET","request_url":"/obp/v2.0.0/customers/CUSTOMER_ID/kyc_checks","summary":"Get Customer KYC Checks","description":"Get KYC checks for the Customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\nsatisfied: true
\nDeletes the description of the transaction TRANSACTION_ID.
\nAuthentication 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
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Deletes the description of the transaction TRANSACTION_ID.\n\nAuthentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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: ","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-createBranch","implemented_by":{"version":"OBPv3.0.0","function":"createBranch"},"request_verb":"POST","request_url":"/obp/v3.0.0/banks/BANK_ID/branches","summary":"Create Branch","description":"Create Branch for the Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nJSON response body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nUpdate Card Attribute
\nCard Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Card Attribute is linked to its Card by CARD_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCARD_ATTRIBUTE_ID: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nCARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nJSON response body fields:
\nattribute_type: STRING
\nbank_id: gh.29.uk
\ncard_attribute_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\ncard_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e
\nvalue: 5987953
\nGet metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.
\nShould be able to filter on the following fields
\neg: /management/metrics/top-apis?from_date=2023-03-07T13:59:25.536Z&to_date=2024-03-07T13:59:25.536Z&consumer_id=5
\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount
\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions
\n&verb=GET&anon=false&app_name=MapperPostman
\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
1 from_date (defaults to the one year ago): eg:from_date=2023-03-07T13:59:25.536Z
\n2 to_date (defaults to the current date) eg:to_date=2024-03-07T13:59:25.536Z
\n3 consumer_id (if null ignore)
\n4 user_id (if null ignore)
\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)
\n6 url (if null ignore), note: can not contain '&'.
\n7 app_name (if null ignore)
\n8 implemented_by_partial_function (if null ignore),
\n9 implemented_in_version (if null ignore)
\n10 verb (if null ignore)
\n11 correlation_id (if null ignore)
\n12 duration (if null ignore) non digit chars will be silently omitted
\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null
\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%
\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics
\nAuthentication is Mandatory
\nJSON response body fields:
\n","description_markdown":"Get metrics about the most popular APIs. e.g.: total count, response time (in ms), etc.\n\nShould be able to filter on the following fields\n\neg: /management/metrics/top-apis?from_date=2023-03-07T13:59:25.536Z&to_date=2024-03-07T13:59:25.536Z&consumer_id=5\n&user_id=66214b8e-259e-44ad-8868-3eb47be70646&implemented_by_partial_function=getTransactionsForBankAccount\n&implemented_in_version=v3.0.0&url=/obp/v3.0.0/banks/gh.29.uk/accounts/8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0/owner/transactions\n&verb=GET&anon=false&app_name=MapperPostman\n&exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n1 from_date (defaults to the one year ago): eg:from_date=2023-03-07T13:59:25.536Z\n\n2 to_date (defaults to the current date) eg:to_date=2024-03-07T13:59:25.536Z\n\n3 consumer_id (if null ignore)\n\n4 user_id (if null ignore)\n\n5 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.)\n\n6 url (if null ignore), note: can not contain '&'.\n\n7 app_name (if null ignore)\n\n8 implemented_by_partial_function (if null ignore),\n\n9 implemented_in_version (if null ignore)\n\n10 verb (if null ignore)\n\n11 correlation_id (if null ignore)\n\n12 duration (if null ignore) non digit chars will be silently omitted\n\n13 exclude_app_names (if null ignore).eg: &exclude_app_names=API-EXPLORER,API-Manager,SOFI,null\n\n14 exclude_url_patterns (if null ignore).you can design you own SQL NOT LIKE pattern. eg: &exclude_url_patterns=%management/metrics%,%management/aggregate-metrics%\n\n15 exclude_implemented_by_partial_functions (if null ignore).eg: &exclude_implemented_by_partial_functions=getMetrics,getConnectorMetrics,getAggregateMetrics\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"top_apis":[{"count":7076,"Implemented_by_partial_function":"getBanks","implemented_in_version":"v1.2.1"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-10016: Incorrect filter Parameters in URL. ","OBP-30042: Could not get the top apis from database. ","OBP-50000: Unknown Error."],"tags":["Metric","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"top_apis":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer"},"Implemented_by_partial_function":{"type":"string"},"implemented_in_version":{"type":"string"}}}}}},"roles":[{"role":"CanReadMetrics","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/management/metrics/top-apis","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getBanks","implemented_by":{"version":"OBPv3.0.0","function":"getBanks"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks","summary":"Get Banks","description":"Get banks on this API instance
\nReturns a list of banks supported on this server:
Authentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get banks on this API instance\nReturns a list of banks supported on this server:\n\n* ID used as parameter in URLs\n* Short and full name of bank\n* Logo URL\n* Website\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"banks":[{"id":"gh.29.uk","short_name":"short_name ","full_name":"full_name","logo":"logo","website":"www.openbankproject.com","bank_routing":{"scheme":"Bank_ID","address":"gh.29.uk"}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Bank","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"banks":{"type":"array","items":{"type":"object","properties":{"website":{"type":"string"},"logo":{"type":"string"},"short_name":{"type":"string"},"id":{"type":"string"},"full_name":{"type":"string"},"bank_routing":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks","connector_methods":["obp.getBanks","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.4.0-getCustomerMessages","implemented_by":{"version":"OBPv1.4.0","function":"getCustomerMessages"},"request_verb":"GET","request_url":"/obp/v1.4.0/banks/BANK_ID/customer/messages","summary":"Get Customer Messages (current)","description":"Get messages for the logged in customer
\nMessages sent to the currently authenticated user.
Authentication via OAuth is required.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nDelete Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nDelete a Product Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete Product Attribute\n\n\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.\n\nEach Product Attribute is linked to its Product by PRODUCT_CODE\n\n\n \n\nDelete a Product Attribute by its id.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Product","New-Style"],"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/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","connector_methods":["obp.deleteProductAttribute","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createCreditLimitRequest","implemented_by":{"version":"OBPv3.1.0","function":"createCreditLimitRequest"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests","summary":"Create Credit Limit Order Request","description":"NOTE: This endpoint currently only returns example data.
\nCreate credit limit order request
\nAuthentication is Optional
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"**NOTE: This endpoint currently only returns example data.**\n\n \nCreate credit limit order request\n\n\nAuthentication is Optional\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [CUSTOMER_ID](/glossary#Customer.customer_id): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"requested_current_rate_amount1":"String","requested_current_rate_amount2":"String","requested_current_valid_end_date":"String","current_credit_documentation":"String","temporary_requested_current_amount":"String","requested_temporary_valid_end_date":"String","temporary_credit_documentation":"String"},"success_response_body":{"execution_time":"String","execution_date":"String","token":"String","short_reference":"String"},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Customer","New-Style"],"typed_request_body":{"type":"object","properties":{"requested_temporary_valid_end_date":{"type":"string","format":"date-time"},"current_credit_documentation":{"type":"string"},"temporary_requested_current_amount":{"type":"string"},"requested_current_valid_end_date":{"type":"string","format":"date-time"},"requested_current_rate_amount1":{"type":"string"},"requested_current_rate_amount2":{"type":"string"},"temporary_credit_documentation":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"token":{"type":"string"},"short_reference":{"type":"string"},"execution_time":{"type":"string"},"execution_date":{"type":"string","format":"date-time"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/customers/CUSTOMER_ID/credit_limit/requests","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-deleteTagForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"deleteTagForViewOnTransaction"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","summary":"Delete a tag","description":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
\nAuthentication via OAuth is required. The user must either have owner privileges for this account,
\nor must be the user that posted the tag.
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:
\n","description_markdown":"Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on [view](#1_2_1-getViewsForBankAccount).\nAuthentication via OAuth is required. The user must either have owner privileges for this account, \nor must be the user that posted the tag.\n\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags/TAG_ID","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getEntitlementRequests","implemented_by":{"version":"OBPv3.0.0","function":"getEntitlementRequests"},"request_verb":"GET","request_url":"/obp/v3.0.0/users/USER_ID/entitlement-requests","summary":"Get Entitlement Requests for a User","description":"Get Entitlement Requests for a User.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet the OAuth2 server's public JSON Web Key (JWK) URIs.
\nIt is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.
Authentication is Optional
\nJSON response body fields:
\n","description_markdown":"Get the OAuth2 server's public JSON Web Key (JWK) URIs.\n It is required by client applications to validate ID tokens, self-contained access tokens and other issued objects.\n\n \n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jwks_uris":[{"jwks_uri":"https://www.googleapis.com/oauth2/v3/certs"}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["API","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jwks_uris":{"type":"array","items":{"type":"object","properties":{"jwks_uri":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/jwks-uris","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-deleteEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"deleteEntitlement"},"request_verb":"DELETE","request_url":"/obp/v2.0.0/users/USER_ID/entitlement/ENTITLEMENT_ID","summary":"Delete Entitlement","description":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"jsonString":"{}"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Role","User","Entitlement","New-Style"],"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/v3.1.0/users/USER_ID/entitlement/ENTITLEMENT_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createUserAuthContext","implemented_by":{"version":"OBPv3.1.0","function":"createUserAuthContext"},"request_verb":"POST","request_url":"/obp/v3.1.0/users/USER_ID/auth-context","summary":"Create User Auth Context","description":"Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and
\nBank User/Customer.
\nAuthentication is Mandatory
URL Parameters:
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Create User Auth Context. These key value pairs will be propagated over connector to adapter. Normally used for mapping OBP user and \n Bank User/Customer. \nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [user_id](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"key":"CUSTOMER_NUMBER","value":"78987432"},"success_response_body":{"user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30053: Could not insert the UserAuthContext","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"roles":[{"role":"CanCreateUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/users/USER_ID/auth-context","connector_methods":["obp.createUserAuthContext","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-updateProductAttribute","implemented_by":{"version":"OBPv3.1.0","function":"updateProductAttribute"},"request_verb":"PUT","request_url":"/obp/v3.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID","summary":"Update Product Attribute","description":"Update Product Attribute.
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nUpdate one Product Attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nCreate Account Attribute
\nAccount Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Account Attribute is linked to its Account by ACCOUNT_ID
\nTypical account attributes might be:
\nISIN (for International bonds)
\nVKN (for German bonds)
\nREDCODE (markit short code for credit derivative)
\nLOAN_ID (e.g. used for Anacredit reporting)
ISSUE_DATE (When the bond was issued in the market)
\nMATURITY_DATE (End of life time of a product)
\nTRADABLE
See FPML for more examples.
\nThe type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\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/v3.1.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":"OBPv2.0.0-addEntitlement","implemented_by":{"version":"OBPv2.0.0","function":"addEntitlement"},"request_verb":"POST","request_url":"/obp/v2.0.0/users/USER_ID/entitlements","summary":"Add Entitlement for a User","description":"Create Entitlement. Grant Role to User.
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\nReturns a list of Customers at the Bank that are linked to the currently authenticated User.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nrelationship_status: single
\nGet the latest FX rate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE
\nOBP may try different sources of FX rate information depending on the Connector in operation.
\nFor example we want to convert EUR => USD:
\nOBP will:
\n1st try - Connector (database, core banking system or external FX service)
\n2nd try part 1 - fallbackexchangerates/eur.json
\n2nd try part 2 - fallbackexchangerates/usd.json (the inverse rate is used)
\n3rd try - Hardcoded map of FX rates.
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nconversion_value: 100
\neffective_date: 2020-01-27
\nCreates a description of the transaction TRANSACTION_ID.
\nNote: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
\nIf you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).
Authentication 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
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"Creates a description of the transaction TRANSACTION_ID.\n\nNote: Unlike other items of metadata, there is only one \"narrative\" per transaction accross all views.\nIf you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"narrative":"narative"},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-10001: Incorrect json format.","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"narrative":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/narrative","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv1.2.1-getTagsForViewOnTransaction","implemented_by":{"version":"OBPv1.2.1","function":"getTagsForViewOnTransaction"},"request_verb":"GET","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","summary":"Get tags","description":"Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
\nAuthentication via OAuth is required if the view is not public.
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:
\n\n","description_markdown":"Returns the transaction TRANSACTION_ID tags made on a [view](#1_2_1-getViewsForBankAccount) (VIEW_ID).\n Authentication via OAuth is required if the view is not public.\n\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* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [date](/glossary#effective_date): 2020-01-27\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"id":"5995d6a2-01b3-423c-a173-5481df49bdaf","value":"OBP","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-30022: The current view does not have the permission: ","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"id":{"type":"string"},"value":{"type":"string"},"user":{"type":"object","properties":{"provider":{"type":"string"},"display_name":{"type":"string"},"id":{"type":"string"}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/tags","connector_methods":["obp.checkBankAccountExists","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getConsents","implemented_by":{"version":"OBPv3.1.0","function":"getConsents"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/my/consents","summary":"Get Consents","description":"An OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
This endpoint gets the Consents that the current User created.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"An OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\n\n\nThis endpoint gets the Consents that the current User created.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"consents":[{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"consents":{"type":"array","items":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/my/consents","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createMeeting","implemented_by":{"version":"OBPv3.1.0","function":"createMeeting"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings","summary":"Create Meeting (video conference/call)","description":"Create Meeting: Initiate a video conference/call with the bank.
\nThe Meetings resource contains meta data about video/other conference sessions
\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
\nLogin is required.
\nThis call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\nwhen: 2020-01-27
\nDelete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n","description_markdown":"Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\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-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Role","Entitlement","User","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteEntitlementRequestsAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/entitlement-requests/ENTITLEMENT_REQUEST_ID","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createAccountApplication","implemented_by":{"version":"OBPv3.1.0","function":"createAccountApplication"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/account-applications","summary":"Create Account Application","description":"Create Account Application
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_application: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nReturns the list of accounts at BANK_ID that the user has access to.
\nFor each account the API returns the account ID and the views available to the user..
\nEach account must have at least one private View.
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Returns the list of accounts at BANK_ID that the user has access to.\nFor each account the API returns the account ID and the views available to the user..\nEach account must have at least one private View.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0","label":"NoneLabel","bank_id":"gh.29.uk","views_available":[{"id":"1","short_name":"HHH","is_public":true}]}]},"error_response_bodies":["OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["Account","PrivateData","PublicData","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"id":{"type":"string"},"bank_id":{"type":"string"},"views_available":{"type":"array","items":{"type":"object","properties":{"short_name":{"type":"string"},"id":{"type":"string"},"is_public":{"type":"boolean"}}}}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts","connector_methods":["obp.getBankAccounts","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createUserAuthContextUpdateRequest","implemented_by":{"version":"OBPv3.1.0","function":"createUserAuthContextUpdateRequest"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD","summary":"Create User Auth Context Update Request","description":"Create User Auth Context Update Request.
\nAuthentication is Mandatory
A One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD
\nSCA_METHOD is typically "SMS" or "EMAIL". "EMAIL" is used for testing purposes.
URL Parameters:
\nJSON request body fields:
\n\nJSON response body fields:
\n\n","description_markdown":"Create User Auth Context Update Request.\nAuthentication is Mandatory\n\nA One Time Password (OTP) (AKA security challenge) is sent Out of Band (OOB) to the User via the transport defined in SCA_METHOD\nSCA_METHOD is typically \"SMS\" or \"EMAIL\". \"EMAIL\" is used for testing purposes.\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [user_id](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"key":"CUSTOMER_NUMBER","value":"78987432"},"success_response_body":{"user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","status":"INITIATED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-10001: Incorrect json format.","OBP-30053: Could not insert the UserAuthContext","OBP-50000: Unknown Error."],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD","connector_methods":["obp.createUserAuthContextUpdate","obp.getCustomerByCustomerNumber","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-unlockUser","implemented_by":{"version":"OBPv3.1.0","function":"unlockUser"},"request_verb":"PUT","request_url":"/obp/v3.1.0/users/USERNAME/lock-status","summary":"Unlock the user","description":"Unlock a User.
\n(Perhaps the user was locked due to multiple failed login attempts)
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nUpdates the "where" Geo tag on a transaction TRANSACTION_ID in a view.
\nAuthentication is Mandatory
\nThe geo tag is linked with the user.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nTRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\nVIEW_ID: owner
\nJSON response body fields:
\n","description_markdown":"Updates the \"where\" Geo tag on a transaction TRANSACTION_ID in a [view](#1_2_1-getViewsForBankAccount).\n\nAuthentication is Mandatory\n\nThe geo tag is linked with the user.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [TRANSACTION_ID](/glossary#transaction_ids): 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub\n\n\n\n* [VIEW_ID](/glossary#this_view_id): owner\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"where":{"latitude":1.532,"longitude":1.535}},"success_response_body":{"success":"Success"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID. ","OBP-10001: Incorrect json format.","OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID","OBP-30022: The current view does not have the permission: ","Coordinates not possible","OBP-50000: Unknown Error."],"tags":["Transaction-Metadata","Transaction","New-Style"],"typed_request_body":{"type":"object","properties":{"where":{"type":"object","properties":{"longitude":{"type":"number"},"latitude":{"type":"number"}}}}},"typed_success_response_body":{"type":"object","properties":{"success":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions/TRANSACTION_ID/metadata/where","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/v3.1.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-removePermissionForUserForBankAccountForAllViews","implemented_by":{"version":"OBPv1.2.1","function":"removePermissionForUserForBankAccountForAllViews"},"request_verb":"DELETE","request_url":"/obp/v1.2.1/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","summary":"Revoke access to all Views on Account","description":""Revokes access to all Views on an Account for a certain User.
\nThe User is identified by PROVIDER_ID at their PROVIDER.
\nThe Account is specified by BANK_ID and ACCOUNT_ID.
\nThe View is specified by VIEW_ID.
\nPROVIDER (may be a URL so) must be URL Encoded.
\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.
\nAttempting to revoke access to a public view will return an error message.
\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\n","description_markdown":"\"Revokes access to all Views on an Account for a certain User.\n\n\nThe User is identified by PROVIDER_ID at their PROVIDER.\n\nThe Account is specified by BANK_ID and ACCOUNT_ID.\n\nThe View is specified by VIEW_ID.\n\n\nPROVIDER (may be a URL so) must be URL Encoded.\n\nPROVIDER_ID is normally equivalent to USERNAME. However, see Get User by ID or GET Current User for Provider information.\n\nAttempting to revoke access to a public view will return an error message.\n\nAn Account Owner cannot revoke access to an Owner View unless at least one other User has Owner View access.\n\n \n\nAuthentication is Mandatory and the user needs to have access to the owner view.\n\n\n**URL Parameters:**\n\n* [ACCOUNT_ID](/glossary#Account.account_id): 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\n\n\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n","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-50000: Unknown Error.","user does not have access to owner view on account"],"tags":["View-(Custom)","Account","User","OwnerViewRequired"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/permissions/PROVIDER/PROVIDER_ID/views","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getCheckbookOrders","implemented_by":{"version":"OBPv3.1.0","function":"getCheckbookOrders"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/checkbook/orders","summary":"Get Checkbook orders","description":"Get all checkbook orders
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\naccount_type: AC
\nbank_id: gh.29.uk
\norder_date: 2020-01-27
\nAdd 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/v3.1.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":"OBPv3.0.0-getBranch","implemented_by":{"version":"OBPv3.0.0","function":"getBranch"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/branches/BRANCH_ID","summary":"Get Branch","description":"Returns information about a single Branch specified by BANK_ID and BRANCH_ID including:
\nAuthentication is Optional
\nURL Parameters:
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\nis_accessible: true
\nlatitude: 38.8951
\nlongitude: -77.0364
\nSpecial instructions for SEPA:
\nWhen using a SEPA Transaction Request, you specify the IBAN of a Counterparty in the body of the request.
\nThe routing details (IBAN) of the counterparty will be forwarded to the core banking system for the transfer.
Initiate a Payment via creating a Transaction Request.
\nIn OBP, a transaction request
may or may not result in a transaction
. However, a transaction
only has one possible state: completed.
A Transaction Request
can have one of several states.
Transactions
are modeled on items in a bank statement that represent the movement of money.
Transaction Requests
are requests to move money which may or may not succeeed and thus result in a Transaction
.
A Transaction Request
might create a security challenge that needs to be answered before the Transaction Request
proceeds.
Transaction Requests contain charge information giving the client the opportunity to proceed or not (as long as the challenge level is appropriate).
\nTransaction Requests can have one of several Transaction Request Types which expect different bodies. The escaped body is returned in the details key of the GET response.
\nThis provides some commonality and one URL for many different payment or transfer types with enough flexibility to validate them differently.
The payer is set in the URL. Money comes out of the BANK_ID and ACCOUNT_ID specified in the URL.
\nIn sandbox mode, TRANSACTION_REQUEST_TYPE is commonly set to SANDBOX_TAN. See getTransactionRequestTypesSupportedByBank for all supported types.
\nIn sandbox mode, if the amount is less than 1000 EUR (any currency, unless it is set differently on this server), the transaction request will create a transaction without a challenge, else the Transaction Request will be set to INITIALISED and a challenge will need to be answered.
\nIf a challenge is created you must answer it using Answer Transaction Request Challenge before the Transaction is created.
\nYou can transfer between different currency accounts. (new in 2.0.0). The currency in body must match the sending account.
\nThe following static FX rates are available in sandbox mode:
\n{
\n"XAF":{
\n"HKD":0.0135503,
\n"AUD":0.00228226,
\n"KRW":1.87975,
\n"JOD":0.00127784,
\n"GBP":0.00131092,
\n"MXN":0.0396,
\n"AED":0.00601555,
\n"INR":0.110241,
\n"JPY":0.185328,
\n"USD":0.00163773,
\n"ILS":0.00641333,
\n"EUR":0.00152449
\n},
\n"HKD":{
\n"XAF":73.8049,
\n"AUD":0.178137,
\n"KRW":143.424,
\n"JOD":0.0903452,
\n"GBP":0.0985443,
\n"MXN":2.8067,
\n"AED":0.467977,
\n"INR":9.09325,
\n"JPY":14.0867,
\n"USD":0.127427,
\n"ILS":0.460862,
\n"EUR":0.112495
\n},
\n"AUD":{
\n"XAF":438.162,
\n"HKD":5.61346,
\n"KRW":895.304,
\n"JOD":0.556152,
\n"GBP":0.609788,
\n"MXN":16.0826,
\n"AED":2.88368,
\n"INR":50.4238,
\n"JPY":87.0936,
\n"USD":0.785256,
\n"ILS":2.83558,
\n"EUR":0.667969
\n},
\n"KRW":{
\n"XAF":0.531986,
\n"HKD":0.00697233,
\n"AUD":0.00111694,
\n"JOD":6.30634E-4,
\n"GBP":6.97389E-4,
\n"MXN":0.0183,
\n"AED":0.00320019,
\n"INR":0.0586469,
\n"JPY":0.0985917,
\n"USD":8.7125E-4,
\n"ILS":0.00316552,
\n"EUR":8.11008E-4
\n},
\n"JOD":{
\n"XAF":782.572,
\n"HKD":11.0687,
\n"AUD":1.63992,
\n"KRW":1585.68,
\n"GBP":1.06757,
\n"MXN":30.8336,
\n"AED":5.18231,
\n"INR":90.1236,
\n"JPY":156.304,
\n"USD":1.41112,
\n"ILS":5.02018,
\n"EUR":0.237707
\n},
\n"GBP":{
\n"XAF":762.826,
\n"HKD":10.1468,
\n"AUD":1.63992,
\n"KRW":1433.92,
\n"JOD":0.936707,
\n"MXN":29.242,
\n"AED":4.58882,
\n"INR":84.095,
\n"JPY":141.373,
\n"USD":1.2493,
\n"ILS":4.7002,
\n"EUR":1.16278
\n},
\n"MXN":{
\n"XAF":25.189,
\n"HKD":0.3562,
\n"AUD":0.0621,
\n"KRW":54.4512,
\n"JOD":0.0324,
\n"GBP":0.0341,
\n"AED":0.1688,
\n"INR":3.3513,
\n"JPY":4.8687,
\n"USD":0.0459,
\n"ILS":0.1541,
\n"EUR":0.0384
\n},
\n"AED":{
\n"XAF":166.236,
\n"HKD":2.13685,
\n"AUD":0.346779,
\n"KRW":312.482,
\n"GBP":0.217921,
\n"MXN":5.9217,
\n"AED":0.192964,
\n"INR":18.3255,
\n"JPY":30.8081,
\n"USD":0.27225,
\n"ILS":0.968033,
\n"EUR":0.253425
\n},
\n"INR":{
\n"XAF":9.07101,
\n"HKD":0.109972,
\n"AUD":0.0198319,
\n"KRW":17.0512,
\n"JOD":0.0110959,
\n"GBP":0.0118913,
\n"MXN":0.2983,
\n"AED":0.0545671,
\n"JPY":1.68111,
\n"USD":0.0148559,
\n"ILS":0.0556764,
\n"EUR":0.0138287
\n},
\n"JPY":{
\n"XAF":5.39585,
\n"HKD":0.0709891,
\n"AUD":0.0114819,
\n"KRW":10.1428,
\n"JOD":0.00639777,
\n"GBP":0.0070735,
\n"MXN":0.2053,
\n"AED":0.032459,
\n"INR":0.594846,
\n"USD":0.00883695,
\n"ILS":0.0320926,
\n"EUR":0.00822592
\n},
\n"USD":{
\n"XAF":610.601,
\n"HKD":7.84766,
\n"AUD":1.27347,
\n"KRW":1147.78,
\n"JOD":0.708659,
\n"GBP":0.800446,
\n"MXN":21.748,
\n"AED":3.6731,
\n"INR":67.3135,
\n"JPY":113.161,
\n"ILS":3.55495,
\n"EUR":0.930886
\n},
\n"ILS":{
\n"XAF":155.925,
\n"HKD":2.16985,
\n"AUD":0.352661,
\n"KRW":315.903,
\n"JOD":0.199196,
\n"GBP":0.212763,
\n"MXN":6.4871,
\n"AED":1.03302,
\n"INR":17.9609,
\n"JPY":31.1599,
\n"USD":0.281298,
\n"EUR":1.19318
\n},
\n"EUR":{
\n"XAF":655.957,
\n"HKD":8.88926,
\n"AUD":1.49707,
\n"KRW":1233.03,
\n"JOD":0.838098,
\n"GBP":0.860011,
\n"MXN":26.0359,
\n"AED":3.94594,
\n"INR":72.3136,
\n"JPY":121.567,
\n"USD":1.07428,
\n"ILS":4.20494
\n}
\n}
Transaction Requests satisfy PSD2 requirements thus:
\n1) A transaction can be initiated by a third party application.
\n2) The customer is informed of the charge that will incurred.
\n3) The call supports delegated authentication (OAuth)
\nSee this python code for a complete example of this flow.
\nThere is further documentation here
\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:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\ndate_of_birth: 2018-03-09
\niban: DE91 1000 0000 0123 4567 89
\nlegal_name: Eveline Tripman
\nstart_date: 2020-01-27
\nvalue: 5987953
\nGet basic information about the Adapter.
\nAuthentication is Optional
\nJSON response body fields:
\ndate: 2020-01-27
\ngit_commit: 59623811dd8a41f6ffe67be46954eee11913dc28
\nImport the historical transactions.
\nThe fields bank_id, account_id, counterparty_id in the json body are all optional ones.
\nIt support transfer money from account to account, account to counterparty and counterparty to counterparty
\nBoth bank_id + account_id and counterparty_id can identify the account, so OBP only need one of them to make the payment.
\nSo:
\nWhen you need the account to account, just omit counterparty_id field.eg:
\n{
\n"from": {
\n"bank_id": "gh.29.uk",
\n"account_id": "1ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "2ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
When you need the counterparty to counterparty, need to omit bank_id and account_id field.eg:
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"counterparty_id": "26392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
or, you can counterparty to account
\n{
\n"from": {
\n"counterparty_id": "f6392b7d-4218-45ea-b9a7-eaa71c0202f9"
\n},
\n"to": {
\n"bank_id": "gh.29.uk",
\n"account_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
\n},
\n"value": {
\n"currency": "GBP",
\n"amount": "10"
\n},
\n"description": "this is for work",
\n"posted": "2017-09-19T02:31:05Z",
\n"completed": "2017-09-19T02:31:05Z",
\n"type": "SANDBOX_TAN",
\n"charge_policy": "SHARED"
\n}
This call is experimental.
\nAuthentication is Mandatory
\nJSON request body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncompleted: 2020-01-27
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\nposted: 2020-01-27
\nvalue: 5987953
\nJSON response body fields:
\naccount_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\namount: 10.12
\nbank_id: gh.29.uk
\ncompleted: 2020-01-27
\ncounterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncurrency: EUR
\nposted: 2020-01-27
\ntransaction_id: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
\ntransaction_request_type: SEPA
\nvalue: 5987953
\nReturns the list of accounts containing private views for the user.
\nEach account lists the views available to the user.
optional request parameters:
\nwhole url example:
\n/my/accounts?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nJSON response body fields:
\naccount_type: AC
\nbank_id: gh.29.uk
\nlabel: My Account
\nDeletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID
\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":"Deletes the view specified by VIEW_ID on the bank account specified by ACCOUNT_ID at bank BANK_ID\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-50000: Unknown Error.","user does not have owner access"],"tags":["View-(Custom)","Account","New-Style"],"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/v3.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID","connector_methods":["obp.checkBankAccountExists","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getConsumersForCurrentUser","implemented_by":{"version":"OBPv3.1.0","function":"getConsumersForCurrentUser"},"request_verb":"GET","request_url":"/obp/v3.1.0/management/users/current/consumers","summary":"Get Consumers (logged in User)","description":"Get the Consumers for logged in User.
\nAuthentication is Mandatory
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nReturns the glossary of the API
\nAuthentication is Optional
\nJSON response body fields:
\n\n","description_markdown":"Returns the glossary of the API\n\n\nAuthentication is Optional\n\n\n**JSON response body fields:**\n\n\n\n* [html](/glossary#html): html format content\n\n\n\n* [title](/glossary#Customer.title): Dr.\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"glossary_items":[{"title":"Dr.","description":{"markdown":"String","html":"String"}}]},"error_response_bodies":["OBP-50000: Unknown Error."],"tags":["Documentation","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"glossary_items":{"type":"array","items":{"type":"object","properties":{"description":{"type":"object","properties":{"html":{"type":"string"},"markdown":{"type":"string"}}},"title":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/api/glossary","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getUserAuthContexts","implemented_by":{"version":"OBPv3.1.0","function":"getUserAuthContexts"},"request_verb":"GET","request_url":"/obp/v3.1.0/users/USER_ID/auth-context","summary":"Get User Auth Contexts","description":"Get User Auth Contexts for a User.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Get User Auth Contexts for a User.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [user_id](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"user_auth_contexts":[{"user_auth_context_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: ","OBP-30053: Could not insert the UserAuthContext","OBP-50000: Unknown Error."],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_auth_contexts":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"user_auth_context_id":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}}}}},"roles":[{"role":"CanGetUserAuthContext","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/users/USER_ID/auth-context","connector_methods":["obp.getUserAuthContexts","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-answerConsentChallenge","implemented_by":{"version":"OBPv3.1.0","function":"answerConsentChallenge"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge","summary":"Answer Consent Challenge","description":"An OBP Consent allows the holder of the Consent to call one or more endpoints.
\nConsents must be created and authorisied using SCA (Strong Customer Authentication).
\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.
\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.
\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key.
\nFor example:
\nGET /obp/v4.0.0/users/current HTTP/1.1
\nHost: 127.0.0.1:8080
\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn
\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj
\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml
\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY
\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg
Consumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk
\ncache-control: no-cache
Maximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.
\nExample of POST JSON:
\n{
\n"everything": false,
\n"views": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"account_id": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
\n"view_id": "owner"
\n}
\n],
\n"entitlements": [
\n{
\n"bank_id": "GENODEM1GLS",
\n"role_name": "CanGetCustomer"
\n}
\n],
\n"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
\n"email": "eveline@example.com",
\n"valid_from": "2020-02-07T08:43:34Z",
\n"time_to_live": 3600
\n}
\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live.
\nIn case you omit they the default values are used:
\nconsumer_id = consumer of current user
\nvalid_from = current time
\ntime_to_live = consents.max_time_to_live
This endpoint is used to confirm a Consent previously created.
\nThe User must supply a code that was sent out of band (OOB) for example via an SMS.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"An OBP Consent allows the holder of the Consent to call one or more endpoints.\n\nConsents must be created and authorisied using SCA (Strong Customer Authentication).\n\nThat is, Consents can be created by an authorised User via the OBP REST API but they must be confirmed via an out of band (OOB) mechanism such as a code sent to a mobile phone.\n\nEach Consent has one of the following states: INITIATED, ACCEPTED, REJECTED, REVOKED, RECEIVED, VALID, REVOKEDBYPSU, EXPIRED, TERMINATEDBYTPP, AUTHORISED, AWAITINGAUTHORISATION.\n\nEach Consent is bound to a consumer i.e. you need to identify yourself over request header value Consumer-Key. \nFor example:\nGET /obp/v4.0.0/users/current HTTP/1.1\nHost: 127.0.0.1:8080\nConsent-JWT: eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOlt7InJvbGVfbmFtZSI6IkNhbkdldEFueVVzZXIiLCJiYW5rX2lkIjoiIn\n1dLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIzNDc1MDEzZi03YmY5LTQyNj\nEtOWUxYy0xZTdlNWZjZTJlN2UiLCJhdWQiOiI4MTVhMGVmMS00YjZhLTQyMDUtYjExMi1lNDVmZDZmNGQzYWQiLCJuYmYiOjE1ODA3NDE2NjcsIml\nzcyI6Imh0dHA6XC9cLzEyNy4wLjAuMTo4MDgwIiwiZXhwIjoxNTgwNzQ1MjY3LCJpYXQiOjE1ODA3NDE2NjcsImp0aSI6ImJkYzVjZTk5LTE2ZTY\ntNDM4Yi1hNjllLTU3MTAzN2RhMTg3OCIsInZpZXdzIjpbXX0.L3fEEEhdCVr3qnmyRKBBUaIQ7dk1VjiFaEBW8hUNjfg\n\nConsumer-Key: ejznk505d132ryomnhbx1qmtohurbsbb0kijajsk\ncache-control: no-cache\n\nMaximum time to live of the token is specified over props value consents.max_time_to_live. In case isn't defined default value is 3600 seconds.\n\nExample of POST JSON:\n{\n \"everything\": false,\n \"views\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"account_id\": \"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0\",\n \"view_id\": \"owner\"\n }\n ],\n \"entitlements\": [\n {\n \"bank_id\": \"GENODEM1GLS\",\n \"role_name\": \"CanGetCustomer\"\n }\n ],\n \"consumer_id\": \"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\",\n \"email\": \"eveline@example.com\",\n \"valid_from\": \"2020-02-07T08:43:34Z\",\n \"time_to_live\": 3600\n}\nPlease note that only optional fields are: consumer_id, valid_from and time_to_live. \nIn case you omit they the default values are used:\nconsumer_id = consumer of current user\nvalid_from = current time\ntime_to_live = consents.max_time_to_live\n\n \n\n\nThis endpoint is used to confirm a Consent previously created.\n\nThe User must supply a code that was sent out of band (OOB) for example via an SMS.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"answer":"12345678"},"success_response_body":{"consent_id":"9d429899-24f5-42c8-8565-943ffa6a7945","jwt":"eyJhbGciOiJIUzI1NiJ9.eyJlbnRpdGxlbWVudHMiOltdLCJjcmVhdGVkQnlVc2VySWQiOiJhYjY1MzlhOS1iMTA1LTQ0ODktYTg4My0wYWQ4ZDZjNjE2NTciLCJzdWIiOiIyMWUxYzhjYy1mOTE4LTRlYWMtYjhlMy01ZTVlZWM2YjNiNGIiLCJhdWQiOiJlanpuazUwNWQxMzJyeW9tbmhieDFxbXRvaHVyYnNiYjBraWphanNrIiwibmJmIjoxNTUzNTU0ODk5LCJpc3MiOiJodHRwczpcL1wvd3d3Lm9wZW5iYW5rcHJvamVjdC5jb20iLCJleHAiOjE1NTM1NTg0OTksImlhdCI6MTU1MzU1NDg5OSwianRpIjoiMDlmODhkNWYtZWNlNi00Mzk4LThlOTktNjYxMWZhMWNkYmQ1Iiwidmlld3MiOlt7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAxIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifSx7ImFjY291bnRfaWQiOiJtYXJrb19wcml2aXRlXzAyIiwiYmFua19pZCI6ImdoLjI5LnVrLngiLCJ2aWV3X2lkIjoib3duZXIifV19.8cc7cBEf2NyQvJoukBCmDLT7LXYcuzTcSYLqSpbxLp4","status":"INITIATED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["Consent","Account Information Service (AIS)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"answer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"consent_id":{"type":"string"},"status":{"type":"string"},"jwt":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge","connector_methods":["obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-answerUserAuthContextUpdateChallenge","implemented_by":{"version":"OBPv3.1.0","function":"answerUserAuthContextUpdateChallenge"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge","summary":"Answer Auth Context Update Challenge","description":"Answer Auth Context Update Challenge.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\n\n","description_markdown":"Answer Auth Context Update Challenge.\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [key](/glossary#Adapter.key): CustomerNumber\n\n\n\n* [user_id](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n* [value](/glossary#Customer.customerAttributeValue): 5987953\n\n\n","example_request_body":{"answer":"12345678"},"success_response_body":{"user_auth_context_update_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","key":"CUSTOMER_NUMBER","value":"78987432","status":"INITIATED"},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-10001: Incorrect json format.","OBP-50200: Connector cannot return the data we requested.","OBP-50000: Unknown Error."],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"answer":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"user_auth_context_update_id":{"type":"string","format":"date-time"},"key":{"type":"string"},"status":{"type":"string"},"value":{"type":"string"},"user_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge","connector_methods":["obp.getCustomerByCustomerNumber","obp.createUserAuthContext","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.0.0-getAccountsHeld","implemented_by":{"version":"OBPv3.0.0","function":"getAccountsHeld"},"request_verb":"GET","request_url":"/obp/v3.0.0/banks/BANK_ID/accounts-held","summary":"Get Accounts Held","description":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.
\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.
\noptional request parameters:
\nwhole url example:
\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE
Authentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\n\n","description_markdown":"Get Accounts held by the current User if even the User has not been assigned the owner View yet.\n\nCan be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.\n\n\noptional request parameters:\n\n* account_type_filter: one or many accountType value, split by comma\n* account_type_filter_operation: the filter type of account_type_filter, value must be INCLUDE or EXCLUDE\n\nwhole url example:\n/banks/BANK_ID/accounts-held?account_type_filter=330,CURRENT+PLUS&account_type_filter_operation=INCLUDE\n \n\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n* [bank_id](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [label](/glossary#can_see_bank_account_label): My Account\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"accounts":[{"id":"12314","label":"My Account","bank_id":"123","number":"123","account_routings":[{"scheme":"AccountNumber","address":"4930396"}]}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-50000: Unknown Error."],"tags":["Account","Account Information Service (AIS)","View-(Custom)","PSD2","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"accounts":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"label":{"type":"string"},"bank_id":{"type":"string"},"account_routings":{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string"},"address":{"type":"string"}}}},"id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/accounts-held","connector_methods":["obp.getCoreBankAccounts","obp.getBankAccountsHeld","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-config","implemented_by":{"version":"OBPv3.1.0","function":"config"},"request_verb":"GET","request_url":"/obp/v3.1.0/config","summary":"Get API Configuration","description":"Returns information about:
\nAuthentication is Mandatory
\nJSON response body fields:
\nGet Transactions for an Account that has a firehose View.
\nAllows bulk access to an account's transactions.
\nUser must have the CanUseFirehoseAtAnyBank Role
To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call.
\nFor VIEW_ID try 'owner'
\nPossible custom url parameters for pagination:
\neg1:?limit=100&offset=0
\neg2:?limit=100&offset=0&sort_direction=ASC
\nDate format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
\neg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
\nAuthentication is Mandatory
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nVIEW_ID: owner
\nJSON response body fields:
\namount: 10.12
\ncompleted: 2020-01-27
\ncurrency: EUR
\ndate: 2020-01-27
\nlabel: My Account
\nlatitude: 38.8951
\nlongitude: -77.0364
\nnew_balance: 20
\nposted: 2020-01-27
\ntransaction_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nvalue: 5987953
\nCreate a view on bank account
\nAuthentication is Mandatory and the user needs to have access to the owner view.
\nThe 'alias' field in the JSON can take one of three values:
''(empty string): to use no alias; the view shows the real name of the other account.
\nThe 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
The 'allowed_actions' field is a list containing the name of the actions allowed on this view, all the actions contained will be set to true
on the view creation, the rest will be set to false
.
You MUST use a leading _ (underscore) in the view name because other view names are reserved for OBP system views.
\nURL Parameters:
\nACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\nJSON response body fields:
\nCreate Entitlement Request.
\nAny logged in User can use this endpoint to request an Entitlement
\nEntitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is Mandatory
\nJSON request body fields:
\nJSON response body fields:
\nbank_id: gh.29.uk
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nDelete Branch from given Bank.
\nAuthentication is Mandatory
\nURL Parameters:
\n\nJSON response body fields:
\n","description_markdown":"Delete Branch from given Bank.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n* [BRANCH_ID](/glossary#Branch.branch_id): DERBY6\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-30001: Bank not found. Please specify a valid value for BANK_ID.","OBP-30218: Insufficient authorisation to Create Branch. You do not have the role CanCreateBranch.","OBP-50000: Unknown Error.","OBP-20006: User is missing one or more roles: "],"tags":["Branch","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"roles":[{"role":"CanDeleteBranch","requires_bank_id":true},{"role":"CanDeleteBranchAtAnyBank","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/banks/BANK_ID/branches/BRANCH_ID","connector_methods":["obp.getBranch","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv2.0.0-getSocialMediaHandles","implemented_by":{"version":"OBPv2.0.0","function":"getSocialMediaHandles"},"request_verb":"GET","request_url":"/obp/v2.0.0/banks/BANK_ID/customers/CUSTOMER_ID/social_media_handles","summary":"Get Customer Social Media Handles","description":"Get social media handles for a customer specified by CUSTOMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nCUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nThese message docs provide example messages sent by OBP to the (Kafka) message queue for processing by the Core Banking / Payment system Adapter - together with an example expected response and possible error codes.
\nIntegrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
\nCONNECTOR
:kafka_vMar2017 , kafka_vJune2017, kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nEnable/Disable a Consumer specified by CONSUMER_ID.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nReturns information about a particular financial product specified by BANK_ID and PRODUCT_CODE
\nand it's parent product(s) recursively as specified by parent_product_code.
Each product includes the following information.
\nAuthentication is Optional
\nURL Parameters:
\nJSON response body fields:
\nUpdate an existing redirectUrl for a Consumer specified by CONSUMER_ID.
\nCONSUMER_ID can be obtained after you register the application.
\nOr use the endpoint 'Get Consumers' to get it
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\nGet 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
\nis_beneficiary: true
\nkey: CustomerNumber
\nvalue: 5987953
\nGet Product Attribute
\nProduct Attributes are used to describe a financial Product with a list of typed key value pairs.
\nEach Product Attribute is linked to its Product by PRODUCT_CODE
\nGet one product attribute by its id.
\nAuthentication is Mandatory
\nURL Parameters:
\nJSON response body fields:
\nThe endpoint is used for updating the accounts, views, account holders for the user.
\nAs to the Json body, you can leave it as Empty.
\nThis call will get data from backend, no need to prepare the json body in api side.
Authentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\nJSON response body fields:
\n","description_markdown":"The endpoint is used for updating the accounts, views, account holders for the user.\n As to the Json body, you can leave it as Empty. \n This call will get data from backend, no need to prepare the json body in api side.\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n* [USER_ID](/glossary#User.user_id): 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n\n\n**JSON response body fields:**\n\n\n","example_request_body":{"jsonString":"{}"},"success_response_body":{"duration_time":"10 ms"},"error_response_bodies":["OBP-20006: User is missing one or more roles: ","OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!"],"tags":["User","New-Style"],"typed_request_body":{"type":"object","properties":{"jsonString":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"duration_time":{"type":"string"}}},"roles":[{"role":"CanRefreshUser","requires_bank_id":false}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v3.1.0/users/USER_ID/refresh","connector_methods":["obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createCustomer","implemented_by":{"version":"OBPv3.1.0","function":"createCustomer"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/customers","summary":"Create Customer","description":"The Customer resource stores the customer number, legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
\nDates need to be in the format 2013-01-21T23:08:00Z
Authentication is Mandatory
\nURL Parameters:
\nJSON request body fields:
\namount: 10.12
\nbranch_id: DERBY6
\ncurrency: EUR
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nJSON response body fields:
\namount: 10.12
\nbank_id: gh.29.uk
\nbranch_id: DERBY6
\ncurrency: EUR
\ncustomer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\ncustomer_number: 5987953
\ndate: 2020-01-27
\ndate_of_birth: 2018-03-09
\nemployment_status: worker
\nhighest_education_attained: Master
\nkyc_status: true
\nlegal_name: Eveline Tripman
\nname_suffix: Sr
\nrelationship_status: single
\ntitle: Dr.
\nGet the all Consumers.
\nAuthentication is Mandatory
\nJSON response body fields:
\nconsumer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nenabled: true
\nuser_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
\nusername: felixsmith
\n