All APIs
|
All APIs OBPv2.1.0 (207)
API Host: https://demo.openbankproject.com
BankAccountsViewsCounterpartiesTransactionsGet API ConfigurationReturns information about:
Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.1.0 by config
Get API Info (root)Returns information about:
Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.2.1 by root
Get Adapter InfoGet basic information about the Adapter listening on behalf of this bank. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getAdapter
Get Adapter Info (general)Get basic information about the Adapter. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getAdapterInfo
Get Connector Status (Loopback)This endpoint makes a call to the Connector to check the backend transport (e.g. Kafka) is reachable. Currently this is only implemented for Kafka based connectors. For Kafka based connectors, this endpoint writes a message to Kafka and reads it again. In the future, this endpoint may also return information about database connections etc. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getObpApiLoopback
Get Rate Limiting InfoGet information about the Rate Limiting setup on this OBP Instance such as: Is rate limiting enabled and active? Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getRateLimitingInfo
Create ATMCreate ATM for the Bank. Authentication is Mandatory OBP-20006: User is missing one or more roles: CanCreateAtm OR CanCreateAtmAtAnyBank Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.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:
Implmented in 3.0.0 by getAtm
Get Bank ATMSReturns information about ATMs for a single bank specified by BANK_ID including:
Pagination: By default, 100 records are returned. You can use the url query parameters limit and offset for pagination Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getAtms
Check Available FundsCheck Available Funds
Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by checkFundsAvailable
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. Note: The Amount must be zero. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.2.0 by createAccount
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:
Implmented in 3.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 required if the 'is_public' field in view (VIEW_ID) is not set to Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getPrivateAccountById
Get Accounts HeldGet Accounts held by the current User if even the User has not been assigned the owner View yet. Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getAccountsHeld
Get Accounts at Bank (IDs only).Returns only the list of accounts ids at BANK_ID that the user has access to. Each account must have at least one private View. For each account the API returns its account ID. If you want to see more information on the Views, use the Account Detail call. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getPrivateAccountIdsbyBankId
Get Accounts at Bank (Minimal).Returns the minimal 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:
Implmented in 3.0.0 by privateAccountsAtOneBank
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:
Implmented in 2.0.0 by getPrivateAccountsAtOneBank
Get Accounts at all Banks (private)Returns the list of accounts containing private views for the user. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by corePrivateAccountsAllBanks
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:
Implmented in 1.2.1 by updateAccountLabel
Create Account ApplicationCreate Account Application Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by createAccountApplication
Get Account Application by IdGet the Account Application. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getAccountApplication
Get Account ApplicationsGet the Account Applications. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getAccountApplications
Update Account Application StatusUpdate an Account Application status Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by updateAccountApplicationStatus
Get Firehose Accounts at BankGet Accounts which have a firehose view assigned to them. This endpoint allows bulk access to accounts. Requires the CanUseFirehoseAtAnyBank Role To be shown on the list, each Account must have a firehose View linked to it. For VIEW_ID try 'owner' Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.0 by getFirehoseAccountsAtOneBank
Get Firehose CustomersGet Customers that has a firehose View. Allows bulk access to customers. Possible custom URL parameters for pagination:
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.1.0 by getFirehoseCustomers
Get Firehose Transactions for AccountGet Transactions for an Account that has a firehose View. Allows bulk access to an account's transactions. To find ACCOUNT_IDs, use the getFirehoseAccountsAtOneBank call. For VIEW_ID try 'owner' Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.0 by getFirehoseTransactionsForBankAccount
Get Public Account by IdReturns information about an account that has a public view. The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.
PSD2 Context: PSD2 requires customers to have access to their account information via third party applications. Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getPublicAccountById
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:
Implmented in 2.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:
Implmented in 2.0.0 by publicAccountsAllBanks
Create BankCreate a new bank (Authenticated access). Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.2.0 by createBank
Create Credit Limit Order RequestCreate credit limit order request Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by createCreditLimitRequest
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:
Implmented in 2.1.0 by createTransactionType
Get BankGet the bank specified by BANK_ID
Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by bankById
Get BanksGet banks on this API instance
Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getBanks
Get Credit Limit Order Request By Request IdGet Credit Limit Order Request By Request Id Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCreditLimitRequestByRequestId
Get Credit Limit Order RequestsGet Credit Limit Order Requests Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCreditLimitRequests
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:
Implmented in 2.0.0 by getTransactionTypes
Get status of Credit Card orderGet status of Credit Card orders Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getStatusOfCreditCardOrder
get Checkbook ordersGet all checkbook orders Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCheckbookOrders
Create BranchCreate Branch for the Bank. Authentication is Mandatory OBP-20006: User is missing one or more roles: CanCreateBranch entitlements are required OR CanCreateBranchAtAnyBank Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.0 by createBranch
Get BranchReturns information about a single Branch specified by BANK_ID and BRANCH_ID including:
Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getBranch
Get Branches for a BankReturns information about branches for a single bank specified by BANK_ID including:
Pagination: By default, 50 records are returned. You can use the url query parameters limit and offset for pagination Authentication is Optional Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getBranches
Update BranchUpdate an existing branch for a bank account (Authenticated access). Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.1.0 by updateBranch
Create CardCreate Card at bank specified by BANK_ID . Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.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:
Implmented in 1.3.0 by getCards
Get cards for the specified bankTypical Successful Response:
Headers:
Possible Errors:
Implmented in 1.3.0 by getCardsForBank
Enable or Disable ConsumersEnable/Disable a Consumer specified by CONSUMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.1.0 by enableDisableConsumers
Get Call Limits for a ConsumerGet Calls limits per Consumer. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.1.0 by getCallsLimit
Get ConsumerGet the Consumer specified by CONSUMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.1.0 by getConsumer
Get ConsumersGet the all Consumers. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.1.0 by getConsumers
Get Consumers (logged in User)Get the Consumers for logged in User. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getConsumersForCurrentUser
Set Calls Limit for a ConsumerSet the API call limits for a Consumer: Per Minute Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.1.0 by callsLimit
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:
Implmented in 2.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:
Implmented in 2.2.0 by createCounterparty
Get Counterparties (Explicit).Get the Counterparties (Explicit) for the account / view. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 2.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:
Implmented in 2.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. Authentication is required if the view is not public. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 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. Authentication is required if the view VIEW_ID is not public. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getOtherAccountsForBankAccount
Add Corporate Location to CounterpartyAdd the geolocation of the counterparty's registered address Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.2.1 by addCounterpartyMoreInfo
Add Open Corporates URL to CounterpartyAdd open corporates url to other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.2.1 by deleteCounterpartyCorporateLocation
Delete Counterparty Image URLDelete image url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.2.1 by deleteCounterpartyImageUrl
Delete Counterparty Open Corporates URLDelete open corporate url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.2.1 by deleteCounterpartyOpenCorporatesUrl
Delete Counterparty Physical Location.Delete physical location of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.2.1 by deleteCounterpartyPublicAlias
Delete more info of other bank account.Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.2.1 by deleteCounterpartyMoreInfo
Delete url of other bank account.Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.2.1 by getCounterpartyPublicAlias
Update Counterparty Corporate LocationUpdate the geolocation of the counterparty's registered address Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.2.1 by updateCounterpartyCorporateLocation
Update Counterparty Image UrlUpdate the url that points to the logo of the counterparty Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.2.1 by updateCounterpartyMoreInfo
Update Counterparty Physical LocationUpdate geocoordinates of the counterparty's main location Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.2.1 by updateCounterpartyPrivateAlias
Update Open Corporates Url of CounterpartyUpdate open corporate url of other bank account. Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.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:
Implmented in 1.2.1 by updateCounterpartyUrl
Add Address to CustomerAdd an Address to the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by createCustomerAddress
Add Social Media HandleAdd a social media handle for the customer specified by CUSTOMER_ID. Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.0.0 by addSocialMediaHandle
Add Tax Residence to CustomerAdd a Tax Residence to the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by createTaxResidence
Create Customer.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. Authentication is Mandatory Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.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:
Implmented in 2.0.0 by createUserCustomerLinks
Delete Customer AddressDelete an Address of the Customer specified by CUSTOMER_ADDRESS_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by deleteCustomerAddress
Delete Tax ResidenceDelete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by deleteTaxResidence
Delete User AuthContextDelete a User AuthContext of the User specified by USER_AUTH_CONTEXT_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by deleteUserAuthContextById
Delete User's Auth ContextsDelete the Auth Contexts of a User specified by USER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by deleteUserAuthContexts
Get CRM EventsTypical Successful Response:
Headers:
Possible Errors:
Implmented in 1.4.0 by getCrmEvents
Get Customer AddressesGet the Addresses of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCustomerAddresses
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:
Implmented in 2.0.0 by getSocialMediaHandles
Get Customer by CUSTOMER_IDGets the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCustomerByCustomerId
Get Customer by CUSTOMER_NUMBERGets the Customer specified by CUSTOMER_NUMBER. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getCustomerByCustomerNumber
Get Customers for Current UserGets all Customers that are linked to a User. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by getCustomersForUser
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:
Implmented in 2.1.0 by getCustomersForCurrentUserAtBank
Get Tax Residences of CustomerGet the Tax Residences of the Customer specified by CUSTOMER_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by getTaxResidence
Update the Address of an CustomerUpdate an Address of the Customer specified by CUSTOMER_ADDRESS_ID. Authentication is Mandatory Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.1.0 by updateCustomerAddress
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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.0.0 by getMeetings
Add Customer Message.Add a message for the customer specified by CUSTOMER_ID Typical Successful Response:
Headers:
Possible Errors:
Implmented in 1.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:
Implmented in 1.4.0 by getCustomerMessages
Data Warehouse SearchSearch the data warehouse and get row level results. Authentication is Mandatory CanSearchWarehouse entitlement is required. You can request the Role below. Elastic (search) is used in the background. See links below for syntax. Examples of usage: POST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE POST /search/warehouse/INDEX1,INDEX2 POST /search/warehouse/ALL { Any valid elasticsearch query DSL in the body } Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.0 by dataWarehouseSearch
Data Warehouse StatisticsSearch the data warehouse and get statistical aggregations over a warehouse field Does a stats aggregation over some numeric field: Authentication is Mandatory CanSearchWarehouseStats Role is required. You can request this below. Elastic (search) is used in the background. See links below for syntax. Examples of usage: POST /search/warehouse/statistics/INDEX/FIELD POST /search/warehouse/statistics/ALL/FIELD { Any valid elasticsearch query DSL in the body } Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 3.0.0 by dataWarehouseStatistics
Get API GlossaryReturns the glossary of the API Typical Successful Response:
Headers:
Possible Errors:
Implmented in 3.0.0 by glossary
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:
Implmented in 2.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:
Implmented in 1.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:
Implmented in 1.4.0 by getResourceDocsSwagger
Create FxCreate or Update Fx for the Bank. Authentication is Mandatory OBP-20006: User is missing one or more roles: CanCreateFxRate OR CanCreateFxRateAtAnyBank Typical Successful Response:
Headers:
Required Roles:
Possible Errors:
Implmented in 2.2.0 by createFx
Get Current FxRateGet the latest FXRate specified by BANK_ID, FROM_CURRENCY_CODE and TO_CURRENCY_CODE Typical Successful Response:
Headers:
Possible Errors:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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:
Implmented in 2.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 |