Open Bank Project
|
OBP v2.2.0 (143 APIs)
API Host: https://apisandbox.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsGet API ConfigurationReturns information about:
Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by config
Get API Info (root)Returns information about:
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by root
Create ATMCreate ATM for the Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createAtm
Get Bank ATMReturns information about ATM for a single bank specified by BANK_ID and ATM_ID including:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getAtm
Create AccountCreate Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID. The User can create an Account for themself or an Account for another User if they have CanCreateAccount role. If USER_ID is not specified the account will be owned by the logged in User. The type field should be a product_code from Product. Note: The Amount must be zero. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createAccount
Create View.Create a view on bank accountAuthentication is Mandatory and the user needs to have access to the owner view.
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to 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 You should use a leading _ (underscore) for the view name because other view names may become reserved by OBP internally Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by createViewForBankAccount
Get Account by Id (Core)Information returned about the account specified by ACCOUNT_ID:
This call returns the owner view and requires access to that view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getCoreAccountById
Get Account by Id (Full)Information returned about an account specified by ACCOUNT_ID as moderated by the view (VIEW_ID):
More details about the data moderation by the view here. PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. Authentication is Mandatory if the 'is_public' field in view (VIEW_ID) is not set to Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by accountById
Get Accounts at Bank.Returns the list of accounts at BANK_ID that the user has access to. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getPrivateAccountsAtOneBank
Get Accounts at all Banks (Private)Get private accounts at all banks (Authenticated access) Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by corePrivateAccountsAllBanks
Get all Accounts at all Banks.Get all accounts at all banks the User has access to. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getPrivateAccountsAllBanks
Get private accounts at one bank.Returns the list of private accounts at BANK_ID that the user has access to. If you want to see more information on the Views, use the Account Detail call. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by privateAccountsAtOneBank
Update Account Label.Update the label for the account. The label is how the account is known to the account owner e.g. 'My savings account' Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateAccountLabel
Update View.Update an existing view on a bank account Authentication is Mandatory and the user needs to have access to the owner view. The json sent is the same as during view creation (above), with one difference: the 'name' field Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by updateViewForBankAccount
Get Public Accounts at BankReturns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by publicAccountsAtOneBank
Get Public Accounts at all Banks.Get public accounts at all banks (Anonymous access). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by publicAccountsAllBanks
Create BankCreate a new bank (Authenticated access). Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createBank
Create Transaction Type at bankCreate Transaction Types for the bank specified by BANK_ID:
Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by createTransactionType
Get BankGet the bank specified by BANK_ID
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by bankById
Get Bank ATMSReturns information about ATMs for a single bank specified by BANK_ID including:
Pagination: You can use the url query parameters limit and offset for pagination Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getAtms
Get BanksGet banks on this API instance
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getBanks
Get Transaction Types at BankGet Transaction Types for the bank specified by BANK_ID: Lists 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).
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getTransactionTypes
Create BranchCreate Branch for the Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createBranch
Get Bank BranchReturns information about branches for a single bank specified by BANK_ID and BRANCH_ID including:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getBranch
Get Bank BranchesReturns information about branches for a single bank specified by BANK_ID including:
Pagination: You can use the url query parameters limit and offset for pagination Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getBranches
Update BranchUpdate an existing branch for a bank account (Authenticated access). Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by updateBranch
Create CardCreate Card at bank specified by BANK_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by addCardsForBank
Get cards for the current userReturns data about all the physical cards a user has been issued. These could be debit cards, credit cards, etc. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.3.0 by getCards
Get cards for the specified bankTypical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.3.0 by getCardsForBank
Enable or Disable ConsumersEnable/Disable a Consumer specified by CONSUMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by enableDisableConsumers
Get ConsumerGet the Consumer specified by CONSUMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by getConsumer
Get ConsumersGet the all Consumers. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by getConsumers
Post a ConsumerCreate a Consumer (Authenticated access). Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createConsumer
Update Consumer RedirectUrlUpdate an existing redirectUrl for a Consumer specified by CONSUMER_ID. CONSUMER_ID can be obtained after you register the application. Or use the endpoint 'Get Consumers' to get it Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by updateConsumerRedirectUrl
Create Counterparty (Explicit)Create Counterparty (Explicit) for an Account. In OBP, there are two types of Counterparty.
Explicit Counterparties are created for the account / view name : the human readable name (e.g. Piano teacher, Miss Nipa) description : the human readable name (e.g. Piano teacher, Miss Nipa) bank_routing_scheme : eg: bankId or bankCode or any other strings bank_routing_address : eg: account_routing_scheme : eg: AccountId or AccountNumber or any other strings account_routing_address : eg: other_account_secondary_routing_scheme : eg: IBan or any other strings other_account_secondary_routing_address : if it is IBan, it should be unique for each counterparty. other_branch_routing_scheme : eg: branchId or any other strings or you can leave it empty, not useful in sandbox mode. other_branch_routing_address : eg: is_beneficiary : must be set to bespoke: It support list of key-value, you can add it to the counterarty. bespoke.key : any info-key you want to add to this counerparty bespoke.value : any info-value you want to add to this counerparty The view specified by VIEW_ID must have the canAddCounterparty permission A minimal example for TransactionRequestType == COUNTERPARTY A minimal example for TransactionRequestType == SEPA { Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by createCounterparty
Get Counterparties (Explicit).Get the Counterparties (Explicit) for the account / view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by getExplictCounterpartiesForAccount
Get Counterparty by Counterparty Id.(Explicit).Information returned about the Counterparty specified by COUNTERPARTY_ID: Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by getExplictCounterpartyById
Get Other Account by Id.Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountByIdForBankAccount
Get Other Accounts of one Account.Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountsForBankAccount
Add Corporate Location to CounterpartyAdd the geolocation of the counterparty's registered address Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyCorporateLocation
Add Counterparty More InfoAdd a description of the counter party from the perpestive of the account e.g. My dentist. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyMoreInfo
Add Open Corporates URL to CounterpartyAdd open corporates url to other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyOpenCorporatesUrl
Add image url to other bank account.Add a url that points to the logo of the counterparty Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyImageUrl
Add physical location to other bank account.Add geocoordinates of the counterparty's main location Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyPhysicalLocation
Add public alias to other bank account.Creates the public alias for the other account OTHER_ACCOUNT_ID. Authentication is Optional Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyPublicAlias
Add url to other bank account.A url which represents the counterparty (home page url etc.) Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCounterpartyUrl
Create Other Account Private AliasCreates a private alias for the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addOtherAccountPrivateAlias
Delete Counterparty Corporate Location.Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyCorporateLocation
Delete Counterparty Image URLDelete image url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyImageUrl
Delete Counterparty Open Corporates URLDelete open corporate url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyOpenCorporatesUrl
Delete Counterparty Physical Location.Delete physical location of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPhysicalLocation
Delete Counterparty Private AliasDeletes the private alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPrivateAlias
Delete Counterparty Public AliasDeletes the public alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyPublicAlias
Delete more info of other bank account.Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyMoreInfo
Delete url of other bank account.Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCounterpartyUrl
Get Other Account Metadata.Get metadata of one other account. Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountMetadata
Get Other Account Private AliasReturns the private alias of the other account OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountPrivateAlias
Get public alias of other bank account.Returns the public alias of the other account OTHER_ACCOUNT_ID. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getCounterpartyPublicAlias
Update Counterparty Corporate LocationUpdate the geolocation of the counterparty's registered address Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyCorporateLocation
Update Counterparty Image UrlUpdate the url that points to the logo of the counterparty Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyImageUrl
Update Counterparty More InfoUpdate the more info description of the counter party from the perpestive of the account e.g. My dentist. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyMoreInfo
Update Counterparty Physical LocationUpdate geocoordinates of the counterparty's main location Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPhysicalLocation
Update Counterparty Private AliasUpdates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPrivateAlias
Update Open Corporates Url of CounterpartyUpdate open corporate url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyOpenCorporatesUrl
Update public alias of other bank account.Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyPublicAlias
Update url of other bank account.A url which represents the counterparty (home page url etc.) Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateCounterpartyUrl
Add Social Media HandleAdd a social media handle for the customer specified by CUSTOMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addSocialMediaHandle
Create Customer.Add a customer linked to the user specified by user_id Authentication is Mandatory CanCreateCustomer and CanCreateUserCustomerLink OR CanCreateCustomerAtAnyBank and CanCreateUserCustomerLinkAtAnyBank Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by createCustomer
Create User Customer Link.Link a User to a Customer Authentication is Mandatory CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by createUserCustomerLinks
Get CRM EventsTypical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getCrmEvents
Get Customer Social Media HandlesGet social media handles for a customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by getSocialMediaHandles
Get Customers for current User at BankRetuns a list of Customers at the Bank that are linked to the currently authenticated User. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getCustomersForCurrentUserAtBank
Create Meeting (video conference/call)Create Meeting: Initiate a video conference/call with the bank. The Meetings resource contains meta data about video/other conference sessions, not the video/audio/chat itself. The actual conferencing is handled by external providers. Currently OBP supports tokbox video conferences (WIP). This is not a recomendation of tokbox per se. provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces). purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces). Login is required. This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by createMeeting
Get MeetingGet Meeting specified by BANK_ID / MEETING_ID The actual conference/chats are handled by external services. Login is required. This call is experimental and will require further authorisation in the future. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getMeeting
Get MeetingsMeetings contain meta data about, and are used to facilitate, video conferences / chats etc. The actual conference/chats are handled by external services. Login is required. This call is experimental and will require further authorisation in the future. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getMeetings
Add Customer Message.Add a message for the customer specified by CUSTOMER_ID Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by addCustomerMessage
Get Customer Messages (current)Get messages for the logged in customer Authentication via OAuth is required. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getCustomerMessages
Search Warehouse Data Via ElasticsearchSearch warehouse data via Elastic Search. Login is required. CanSearchWarehouse entitlement is required to search warehouse data! Send your email, name, project name and user_id to the admins to get access. Elastic (search) is used in the background. See links below for syntax. parameters: esType - elasticsearch type simple query: q - plain_text_query df - default field to search sort - field to sort on size - number of hits returned, default 10 from - show hits starting from json query: source - JSON_query_(URL-escaped) Example usage: GET /search/warehouse/q=findThis or: GET /search/warehouse/source={"query":{"query_string":{"query":"findThis"}}} Note!! The whole JSON query string MUST be URL-encoded:
etc.. Only q, source and esType are passed to Elastic Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html You can specify the esType thus: /search/warehouse/esType=type&q=a Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by elasticSearchWarehouse
Get Message DocsThese 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. Note: API Explorer provides a Message Docs page where these messages are displayed.
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by getMessageDocs
Get Resource Docs.Get documentation about the RESTful resources on this server including example bodies for POST and PUT requests. This 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. This endpoint is used by OBP API Explorer to display and work with the API documentation. Most (but not all) fields are also available in swagger format. (The Swagger endpoint is built from Resource Docs.) API_VERSION is the version you want documentation about e.g. v3.0.0 You may filter this endpoint with tags parameter e.g. ?tags=Account,Bank You may filter this endpoint with functions parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics 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.
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getResourceDocsObp
Get Swagger documentationReturns documentation about the RESTful resources on this server in Swagger format. API_VERSION is the version you want documentation about e.g. v3.0.0 You may filter this endpoint using the 'tags' url parameter e.g. ?tags=Account,Bank (All endpoints are given one or more tags which for used in grouping) You may filter this endpoint using the 'functions' url parameter e.g. ?functions=enableDisableConsumers,getConnectorMetrics (Each endpoint is implemented in the OBP Scala code by a 'function') See the Resource Doc endpoint for more information. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.4.0 by getResourceDocsSwagger
Get Current FxRateGet the latest FXRate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.2.0 by getCurrentFxRate
Add KYC CheckAdd 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. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by addKycCheck
Add KYC Document.Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by addKycDocument
Add KYC Media.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. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by addKycMedia
Add KYC StatusAdd a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by addKycStatus
Get Customer KYC ChecksGet KYC checks for the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getKycChecks
Get Customer KYC DocumentsGet KYC (know your customer) documents for a customer specified by CUSTOMER_ID Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getKycDocuments
Get Customer KYC statusesGet the KYC statuses for a customer specified by CUSTOMER_ID over time. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getKycStatuses
Get KYC Media for a customerGet KYC media (scans, pictures, videos) that affirms the identity of the customer. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getKycMedia
Get Connector MetricsGet the all metrics require CanGetConnectorMetrics role Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/connector/metrics Should be able to filter on the following metrics fields eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=50&offset=2 1 from_date (defaults to one week before current date): eg:from_date=2017-09-19 2 to_date (defaults to current date) eg:to_date=2017-09-19 3 limit (for pagination: defaults to 1000) eg:limit=2000 4 offset (for pagination: zero index, defaults to 0) eg: offset=10 eg: /management/connector/metrics?from_date=2017-09-19&to_date=2017-09-19&limit=100&offset=300 Other filters: 5 connector_name (if null ignore) 6 function_name (if null ignore) 7 correlation_id (if null ignore) Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by getConnectorMetrics
Get MetricsGet the all metrics require CanReadMetrics role Filters Part 1.filtering (no wilde cards etc.) parameters to GET /management/metrics Should be able to filter on the following metrics fields eg: /management/metrics?from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z&limit=50&offset=2 1 from_date (defaults to one week before current date): eg:from_date=2017-09-19T02:31:05.000Z 2 to_date (defaults to current date) eg:to_date=2017-09-19T02:31:05.000Z 3 limit (for pagination: defaults to 50) eg:limit=200 4 offset (for pagination: zero index, defaults to 0) eg: offset=10 5 sort_by (defaults to date field) eg: sort_by=date 6 direction (defaults to date desc) eg: direction=desc eg: /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 Other filters: 7 consumer_id (if null ignore) 8 user_id (if null ignore) 9 anon (if null ignore) only support two value : true (return where user_id is null.) or false (return where user_id is not null.) 10 url (if null ignore), note: can not contain '&'. 11 app_name (if null ignore) 12 implemented_by_partial_function (if null ignore), 13 implemented_in_version (if null ignore) 14 verb (if null ignore) 15 correlation_id (if null ignore) 16 duration (if null ignore) non digit chars will be silently omitted Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by getMetrics
Search API Metrics via Elasticsearch.Search the API calls made to this API instance via Elastic Search. Login is required. CanSearchMetrics entitlement is required to search metrics data. parameters: esType - elasticsearch type simple query: q - plain_text_query df - default field to search sort - field to sort on size - number of hits returned, default 10 from - show hits starting from json query: source - JSON_query_(URL-escaped) example usage: /search/metrics/q=findThis or: /search/metrics/source={"query":{"query_string":{"query":"findThis"}}} Note!! The whole JSON query string MUST be URL-encoded:
etc.. Only q, source and esType are passed to Elastic Elastic simple query: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html Elastic JSON query: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by elasticSearchMetrics
Create ProductCreate or Update Product for the Bank. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.2.0 by createProduct
Get Bank ProductReturns information about the financial products offered by a bank specified by BANK_ID and PRODUCT_CODE including:
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getProduct
Get Bank ProductsReturns information about the financial products offered by a bank specified by BANK_ID including:
Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getProducts
Add Entitlement for a User.Create Entitlement. Grant Role to User. Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views) For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":"" For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id" Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by addEntitlement
Delete EntitlementDelete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID Authentication is required and the user needs to be a Super Admin. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by deleteEntitlement
Get Entitlements for UserAuthentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.0.0 by getEntitlements
Get Entitlements for User at Bank.Get Entitlements specified by BANK_ID and USER_ID Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by getEntitlementsByBankAndUser
Get RolesReturns all available roles Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.1.0 by getRoles
Get all EntitlementsLogin is required. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv2.0.0 by getAllEntitlements
Create sandboxImport bulk data into the sandbox (Authenticated access). This call can be used to create banks, users, accounts and transactions which are stored in the local RDBMS. The user needs to have CanCreateSandbox entitlement. Note: 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. An example of an import set of data (json) can be found here Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implemented in OBPv2.1.0 by sandboxDataImport
Get Other Account of TransactionGet other account of a transaction. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getOtherAccountForTransaction
Get Transaction by Id.Returns one transaction specified by TRANSACTION_ID of the account ACCOUNT_ID and moderated by the view (VIEW_ID). Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getTransactionByIdForBankAccount
Get Transactions for Account (Full)Returns transactions list of the account specified by ACCOUNT_ID and moderated by the view (VIEW_ID). Authentication via OAuth is required if the view is not public. Possible custom headers for pagination:
Date format parameter: $DateWithMs($DateWithMsExampleString) ==> time zone is UTC. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getTransactionsForBankAccount
Add a tag.Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID. Authentication is Mandatory Authentication is required as the tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addTagForViewOnTransaction
Add an image.Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID. Authentication is Mandatory The image is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addImageForViewOnTransaction
Add comment.Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID. ${authenticationRequiredMessage(false)} Authentication is required since the comment is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addCommentForViewOnTransaction
Add narrative.Creates a description of the transaction TRANSACTION_ID. Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addTransactionNarrative
Add where tag.Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view. Authentication is Mandatory The geo tag is linked with the user. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by addWhereTagForViewOnTransaction
Delete a tag.Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteTagForViewOnTransaction
Delete an imageDeletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view. Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteImageForViewOnTransaction
Delete comment.Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view. Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteCommentForViewOnTransaction
Delete narrative.Deletes the description of the transaction TRANSACTION_ID. Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteTransactionNarrative
Delete where tag.Deletes the where tag of the transaction TRANSACTION_ID made on view. Authentication is Mandatory The user must either have owner privileges for this account, or must be the user that posted the geo tag. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by deleteWhereTagForViewOnTransaction
Get comments.Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getCommentsForViewOnTransaction
Get images.Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID). Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getImagesForViewOnTransaction
Get narrative.Returns the account owner description of the transaction moderated by the view. Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getTransactionNarrative
Get tags.Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID). Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getTagsForViewOnTransaction
Get where tag.Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID). Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by getWhereTagForViewOnTransaction
Update narrative.Updates the description of the transaction TRANSACTION_ID. Authentication via OAuth is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implemented in OBPv1.2.1 by updateTransactionNarrative
|
API Explorer
