Glossary
482 entries. Searching covers entry bodies, not just titles.
- ABAC_Account_Access_Enforcement ABAC Account Access Enforcement How OBP decides whether the ABAC subsystem grants account access at runtime, and how that's kept separate from rule management. For writing rules, see ABACSimpleGuide…
- ABAC_Object_Properties_Reference ABAC Object Properties Reference This document lists all properties available on objects passed to ABAC rules. User Object Available as: authenticatedUser, user, onBehalfOfUserOpt.get Core Properties…
- ABAC_Parameters_Summary ABAC Rule Parameters Summary The ABAC Rules Engine provides 18 parameters to your rule function, organized into three categories: User Parameters (6 parameters) 1. authenticatedUser: User - The…
- ABAC_Simple_Guide ABAC Rules Engine - Simple Guide Overview The ABAC (Attribute-Based Access Control) Rules Engine allows you to create dynamic access control rules in Scala that evaluate whether a user should have…
- ABAC_Testing_Examples ABAC Testing Examples API Endpoint Example 1: Admin Only Rule Rule Code: Test Request: Expected Result: Admin user → {"result": true} Regular user → {"result": false} Example 2: Account Owner Check…
- accessibility_features Example value: ["ATAC","ATAD"] Description: no-description-provided
- Account The thing that tokens of value (money) come in and out of. An account has one or more owners which are Users. In the future, Customers may also be owners. An account has a balance in a specified…
- Account Access Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between the User and the View Definition. A User must have at least one Account Access record record in order…
- Account.account_id An identifier for the account that MUST NOT leak the account number or other identifier normally used by the customer or bank staff. ### Format accountid MUST be a UUID. The MUST is deliberate: a…
- Account.account_routing_address Example value: DE91 1000 0000 0123 4567 89 Description: An identifier that conforms to accountroutingscheme / accountRoutingScheme
- Account.account_routing_scheme Example value: IBAN Description: The scheme that the accountroutingaddress / accountRoutingAddress is an example of.
- Account.account_routings A list of routing entries that identify the account on external rails (IBAN, account number, mobile-money MSISDN, etc.) and on OBP itself. Each entry has two fields: scheme — the name of the routing…
- Account.iban Example value: DE91 1000 0000 0123 4567 89 Description: MUST uniquely identify the bank account globally.
- Account.owner Example value: SusanSmith Description: A username that is the owner of the account.
- Account.queryTagsExample Example value: Card,Debit Description: This field is only used for OBP to distinguish the debit accounts, card accounts ...
- active Example value: false Description: no-description-provided
- actual_date Example value: 2020-01-27 Description: no-description-provided
- Adapter Adapter In OBP, an Adapter is an out of process component that sits between OBP and a bank's systems of record (Core Banking System, Payment System, or database) and translates between them. An…
- Adapter.Akka.Intro ## Use Akka as an interface between OBP and your Core Banking System (CBS). For an introduction to Akka see here The OBP Akka interface allows integrators to write Java or Scala Adapters (any JVM…
- Adapter.authInfo authInfo is a JSON object sent by the Connector to the Adapter so the Adapter and/or Core Banking System can identify the User making the call. The authInfo object contains several optional objects…
- Adapter.brand Example value: SusanSmith Description: The name on the physical card
- Adapter.card_attribute_id Example value: b4e0352a-9a0f-4bfa-b30b-9003aa467f50 Description: A string that MUST uniquely identify the card attribute on this OBP instance. It SHOULD be a UUID.
- Adapter.card_attribute_name Example value: OVERDRAFTSTARTDATE Description: The Card attribute name
- Adapter.card_attribute_value Example value: 2012-04-23 Description: The card attribute values
- Adapter.card_id Example value: 36f8a9e6-c2b1-407a-8bd0-421b7119307e Description: A string that MUST uniquely identify the card on this OBP instance. It SHOULD be a UUID.
- Adapter.card_number Example value: 364435172576215 Description: The number of the physical card
- Adapter.card_type Example value: Credit Description: The type of the physical card. eg: credit, debit ...
- Adapter.cbsToken Example value: FYIUYF6SUYFSD Description: A token provided by the Gateway for use by the Core Banking System
- Adapter.cvv Example value: SusanSmith Description: The name on the physical card
- Adapter.expiry_month Example value: 01 Description: The expiry month of the card
- Adapter.expiry_year Example value: 2023 Description: The expiry year of the card
- Adapter.issue_number Example value: 1 Description: The issue number of the physical card, eg 1,2,3,4 ....
- Adapter.key Example value: CustomerNumber Description: This key should be used with Adapter.value together. They are a pair.
- Adapter.limit Example value: 100 Description: The limit in pagination
- Adapter.name_on_card Example value: SusanSmith Description: The name on the physical card
- Adapter.offset Example value: 100 Description: The offset in pagination
- Adapter.provider_id Example value: Chris Description: The provider id of the user which is equivalent to the username. Used in combination with the provider name (host) to uniquely identify a User on OBP.
- Adapter.serial_number Example value: 1324234 Description: The serial number of the physical card, eg 1123.
- Adapter.Stored_Procedure.Intro ## Use StoredProcedure as an interface between OBP and your Core Banking System (CBS). For an introduction to Stored Procedures see here ### Installation Prerequisites You have OBP-API running and it…
- Adapter.value Example value: 5987953 Description: This key should be used with Adapter.key together. They are a pair.
- Adaptive authentication Adaptive authentication, also known as risk-based authentication, is dynamic in a way it automatically triggers additional authentication factors, usually via MFA factors, depending on a user's risk…
- Age The user Age
- Agent.agent_id Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A non human friendly string that identifies the agent and is used in URLs. This SHOULD NOT be the agent number. The combination of…
- Agent.agent_number Example value: 5987953 Description: The human friendly agent identifier that MUST uniquely identify the Agent at the Bank ID. Agent Number is NOT used in URLs.
- allowed_attempts Example value: 5 Description: no-description-provided
- allows Example value: [credit,debit,cashwithdrawal] Description: The actions of the card.
- API The terms API (Application Programming Interface) and Endpoint are used somewhat interchangeably. However, an API normally refers to a group of Endpoints. An endpoint has a unique URL path and HTTP…
- API Collection An API Collection is a collection of endpoints grouped together for a certain purpose. Having read access to a Collection does not constitute execute access on the endpoints in the Collection.…
- API Metrics # API Metrics API Metrics are OBP-API's record of the calls made to it: one record for every API call, saying who made the call, which endpoint it reached, when, how long it took and what status it…
- API Product Subscription An API Product Subscription records that one Consumer (the subscriber) holds one API Product for a period, with a status. The API Product describes the plan: which endpoints (its API Collection), how…
- API Tag All OBP API relevant docs, eg: API configuration, JSON Web Key, Adapter Info, Rate Limiting
- API-Explorer-II-Help ## API Explorer II - How to Use API Explorer II is an interactive Swagger/OpenAPI interface for discovering and testing OBP and other standard endpoints. ### Key Features Browse and search all…
- API.Access Control Access Control is achieved via the following mechanisms in OBP: APIs are enabled in Props. See the README.md Consumers (AKA Clients or Apps) are granted access to Roles and Views via Scopes See here…
- API.correlation_id Example value: 1flssoftxq0cr1nssr68u0mioj Description: A string generated by OBP-API that MUST uniquely identify the API call received by OBP-API. Used for debugging and logging purposes. It is…
- API.Endpoint Auth Modes Each API endpoint has an authMode that determines how Roles are checked when both a User and a Consumer (Application) are present in the request. The four auth modes are: UserOnly (default): Only the…
- API.Interfaces
- API.Timeouts
- ApiCollection.apiCollectionId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A string that MUST uniquely identify the session on this OBP instance, can be used in all cache.
- ApiCollection.apiCollectionName Example value: Favourites Description: Name of the ApiCollection
- ApiCollectionEndpoint.apiCollectionEndpointId Example value: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A string that MUST uniquely identify the session on this OBP instance, can be used in all cache.
- ApiCollectionEndpoint.operationId Example value: OBPv6.0.0-getBanks Description: A uniquely identify the obp endpoint on OBP instance, you can get it from Get Resource endpoints.
- app_name Example value: appNameBank Description: no-description-provided
- app_type Example value: Web Description: no-description-provided
- Asset Asset An Asset is a unit that amounts can be held in: a currency such as EUR, a precious metal such as gold (XAU), an accounting unit such as the IMF's Special Drawing Right (XDR), a crypto asset…
- atm_id Example value: atme-9a0f-4bfa-b30b-9003aa467f51 Description: A string that MUST uniquely identify the ATM on this OBP instance.
- ATM.attribute_id Example value: atme-9a0f-4bfa-b30b-9003aa467f51 Description: A string that MUST uniquely identify the ATM on this OBP instance.
- ATM.cash_withdrawal_international_fee Example value: Description: no-description-provided
- ATM.has_deposit_capability Example value: false Description: no-description-provided
- ATM.is_accessible Example value: false Description: no-description-provided
- ATM.location_categories Example value: ["ATBI","ATBE"] Description: no-description-provided
- ATM.minimum_withdrawal Example value: 5 Description: minimum withdrawal at this ATM
- ATM.name Example value: Atm by the Lake Description: The name of the ATM
- ATM.notes Example value: ["String1","String2"] Description: no-description-provided
- ATM.services Example value: ["ATBP","ATBA"] Description: no-description-provided
- Attribute.name Example value: STATUS Description: Transaction attribute name
- Attribute.type Example value: STRING Description: Transaction attribute type.
- Attribute.value Example value: closed Description: Transaction attribute value.
- attributes Example value: attribute value in form of (name, value) Description: no-description-provided
- Authentication Authentication generally refers to a set of processes which result in a resource server (in this case, OBP-API) knowing about the User and/or Application that is making the http request it receives.…
- Authentication Device (AD) The device on which the user will authenticate and authorize the request, often a smartphone.
- Authentication: Consent OBP Flow Example 1) Call endpoint Create Consent Request using application access (Client Credentials) Url: https://k8s.openbankproject.com/obp/v5.0.0/consumer/consent-requests Post body: Output: 2) Call endpoint…
- Authentication: Credential Checking Flow ### Overview OBP supports both local and external credential checking. Local credentials are verified against the AuthUser table (bcrypt). External credentials are delegated to a core banking system…
- Authentication: Direct Login Direct Login is a simple authentication process for trusted environments and testing. Step 1: Get your Consumer Key Read the registration instructions at…
- Authentication: Gateway Login Note: Gateway Login is NOT enabled on this instance! Gateway Login allows a gateway (e.g. API Gateway) to authenticate on behalf of a user. The gateway sends a JWT in the Authorization header. The…
- Authentication: OAuth 2 OAuth2 is allowed on this instance. OAuth2 / OpenID Connect (OIDC) is the recommended authentication method for production use. OBP supports the OAuth2 Authorization Code flow for user-facing…
- Authentication: OAuth 2.0 OAuth 2.0, is a framework, specified by the IETF in RFCs 6749 and 6750 (published in 2012) designed to support the development of authentication and authorization protocols. It provides a variety of…
- Authentication: OAuth2 / OIDC Client Credentials OAuth2 / OpenID Connect (OIDC) is the recommended authentication method for production use. OBP supports the OAuth2 Authorization Code flow for user-facing applications and the Client Credentials…
- Authentication.provider Example value: http://127.0.0.1:8080 Description: The host name of an Identity Provider authenticating a User. OBP allows the use of multiple simultanious authentication providers. The provider name…
- Authorization If Authentication involves the process of determining the identity of a user or application, Authorization involves the process of determining what the user or application can do. In OBP, Endpoints…
- Available FAPI profiles The following are the FAPI profiles which are either in use by multiple implementers or which are being actively developed by the OpenID Foundation’s FAPI working group: FAPI 1 Implementers Draft 6…
- balance Example value: 10 Description: no-description-provided
- balance_id Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A string that MUST uniquely identify the Account Balance on this OBP instance, can be used in all cache.
- balance_type Example value: openingBooked Description: The balance type.
- Bank A Bank (aka Space) represents a financial institution, brand or organizational unit under which resources such as endpoints and entities exist. Both standard entities (e.g. financial products and…
- bank_code Example value: CGHZ Description: no-description-provided
- bank_routings Example value: bank routing in form of (scheme, address) Description: no-description-provided
- Bank.bank_id An identifier that uniquely identifies the bank or financial institution on the OBP-API instance. ### Format bankid SHOULD be of the form - — a short, readable prefix that names the institution,…
- Bank.bank_routing_address Example value: GENODEM1GLS Description: An identifier that conforms to bankroutingscheme / bankRoutingScheme
- Bank.bank_routing_scheme Example value: BIC Description: The scheme that the bankroutingaddress / bankRoutingAddress is an example of.
- Bank.bank_routings A list of routing entries that identify the bank on external rails (BIC/SWIFT, national bank codes, etc.) and on OBP itself. Each entry has two fields: scheme — the name of the routing scheme, e.g.…
- Berlin Group Consent Settings OBP provides configuration options for Berlin Group consent creation and SCA (Strong Customer Authentication) flows. ## Frequency Per Day Limit berlingroupfrequencyperdayupperlimit - Maximum allowed…
- Berlin Group Mandatory Headers OBP validates mandatory HTTP request headers for Berlin Group (NextGenPSD2) API endpoints. When a request targets a Berlin Group endpoint (identified by the Berlin Group URL prefix), OBP checks for…
- Berlin Group Response Formatting OBP provides several configuration options to control how Berlin Group API responses are formatted. ## Account Name Visibility BGv1312showaccountname - Boolean flag that controls whether the name…
- Berlin Group Transaction and Consent Lifecycle OBP provides background schedulers that automatically manage the lifecycle of Berlin Group transactions and consents. ## Outdated Transactions Berlin Group payment transactions with status "received"…
- Berlin Group URL and Path Configuration OBP allows customization of the URL paths used for Berlin Group (NextGenPSD2) API endpoints. ## Canonical Path berlingroupversion1canonicalpath - Overrides the version segment of the Berlin Group v1…
- bic Example value: BUKBGB22 Description: The Business Identifier Code
- Branch The bank branches, it contains the address, location, lobby, driveup of the Branch.
- Branch.branch_id Example value: DERBY6 Description: Uniquely identifies the Branch in combination with the bankId.
- Branch.branch_routing_address Example value: DERBY6 Description: An address that conforms to branchroutingscheme / branchRoutingScheme
- Branch.branch_routing_scheme Example value: BRANCH-CODE Description: The scheme that the branchroutingaddress / branchRoutingAddress is an example of.
- calls_made Example value: 50 Description: no-description-provided
- can_add_counterparty Example value: false Description: A View permission. If true, a User with this View can create a Counterparty for the Account.
- can_add_image_url Example value: false Description: A View permission. If true, a User with this View can add an image URL to a Transaction.
- can_add_more_info Example value: false Description: A View permission. If true, a User with this View can add the more-info note to a Transaction.
- can_add_tag Example value: false Description: A View permission. If true, a User with this View can add a tag to a Transaction.
- can_add_transaction_request_to_own_account Example value: false Description: A View permission. If true, a User with this View can create a Transaction Request from the Account to another account held by the same User.
- can_be_seen_on_views Example value: false Description: The Views on which the attributes of an Attribute Definition can be seen, as a list of view ids. Set on the Attribute Definition itself, so despite the name this is…
- can_create_direct_debit Example value: false Description: A View permission. If true, a User with this View can create a Direct Debit on the Account.
- can_delete_corporate_location Example value: false Description: A View permission. If true, a User with this View can delete the corporate location on a Transaction.
- can_delete_image Example value: false Description: A View permission. If true, a User with this View can delete an image attached to a Transaction.
- can_delete_where_tag Example value: false Description: A View permission. If true, a User with this View can delete the where tag on a Transaction.
- can_edit_owner_comment Example value: false Description: A View permission. If true, a User with this View can edit the owner comment on a Transaction.
- can_query_available_funds Example value: false Description: A View permission. If true, a User with this View can check whether funds are available on the Account.
- can_see_bank_account_bank_name Example value: false Description: A View permission. If true, a User with this View can see the name of the Bank that holds the Account.
- can_see_bank_account_credit_limit Example value: false Description: A View permission. If true, a User with this View can see the credit limit of the Account.
- can_see_bank_account_label Example value: false Description: A View permission. If true, a User with this View can see the label of the Account.
- can_see_bank_account_number Example value: false Description: A View permission. If true, a User with this View can see the account number of the Account.
- can_see_bank_account_owners Example value: false Description: A View permission. If true, a User with this View can see the owners of the Account.
- can_see_bank_routing_address Example value: false Description: A View permission. If true, a User with this View can see the routing address of the Bank that holds the Account.
- can_see_corporate_location Example value: false Description: A View permission. If true, a User with this View can see the corporate location recorded on a Transaction.
- can_see_image_url Example value: false Description: A View permission. If true, a User with this View can see the URL of an image attached to a Transaction.
- can_see_images Example value: false Description: A View permission. If true, a User with this View can see the images attached to a Transaction.
- can_see_other_account_national_identifier Example value: false Description: A View permission. If true, a User with this View can see the national identifier of the Other Account, the counterparty side of a Transaction.
- can_see_other_account_number Example value: false Description: A View permission. If true, a User with this View can see the account number of the Other Account, the counterparty side of a Transaction.
- can_see_other_account_routing_address Example value: false Description: A View permission. If true, a User with this View can see the routing address of the Other Account, the counterparty side of a Transaction.
- can_see_other_account_swift_bic Example value: false Description: A View permission. If true, a User with this View can see the SWIFT / BIC of the Other Account, the counterparty side of a Transaction.
- can_see_transaction_amount Example value: false Description: A View permission. If true, a User with this View can see the amount of a Transaction on the Account.
- can_see_transaction_description Example value: false Description: A View permission. If true, a User with this View can see the description of a Transaction on the Account.
- can_see_url Example value: false Description: A View permission. If true, a User with this View can see the URL held in the metadata of a Transaction.
- can_see_where_tag Example value: false Description: A View permission. If true, a User with this View can see the where tag, the geolocation recorded by a User, on a Transaction.
- cancelled Example value: false Description: no-description-provided
- certificate_authority_ca_owner_id Example value: CYCBC Description: The certificate authority owner ID.
- ChallengeAnswer.challengeId Example value: 123chaneid13-6d02-40e3-a129-0b2bf89de9f0 Description: MUST uniquely identify the challenge globally.
- ChallengeAnswer.hashOfSuppliedAnswer Example value: a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3 Description: Sha256 hash value of the ChallengeAnswer.challengeId
- ChallengeAnswer.suppliedAnswerExample Example value: 123456 Description: The value of the ChallengeAnswer.challengeId
- Chat # Chat OBP provides a built-in Chat / Messaging API that allows users and applications to communicate within the platform. Chat is the persistent, human-facing side of messaging: rooms, threads,…
- Chat Room # Chat Room A Chat Room is a named space where users and consumers (apps/bots) exchange messages. Each room is either system-level or scoped to a single bank. See also the broader Chat entry, which…
- Cheat Sheet ### A selection of links to get you started using the Open Bank Project API platform, applications and tools. OBP API Installation OBP API Contributing Access Control Versioning Authentication…
- CIBA An acronym for Client-Initiated Backchannel Authentication. For more details about it please take a look at the official specification: OpenID Connect Client Initiated Backchannel Authentication Flow…
- Client IP Address # Client IP Address The Client IP Address is the address of the person or program that really made a call, as opposed to the address of whatever passed the call on to OBP-API. OBP-API uses it for…
- client_id (Client ID) Please see Consumer.consumerkey
- closing_time Example value: 2020-01-27 Description: no-description-provided
- code Example value: 125 Description: no-description-provided
- collected Example value: 2020-01-27 Description: no-description-provided
- company Example value: Tesobe GmbH Description: The company name
- completed Example value: 2020-01-27 Description: no-description-provided
- Connector In OBP, most internal functions / methods can have different implementations which follow the same interface. These functions are called connector methods and their implementations. The default…
- Connector Method Developers can override all the existing Connector methods. This function needs to be used together with the Method Routing. When we set "connector = internal", then the developer can call their own…
- Connector Metrics # Connector Metrics Connector Metrics are OBP-API's record of the calls it makes to the Connector, the component that talks to the bank's systems: one record for every Connector call. A single API…
- Connector.User.Authentication ### Overview The property connector.user.authentication (default: false) controls whether OBP can authenticate a user via the Connector when they are not found locally. OBP always checks for users…
- ConnectorMethod.connectorMethodId Example value: ace0352a-9a0f-4bfa-b30b-9003aa467f51 Description: A string that MUST uniquely identify the connector method on this OBP instance, can be used in all cache.
- Consent Consents provide a mechanism through which a resource owner (e.g. a customer) can grant a third party certain access to their resources. The following are important considerations in Consent flows:…
- Consent_Account_Onboarding Consent, or Account onboarding, is the process by which the account owner gives permission for their account(s) to be accessible to the API endpoints. In OBP, the account, transaction and payment…
- consent_id Example value: 9d429899-24f5-42c8-8565-943ffa6a7947 Description: no-description-provided
- consent_reference_id Example value: fd13b9af-4f74-4d52-a7f1-7c2c12f3aa11 Description: no-description-provided
- consent_request_id Example value: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0 Description: A string that MUST uniquely identify the Consent Request on this OBP instance.
- Consumer The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on behalf of the end user (or system). Each Consumer has a consumer key and secret which allows it to…
- Consumer Account Access Consumer Account Access OBP has two layers of permission. Roles say which endpoints may be called; they are granted to a User as Entitlements and to a Consumer as Scopes. Account access says which…
- Consumer, Consent, Transport and Payload Security Consumer, Consent, Transport and Payload Security with MTLS and JWS This glossary item aims to give an overview of how the communication between an Application and the OBP API server is secured with…
- Consumer.consumer_key (Consumer Key) The client identifier issued to the client during the registration process. It is a unique string representing the registration information provided by the client. The name consumerkey is historical…
- Consumption Device (CD) The Consumption Device is the device that helps the user consume the service. In the CIBA) use case, the user is not necessarily in control of the CD. For example, the CD may be in the control of an…
- conversion_value Example value: 100 Description: no-description-provided
- corporate_location Example value: 10 Description: no-description-provided
- Counterparties In OBP, there are two types of Counterparty: Explicit Counterparties are created by calling an OBP endpoint - mainly for the purpose of creating a payment or variable recurring payments (VRPs) via…
- counterparty_limit_id Example value: abc9a7e4-6d02-40e3-a129-0b2bf89de9b1 Description: A string that MUST uniquely identify the Counterparty Limit on this OBP instance.
- Counterparty-Limits Counterparty Limits can be used to restrict payment (Transaction Request) amounts and frequencies (per month, year, total) that can be made to a Counterparty (Beneficiary). Counterparty Limits can be…
- Counterparty.counterpartyId Example value: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: The Counterparty ID used in URLs. This SHOULD NOT be a name of a Counterparty.
- Counterparty.counterpartyName Example value: John Smith Ltd. Description: The name of a Counterparty. Ideally unique for an Account
- Counterparty.isBeneficiary Example value: false Description: This is a boolean. True if the originAccount can send money to the Counterparty
- country Example value: Germany Description: The country name
- country_code Example value: 1254 Description: no-description-provided
- CRL Certificate Revocation List. CRL issuers issue CRLs. The CRL issuer is either the CA (certification authority) or an entity that has been authorized by the CA to issue CRLs. CAs publish CRLs to…
- Cross-Device Authorization Cross-device authorization flows enable a user to initiate an authorization flow on one device (the Consumption Device) and then use a second, personally trusted, device (Authorization Device) to…
- Customer The legal entity that has the relationship to the bank. Customers are linked to Users via User Customer Links. Customer attributes include Date of Birth, Customer Number etc.
- Customer.attributeAlias Example value: STRING Description: Customer attribute alias.
- Customer.attributeId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: Customer attribute id
- Customer.attributeName Example value: SPECIALTAXNUMBER Description: Customer attribute name
- Customer.attributeType Example value: STRING Description: Customer attribute type.
- Customer.attributeValue Example value: 123456789 Description: Customer attribute value.
- Customer.consumerId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A non human friendly string that identifies the consumer. It is the app which calls the apis
- Customer.Credit.rating Example value: Description: .
- Customer.Credit.source Example value: Description: .
- Customer.customer_id The identifier that MUST NOT leak the customer number or other identifier normally used by the customer or bank staff. It SHOULD be a UUID and MUST be unique in combination with BANKID. Example…
- Customer.customerAccountLinkId Example value: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A non human friendly string that identifies the Customer Account Link and is used in URLs.
- Customer.customerAttributeId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A non human friendly string that identifies the customer attribute and is used in URLs.
- Customer.customerAttributeName Example value: SPECIALTAXNUMBER Description: The Customer Attribute name, eg: SPECIALTAXNUMBER
- Customer.customerAttributeType Example value: STRING Description: It can be one of STRING(TAXNUMBER), INTEGER(123), DOUBLE(12.1234), DECIMAL(1234.5678), BOOLEAN(true) and DATEWITHDAY(2012-04-23)
- Customer.customerAttributeValue Example value: 123456789 Description: The Customer Attribute value of the current attribute type, eg: 123456789.
- Customer.customerId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A non human friendly string that identifies the customer and is used in URLs. This SHOULD NOT be the customer number. The combination…
- Customer.customerNumber Example value: 5987953 Description: The human friendly customer identifier that MUST uniquely identify the Customer at the Bank ID. Customer Number is NOT used in URLs.
- Customer.customerType Example value: INDIVIDUAL Description: Type of customer: INDIVIDUAL, CORPORATE, or SUBSIDIARY
- Customer.dependants Example value: 1 Description: the number of dependants
- Customer.dependents Example value: 2 Description: the number of dependents
- Customer.employmentStatus Example value: worker Description: employment status
- Customer.highestEducationAttained Example value: Master Description: highest education attained
- Customer.key Example value: bwf0ykmwoirip1yjxcn15wnhuyxcziwgtcoaildq Description: This key should be used with Adapter.value together. They are a pair.
- Customer.kycStatus Example value: false Description: This is boolean to indicate if the cusomter's KYC has been checked.
- Customer.legalName Example value: Eveline Tripman Description: The legal name of the Customer.
- Customer.mobileNumber Example value: +44 07972 444 876 Description: The mobile number name of the Customer.
- Customer.nameSuffix Example value: Sr Description: suffix of the name
- Customer.parentCustomerId Example value: Description: The customerid of the parent customer in a corporate hierarchy, empty if none
- Customer.relationshipStatus Example value: single Description: relationship status
- Customer.relationshipType Example value: Owner Description: Relationship between two parties.
- Customer.secret Example value: xwdgylv3vau0n2gkxu1aize4glapftfldp5y1bic Description: This key should be used with Adapter.value together. They are a pair.
- Customer.title Example value: Dr. Description: title of the name
- Customer.url Example value: http://www.example.com/id-docs/123/image.png Description: The URL
- CustomerMessage.id Example value: 5995d6a2-01b3-423c-a173-5481df49bdaf Description: A string that, in combination with the bankId MUST uniquely identify the customer message on this OBP instance
- Data Model Overview An overview of the Open Bank Project Data Model. This diagram may help in understanding the Open Bank Project entities, capabilities and concepts. However, it is subject to change. If we change the…
- data.bankid Example value: Description: no-description-provided
- Database Connection Hold Warnings # Database Connection Hold Warnings OBP-API keeps a pool of database connections that requests share. A request takes a connection, uses it and gives it back. When work keeps a connection for a long…
- date_of_application Example value: 2020-01-27 Description: no-description-provided
- DAuth ### DAuth Introduction, Setup and Usage DAuth is an experimental authentication mechanism that aims to pin an ethereum or other blockchain Smart Contract to an OBP "User". In the future, it might be…
- description Example value: Description of the object. Maximum length is 2000. It can be any characters here. Description: The human readable description here.
- dob_of_dependants Example value: [2019-09-08, 2017-07-12] Description: no-description-provided
- Domain APIs Domain APIs A Domain API publishes the Dynamic Entities and Dynamic Resource Docs (Dynamic Queries included) of one space under a base path of its own, so that an API built on OBP can be offered…
- Dummy Customer Logins The following dummy Customer Logins may be used by developers testing their applications on this sandbox: #customer-logins
- duration Example value: 5.123 Description: This is a decimal number in seconds, eg: 1 for 1 second, 0.001 for 1 ms
- duration_time Example value: 60 Description: no-description-provided
- Dynamic Change Request A Dynamic Change Request is a proposed create, update or delete of a runtime-defined artefact that carries code or configuration - a here, a here, a here or an ABAC Rule - held for approval by a…
- Dynamic Code Paths OBP offers several building blocks for defining API behaviour at runtime - stored in the OBP database as instance configuration rather than compiled into the source code. This item explains how they…
- Dynamic Endpoint Manage If you want to create endpoints from Swagger / Open API specification files, use Dynamic Endpoints. We use the term "Dynamic" because these Endpoints persist in the OBP database and are served from…
- Dynamic Entity Webhooks Dynamic Entity Webhooks A Dynamic Entity webhook makes OBP send a POST request to a URL when records of one Dynamic Entity (here) are created, updated or deleted, so that a system outside OBP learns…
- Dynamic linking (PSD2 context) Dynamic linking is a security requirement under PSD2's Strong Customer Authentication (SCA) rules. When a payer initiates an electronic payment transaction, the authentication code must be…
- Dynamic Message Doc In OBP we represent messages sent by a Connector method / function as MessageDocs. A MessageDoc defines the message the Connector sends to an Adapter and the response it expects from the Adapter.…
- Dynamic Query A Dynamic Query is a here whose body is a declaration rather than code: its programminglang is Query. It reads the records of one Dynamic Entity, adds the records joined to them through reference:…
- Dynamic Resource Doc A Dynamic Resource Doc defines a single Endpoint at runtime: its verb, URL path, summary, description, example request and response bodies, error list, tags and Roles - plus a method body written in…
- Dynamic Resource Doc Introduction In OBP we largely define our endpoints using an internal case class or model called ResourceDoc Using this endpoint, developers can create their own Resource Docs at run time thus creating fully…
- Dynamic-Entities Dynamic Entities allow you to create custom data structures and their corresponding CRUD endpoints at runtime without writing code or restarting the OBP-API instance. Overview: Dynamic Entities…
- Dynamic-Entity-Access-Model A Dynamic Entity definition carries six access flags. Together they decide who may create, read, edit and delete rows, and through which route. This page is the reference; the flags are set in the…
- Dynamic-Entity-Intro Dynamic Entities can be used to store and retrieve custom data objects (think your own tables and fields) in the OBP instance. You can define your own Dynamic Entities or use Dynamic Entities created…
- DynamicConnectorMethod.lang Example value: Scala Description: the programming language of OBP connector method body.
- DynamicConnectorMethod.methodBody.Java Example value:…
- DynamicConnectorMethod.methodBody.Js Example value:…
- DynamicConnectorMethod.methodBody.scala Example value:…
- DynamicResourceDoc.description Example value: Create one User Description: the description for this endpoint
- DynamicResourceDoc.dynamicResourceDocId Example value: vce035ca-9a0f-4bfa-b30b-9003aa467f51 Description: A string that MUST uniquely identify the dynamic Resource Doc on this OBP instance, can be used in all cache.
- DynamicResourceDoc.errorResponseBodies Example value: OBP-50000: Unknown Error.,OBP-20001: User not logged in. Authentication is required!,OBP-20006: User is missing one or more roles: ,OBP-10001: Incorrect json format. Description: The…
- DynamicResourceDoc.exampleRequestBody Example value: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optionalfields": ["hobby"]} Description: the json string of the request body.
- DynamicResourceDoc.isFeatured Example value: false Description: if this is featured or not
- DynamicResourceDoc.methodBody Example value:…
- DynamicResourceDoc.partialFunctionName Example value: createUser Description: partial function name
- DynamicResourceDoc.requestUrl Example value: /myuser/MYUSERID Description: The URL of the endpoint.
- DynamicResourceDoc.requestVerb Example value: POST Description: This is the HTTP methods, eg: GET, POST, PUT, DELETE
- DynamicResourceDoc.successResponseBody Example value: {"myuserid": "someidvalue", "name": "Jhon", "age": 12, "hobby": ["coding"],"optionalfields": ["hobby"]} Description: the json string of the success response body.
- DynamicResourceDoc.summary Example value: Create My User Description: The summary of this endpoint
- Echo Request Headers Question: How can I see the request headers that OBP API finally receives from a REST client after the request has passed through HTTP infrastructure such as load balancers, firewalls and proxies?…
- effective_date Example value: 2020-01-27 Description: no-description-provided
- Email Validation for OBP Local Users ### Overview When a new OBP local user is created, they may be required to validate their email address before they can log in. This is controlled by the authUser.skipEmailValidation property…
- enabled Example value: false Description: no-description-provided
- Endpoint The terms Endpoint and API (Application Programming Interface) are used somewhat interchangeably. However, an Endpoint is a specific URL defined by its path (eg. /obp/v4.0/root) and its http verb…
- Endpoint Mapping Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic Entity fields. This document assumes you already have some knowledge of OBP Dynamic Endpoints and…
- EndpointTag.endpointTagId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A string that MUST uniquely identify the endpointTag on this OBP instance, can be used in all cache.
- EndpointTag.tagName Example value: BankAccountTag1 Description: The endpoint tag name
- entity_address Example value: EXAMPLE COMPANY LTD, 5 SOME STREET Description: The address of the entity.
- entity_certificate_public_key Example value:…
- entity_code Example value: PSDPICYCBC!12345 Description: The code of the entity.
- entity_country Example value: CY Description: The country of the entity.
- entity_id Example value: 0af807d7-3c39-43ef-9712-82bcfde1b9ca Description: A unique identifier for the entity.
- entity_name Example value: EXAMPLE COMPANY LTD Description: The name of the entity.
- entity_post_code Example value: 1060 Description: The postal code of the entity.
- entity_town_city Example value: SOME CITY Description: The town or city of the entity.
- entity_type Example value: PSDPI Description: The type of the entity.
- entity_web_site Example value: www.example.com Description: The website of the entity.
- example_inbound_message Example value: {} Description: This is the json object.
- example_outbound_message Example value: {} Description: this will the json object
- execution_date Example value: 2020-01-27 Description: no-description-provided
- FAPI An acronym for Financial-grade API.
- FAPI 1.0 The Financial-grade API is a highly secured OAuth profile that aims to provide specific implementation guidelines for security and interoperability. The Financial-grade API security profile can be…
- FAPI 2.0 FAPI 2.0 has a broader scope than FAPI 1.0. It aims for complete interoperability at the interface between client and authorization server as well as interoperable security mechanisms at the…
- FeaturedApiCollection.featuredApiCollectionId Example value: 9uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: A string that uniquely identifies this featured API collection entry.
- FeaturedApiCollection.sortOrder Example value: 1 Description: The sort order for displaying featured API collections. Lower numbers appear first.
- Files Files A File is a document such as a PDF or a photograph, stored in a space: a bank, or SYS for the system space. A file can be attached to records, such as a Customer or a Dynamic Entity record, and…
- first_name Example value: Tom Description: The first name
- frequency Example value: DAILY Description: no-description-provided
- from_date Example value: 1100-01-01T01:01:01.000Z Description: The TimeStamp in the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
- from_department Example value: Open Bank Description: The department of the sender
- from_person Example value: Tom Description: The name of the sender
- full_name Example value: full name string Description: no-description-provided
- future_date Example value: 20200127 Description: no-description-provided
- FX-Rates You can use the following endpoint to get the FX Rates available on this OBP instance: Get FX Rates
- Groups Groups A Group is a named list of Roles at one bank id (or at system level), used to give the same Roles to many Users. A Group has a name, a description, its list of Roles, and whether it is…
- Hello AI Agents # Hello AI Agents You are an autonomous agent that has just been pointed at an Open Bank Project instance. This Item is the entry point: what to read, how to get credentials without anyone creating…
- hide_metadata_if_alias_used Example value: false Description: no-description-provided
- Hola App log trace Please see: OBP Hola App Log Trace
- How OpenID Connect Works The OpenID Connect protocol, in abstract, follows these steps: End user navigates to a website or web application via a browser. End user clicks sign-in and types their username and password. The RP…
- html Example value: html format content Description: the content is displayed in HTML format
- http_method Example value: GET Description: no-description-provided
- id Example value: d8839721-ad8f-45dd-9f78-2080414b93f9 Description: no-description-provided
- instructedamount Example value: 100 Description: no-description-provided
- inverse_conversion_value Example value: 50 Description: no-description-provided
- is_active Example value: false Description: no-description-provided
- is_bank_id_exact_match Example value: false Description: no-description-provided
- is_public Example value: false Description: no-description-provided
- JSON Schema Validation JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applying JSON Schema Validation to your OBP endpoints you can constrain POST and PUT request bodies. For…
- Just In Time Entitlements Just in Time Entitlements are ENABLED on this instance. This is how Just in Time Entitlements work: If Just in Time Entitlements are enabled then OBP does the following: If a user is trying to use a…
- jwt Example value:…
- Keycloak Onboarding Keycloak Onboarding Guide Overview Keycloak is an open-source identity and access management solution that provides production-grade OpenID Connect (OIDC) and OAuth 2.0 authentication services for…
- KYC (Know Your Customer) KYC is the process by which the Bank can be assured that the customer is who they say they are. OBP provides a number of endpoints that KYC Apps can interact with in order to get and store relevant…
- last_failure_date Example value: 2020-01-27 Description: no-description-provided
- last_lock_date Example value: 2020-01-27 Description: no-description-provided
- last_name Example value: Smith Description: The Last name
- last_ok_date Example value: 2025-11-10T14:04:25.175Z Description: no-description-provided
- latitude Example value: 38.8951 Description: no-description-provided
- License.id Example value: ODbL-1.0 Description:
- License.name Example value: Open Database License Description:
- logo Example value: logo url Description: no-description-provided
- logo_url Example value: https://apisandbox.openbankproject.com/logo Description: no-description-provided
- longitude Example value: -77.0364 Description: no-description-provided
- Mandates # Mandates ## Overview A Mandate is a formal agreement between a corporate customer and a bank that defines who can operate an account, what they can do, and under what conditions. In OBP, a Mandate…
- max_monthly_amount Example value: 10000.11 Description: no-description-provided
- max_number_of_monthly_transactions Example value: 10 Description: no-description-provided
- max_number_of_transactions Example value: 100 Description: no-description-provided
- max_number_of_yearly_transactions Example value: 100 Description: no-description-provided
- max_single_amount Example value: 1000.11 Description: no-description-provided
- max_total_amount Example value: 10000.12 Description: no-description-provided
- max_yearly_amount Example value: 12000.11 Description: no-description-provided
- maximum_response_time Example value: 60 Description: no-description-provided
- message Example value: 123456 Description: The messsage content to send to customer.
- Message Doc OBP can communicate with core banking systems (CBS) and other back end services using a "Connector - Adapter" approach. The OBP Connector is a core part of the OBP-API and is written in Scala / Java…
- Method Routing Open Bank Project can have different connectors, to connect difference data sources. We support several sources at the moment, eg: databases, rest services, stored procedures and RabbitMq. If OBP set…
- mobile_phone_number Example value: +49 30 901820 Description: no-description-provided
- more_info Example value: More information about this fee Description: no-description-provided
- more_info_url Example value: www.example.com/abc Description: no-description-provided
- Multi-factor authentication (MFA) Multi-factor authentication (MFA) is a multi-step account login process that requires users to enter more information than just a password. For example, along with the password, users might be asked…
- My-Dynamic-Entities My Dynamic Entities are user-scoped endpoints that are automatically generated when you create a Dynamic Entity with hasPersonalEntity set to true (which is the default). How it works: 1. Create a…
- name Example value: ACCOUNTMANAGEMENTFEE Description: no-description-provided
- Network.ipAddress Example value: 198.51.100.42 Description: An example IP address using documentation range (RFC 5737)
- new_balance Example value: 20 Description: no-description-provided
- OAuth 2.0 Client Credentials Flow Manual OAuth 2.0 Client Credentials Flow Manual Overview OAuth 2.0 Client Credentials Flow is used when a client application (such as a backend service) needs to authenticate and request access to resources…
- OBP Bank Node OBP Bank Node An OBP Bank Node is a standardised software component designed to run at many banks inside their own network that connect to their Core Banking System (CBS) to an OBP API instance…
- OBP-MCP # OBP-MCP OBP-MCP is a Model Context Protocol server for the Open Bank Project API. It lets AI assistants (Claude, Opey, IDE agents, custom LLM tooling) discover and call OBP-API endpoints as MCP…
- OBP-Sentinel OBP-Sentinel OBP-Sentinel watches running OBP-API instances, and the apps around them (API Explorer II, the API Manager, the Portal, OBP-OIDC), for hours. It works out what is actually going wrong or…
- OCSP The Online Certificate Status Protocol (OCSP) is an Internet protocol used for obtaining the revocation status of an X.509 digital certificate. It is described in RFC 6960 and is on the Internet…
- OIDC An acronym for OpenID Connect (OIDC) is an identity authentication protocol that is an extension of open authorization (OAuth) 2.0 to standardize the process for authenticating and authorizing users…
- ok Example value: false Description: no-description-provided
- On Behalf Of An application acting for a User, such as an AI agent, calls OBP with a Consent and authenticates as a consent user, an identity OBP creates for that Consent. userid is the caller (the consent user);…
- on_hot_list Example value: false Description: no-description-provided
- OpenID Connect with Google OAuth2 is allowed on this instance. ## OpenID Connect with Google ### Introduction Google's OAuth 2.0 APIs can be used for both authentication and authorization. This document describes our OAuth 2.0…
- Opey # Opey Opey (current generation: Opey II) is the Open Bank Project's agentic AI assistant — a chatbot that lets users explore and operate the OBP API in natural language. It is built on LangGraph, is…
- order_date Example value: 2020-01-27 Description: no-description-provided
- other_account_routing_address Example value: DE89370400440532013000 Description: OtherBankRoutingAddress string, eg IBAN value
- other_account_routing_scheme Example value: IBAN Description: otherAccountRoutingScheme string, eg: IBAN
- overall_balance Example value: 10 Description: no-description-provided
- overall_balance_date Example value: 2020-01-27 Description: no-description-provided
- parent_product_code Example value: 787LOW Description: no-description-provided
- Password Policy The rules a password must satisfy when it is set — at user creation (POST /users) and at password reset. A password is valid if it satisfies AT LEAST ONE of the following policies: 1) Composition: 10…
- Password Reset for OBP Local Users ### Overview The password reset flow allows a user who has forgotten their password to request a reset email and then set a new password. There are two steps: 1. Request a password reset email…
- payload Example value: { "everything": false, "accountaccess": [ { "accountrouting": { "scheme": "OBP", "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "viewid": "owner" } ], "phonenumber": "+44 07972…
- paymentService Example value: payments Description: The berlin group payment services, eg: payments, periodic-payments and bulk-payments.
- per_day Example value: 4000 Description: no-description-provided
- per_month Example value: 500 Description: no-description-provided
- per_second Example value: 1000 Description: no-description-provided
- per_second_call_limit Example value: 10 Description: no-description-provided
- per_week Example value: 50000 Description: no-description-provided
- Platform Apps Platform Apps A Platform App is an application an installation runs as part of its own OBP deployment, such as the Portal, the API Manager, Opey or one of the bank's own services. Like any…
- post_code Example value: 789 Description: no-description-provided
- posted Example value: 2020-01-27 Description: no-description-provided
- process Example value: obp.getBank Description: The format must be obp.xxxx, 'obp.' is the prefix, xxx will be the connector method name
- product_code Example value: 1234BW Description: no-description-provided
- product_fee_id Example value: 696hlAHLFKUHE37469287634 Description: no-description-provided
- product_id Example value: product-id-example-uuid Description: The UUID of the product
- product_name Example value: Deposit Account 1 Description: no-description-provided
- provider Example value: ETHEREUM Description: the provider name
- purpose Example value: DEVELOPER Description: no-description-provided
- QSealC Qualified electronic Seal Certificate. A certificate for electronic seals allows the relying party to validate the identity of the subject of the certificate, as well as the authenticity and…
- Qualified Certificate Profiles (PSD2 context) An overview of the Qualified Certificate Profiles.
- QWAC A Qualified Website Authentication Certificate is a qualified digital certificate under the trust services defined in the European Union eIDAS Regulation. A website authentication certificate makes…
- rank_amount1 Example value: 100 Description: no-description-provided
- Rate Limiting Rate Limiting controls the number of API requests a Consumer can make within specific time periods. This prevents abuse and ensures fair resource allocation across all API consumers. Architecture -…
- Redirect URL A Consumer's redirect URL is where an OIDC provider (such as OBP-OIDC) sends the User's browser, with an authorisation code, after the User signs in. Because the code goes wherever the redirect URL…
- redirect_url Example value: https://apisandbox.openbankproject.com Description: no-description-provided
- Regulated-Entities In the context of the Open Bank Project (OBP), a "Regulated Entity" refers to organizations that are recognized and authorized to provide financial services under regulatory frameworks. These…
- RegulatedEntity.attribute_id Example value: attrafa-9a0f-4bfa-b30b-9003aa467f51 Description: A string that MUST uniquely identify the Regulated Entity Attribute on this OBP instance.
- RegulatedEntity.attribute_name Example value: Attribute Name Description: regulatedEntity attribute name
- RegulatedEntity.attribute_type Example value: Attribute Name Description: regulatedEntity attribute name
- RegulatedEntity.attribute_value Example value: Attribute Name Description: regulatedEntity attribute name
- requested_current_rate_amount2 Example value: 20 Description: no-description-provided
- require_scopes_for_listed_roles Example value: false Description: no-description-provided
- requiredfieldinfo Example value: false Description: no-description-provided
- Resource Doc A Resource Doc is the machine readable definition / description of an OBP Endpoint. The aim is that as much endpoint definition as possible is defined first within the Resource Doc making the…
- Risk-based authentication Please take a look at "Adaptive authentication" glossary item.
- roles Example value: CanCreateMyUser Description: Entitlements are used to grant System or Bank level roles to Users
- Roles of Open Bank Project CanAddKycCheck CanAddKycDocument CanAddKycMedia CanAddKycStatus CanAddSocialMediaHandle CanAddUserToGroupAtAllBanks CanAddUserToGroupAtOneBank CanApproveDynamicChangeRequest CanApproveRetentionRun…
- Run via IntelliJ IDEA To run via IntelliJ IDEA Prerequisites JDK 25. pom.xml sets 25 , so anything older will not compile. Any OpenJDK 25 distribution works (Eclipse Temurin, Azul Zulu, …). is 25 as well, so the IDE SDK,…
- Sandbox Introduction
- Sandbox Populator The OBP Sandbox Populator is used to create bank level data for a logged in developer that needs test data. The User logs in to it via OAuth2, and it calls OBP endpoints on behalf of that User.…
- satisfied Example value: false Description: no-description-provided
- SCA (Strong Customer Authentication) SCA is the process by which a Customer of the Bank securely identifies him/her self to the Bank. Generally this involves using an Out Of Band (OOB) form of communication e.g. a One Time Password…
- Scenario 1: Onboarding a User ### 1) Create a user Action: POST https://k8s.openbankproject.com/obp/v4.0.0/users Body: { "email":"ellie@example.com", "username":"ellie", "password":"P@55w0RD123", "firstname":"Ellie",…
- Scenario 2: Create a Public Account ### 1) Create account Create an account as described in Step 5 of section Onboarding a user ### 2) Create a view Action: POST…
- Scenario 3: Create counterparty and make payment ### 1) Create counterparty Action: POST https://k8s.openbankproject.com/obp/v4.0.0/banks/BANKID/accounts/account-id-from-account-creation/VIEWID/counterparties Body: { "name":"CounterpartyName",…
- Scenario 4: Grant account access to another User ### 1) Create account Create an account as described in Step 5 of section Onboarding a user ### 2) Create a view (private) Action: POST…
- Scenario 5: Onboarding a User using Auth Context ### 1) Create a user Action: POST https://k8s.openbankproject.com/obp/v3.0.0/users Body: { "email":"ellie@example.com", "username":"ellie", "password":"P@55w0RD123", "firstname":"Ellie",…
- Scenario 6: Update credit score based on transaction and device data. ### 1) Use Case As an App developer you want to give a Credit Rating to a Customer based on their Transactions and also device data. ### 2) Solution Overview: In general your application will need…
- Scenario 7: Onboarding a User with multiple User Auth Context records ### 1) Assuming a User is registered. The User can authenticate using OAuth, OIDC, Direct Login etc. ### 2) Create a first User Auth Context record e.g. ACCOUNTNUMBER The setting of the first User…
- scheduled_date Example value: 2020-01-27 Description: no-description-provided
- scheme Example value: OBP Description: no-description-provided
- SDKs # SDKs OBP SDKs (Software Development Kits) are client libraries that make it easier to interact with the OBP API from various programming languages. SDKs are available for multiple languages…
- sepaB2b Example value: yes Description: no-description-provided
- sepaCardClearing Example value: no Description: no-description-provided
- sepaCreditTransfer Example value: yes Description: no-description-provided
- sepaDirectDebit Example value: yes Description: no-description-provided
- sepaSddCore Example value: yes Description: no-description-provided
- services Example value: [{"CY":["PS010","PS020","PS03C","PS04C"]}] Description: The services provided by the entity.
- Signal Channels # Signal Channels Signal Channels are short-lived, Redis-backed message channels for lightweight coordination between AI agents and other OBP consumers — service discovery, task hand-off, presence…
- Space In OBP, if you have access to a "Space", you have access to a set of Dynamic Endpoints and Dynamic Entities that belong to that Space. Internally, Spaces are defined as a "Banks" thus Spaces are…
- Static Endpoint Static endpoints are served from static Scala source code which is contained in (public) Git repositories. Static endpoints cover all the OBP API and User management functionality as well as the Open…
- supported_currencies Example value: ["EUR","MXN","USD"] Description: no-description-provided
- supported_languages Example value: ["EUR","MXN","USD"] Description: no-description-provided
- tags Example value: Create-My-User Description: OBP uses the tags to group the endpoints, the relevant endpoints can share the same tag.
- tax_number Example value: 456 Description: no-description-provided
- technology Example value: technology1 Description: no-description-provided
- Telemetry # Telemetry Telemetry is the set of aggregated numbers that describe how a running OBP-API instance is behaving: how many requests it serves and how long they take, how often its caches answer…
- Template.attributeName Example value: SPECIALTAXNUMBER Description: Attribute name
- Template.attributeType Example value: STRING Description: Attribute type.
- Tenancy-Model-Open-Bank-Project The Open Bank Project (OBP) supports multi-bank operation within a single deployment, with banks acting as the primary domain and isolation boundary. Integration behaviour can be configured per bank,…
- terms_and_conditions_url_example Example value: www.example.com/xyz Description: no-description-provided
- to_currency_code Example value: EUR Description: no-description-provided
- to_date Example value: 1100-01-01T01:01:01.000Z Description: The TimeStamp in the format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
- TPP (TPP) Third Party Providers are authorised/registered organisations or natural persons that use APIs developed to Standards to access customer’s accounts, in order to provide account information…
- TPP Certificate Verification TPP Certificate Verification The signing and verification flow of certificates for TPP requests is a follows: Generation of the Request by TPP Step 1: Calculating the Hash for the Digest Field TPP…
- Transaction Transactions are records of successful movements of value into or out of an Account. OBP Transactions don't contain any "draft" or "pending" Transactions; pending transactions see represented by…
- Transaction request challenge threshold Is an example of "Adaptive authentication" where, in a dynamic way, we get challenge threshold via CBS depending on a user's risk profile. It implies that in a case of risky transaction request, over…
- Transaction Requests Transaction Requests are records of transaction / payment requests coming to the API. They may or may not result in Transactions (following authorisation, security challenges and sufficient funds…
- Transaction Requests.attributeId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: Transaction Request attribute id
- Transaction Requests.attributeName Example value: HOUSERENT Description: Transaction Request attribute name
- Transaction Requests.attributeType Example value: STRING Description: Transaction Request attribute type.
- Transaction Requests.attributeValue Example value: 123456789 Description: Transaction Request attribute value.
- Transaction Requests.id Example value: 8138a7e4-6d02-40e3-a129-0b2bf89de9f1 Description: The Transaction Request Id
- Transaction Requests.Transaction Request Refund Reason Code Example value: CUST Description: Defines the reason code of a transaction refund request (e.g. a SEPA Credit Transfer Scheme reason code).
- Transaction Requests.Transaction Request Type Example value: SEPA Description: The Transaction Request Type defines the request body that is required - and the logic / flow of the Transaction Request. Allowed values include SEPA, COUNTERPARTY…
- Transaction-Request-Introduction In OBP we initiate a Payment by creating a Transaction Request. An OBP transaction request may or may not result in a transaction. However, a transaction only has one possible state: completed. A…
- Transaction.attributeId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: Transaction attribute id
- Transaction.attributeName Example value: HOUSERENT Description: Transaction attribute name
- Transaction.attributeType Example value: DATEWITHDAY Description: Transaction attribute type.
- Transaction.attributeValue Example value: 123456789 Description: Transaction attribute value.
- Transaction.charge_policy Example value: SHARED Description: The transaction fee charge policy, can be shared, debit account or credit account.
- Transaction.otherAccountProvider Example value: Description:
- Transaction.transaction_id Uniquely identifies a Transaction on an account at a bank. Example value: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
- Transaction.transactionDescription Example value: The piano lession-Invoice No:68 Description: A description or reference for the transaction
- Transaction.transactionId Example value: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub Description: The Transaction ID used in URLs. Used to store Metadata for the Transaction.
- Transaction.transactionType Example value: DEBIT Description: A code for the type of transaction
- TransactionRequest.status Example value: COMPLETED Description: Status of the transaction, e.g. COMPLETED, PENDING ..
- transport Example value: SMS Description: It can be SMS or Email or other transport types
- type Example value: Description: no-description-provided
- User The entity that accesses the API with a login / authorisation token and has access to zero or more resources on the OBP API. The User is linked to the core banking user / customer at the South Side…
- User Customer Links Link Users and Customers in a many to many relationship. A User can represent many Customers (e.g. the bank may have several Customer records for the same individual or a dependant). In this way…
- User.attributeId Example value: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh Description: User attribute id
- User.attributeName Example value: BATTERYLEVEL Description: User attribute name
- User.attributeType Example value: STRING Description: User attribute type.
- User.attributeValue Example value: 90 Description: User attribute value.
- User.isPersonal Example value: false Description: User attribute is personal value.
- User.password Example value: passwordpasswordpassword Description: The password the user uses to authenticate.
- User.provider The host name of the authentication service. e.g. the OBP hostname or OIDC host.
- User.provider_id The id of the user given by the authentication provider. This is UNIQUE in combination with PROVIDER name.
- User.user_id An identifier that MUST NOT leak the user name or other identifier nomrally used by the customer or bank staff. It SHOULD be a UUID and MUST be unique on the OBP instance. Example value:…
- User.userId Example value: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1 Description: A string that MUST uniquely identify the user on this OBP instance.
- User.username Example value: felixsmith Description: The username the user uses to authenticate.
- User.userNameExample Example value: felixsmith Description: The userName the user uses to authenticate.
- users Example value: user list Description: Please refer to the user object.
- valid_from Example value: 2020-01-27 Description: no-description-provided
- view.description Example value: This view is for the owner for the account. Description: A description for this view.
- view.id Example value: owner Description: A viewId can be owner, accountant ....
- view.is_system Example value: true Description: If the view is the system level, then it is true
- view.name Example value: owner Description: A viewName can be owner, accountant ....
- View.view_id Identifies a View on a bank account. A View controls which fields of the account and its transactions a User can see, and which actions they can take on that account. Granting a User access to an…
- Virtual Entitlements A virtual Entitlement is a Role a User holds because their USERID is listed in an instance props entry, not because an Entitlement row exists. Two props entries grant them: superadminuserids:…
- vrp_consent_request.payload Example value: { "fromaccount": { "bankrouting": { "scheme": "OBP", "address": "gh.29.uk" }, "accountrouting": { "scheme": "OBP", "address": "8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0" }, "branchrouting":…
- website Example value: www.openbankproject.com Description: no-description-provided
- webui_props Example value: webuiapiexplorerurl Description: WebUI Props are properties that configure the Web UI behavior and appearance. Properties with names starting with 'webui' can be stored in the database…
- when Example value: 2020-01-27 Description: no-description-provided
- which_alias_to_use Example value: public Description: no-description-provided