← Portal
Portal
Manager
(opens in a new tab)
API Status
Endpoints
Glossary
Message Docs
gRPC
480
ABAC_Account_Access_Enforcement
ABAC_Object_Properties_Reference
ABAC_Parameters_Summary
ABAC_Simple_Guide
ABAC_Testing_Examples
accessibility_features
Account
Account Access
Account.account_id
Account.account_routing_address
Account.account_routing_scheme
Account.account_routings
Account.iban
Account.owner
Account.queryTagsExample
active
actual_date
Adapter
Adapter.Akka.Intro
Adapter.authInfo
Adapter.brand
Adapter.card_attribute_id
Adapter.card_attribute_name
Adapter.card_attribute_value
Adapter.card_id
Adapter.card_number
Adapter.card_type
Adapter.cbsToken
Adapter.cvv
Adapter.expiry_month
Adapter.expiry_year
Adapter.issue_number
Adapter.key
Adapter.limit
Adapter.name_on_card
Adapter.offset
Adapter.provider_id
Adapter.serial_number
Adapter.Stored_Procedure.Intro
Adapter.value
Adaptive authentication
Age
Agent.agent_id
Agent.agent_number
allowed_attempts
allows
API
API Collection
API Metrics
API Product Subscription
API Tag
API-Explorer-II-Help
API.Access Control
API.correlation_id
API.Endpoint Auth Modes
API.Interfaces
API.Timeouts
ApiCollection.apiCollectionId
ApiCollection.apiCollectionName
ApiCollectionEndpoint.apiCollectionEndpointId
ApiCollectionEndpoint.operationId
app_name
app_type
Asset
atm_id
ATM.attribute_id
ATM.cash_withdrawal_international_fee
ATM.has_deposit_capability
ATM.is_accessible
ATM.location_categories
ATM.minimum_withdrawal
ATM.name
ATM.notes
ATM.services
Attribute.name
Attribute.type
Attribute.value
attributes
Authentication
Authentication Device (AD)
Authentication: Consent OBP Flow Example
Authentication: Credential Checking Flow
Authentication: Direct Login
Authentication: Gateway Login
Authentication: OAuth 2
Authentication: OAuth 2.0
Authentication: OAuth2 / OIDC Client Credentials
Authentication.provider
Authorization
Available FAPI profiles
balance
balance_id
balance_type
Bank
bank_code
bank_routings
Bank.bank_id
Bank.bank_routing_address
Bank.bank_routing_scheme
Bank.bank_routings
Berlin Group Consent Settings
Berlin Group Mandatory Headers
Berlin Group Response Formatting
Berlin Group Transaction and Consent Lifecycle
Berlin Group URL and Path Configuration
bic
Branch
Branch.branch_id
Branch.branch_routing_address
Branch.branch_routing_scheme
calls_made
can_add_counterparty
can_add_image_url
can_add_more_info
can_add_tag
can_add_transaction_request_to_own_account
can_be_seen_on_views
can_create_direct_debit
can_delete_corporate_location
can_delete_image
can_delete_where_tag
can_edit_owner_comment
can_query_available_funds
can_see_bank_account_bank_name
can_see_bank_account_credit_limit
can_see_bank_account_label
can_see_bank_account_number
can_see_bank_account_owners
can_see_bank_routing_address
can_see_corporate_location
can_see_image_url
can_see_images
can_see_other_account_national_identifier
can_see_other_account_number
can_see_other_account_routing_address
can_see_other_account_swift_bic
can_see_transaction_amount
can_see_transaction_description
can_see_url
can_see_where_tag
cancelled
certificate_authority_ca_owner_id
ChallengeAnswer.challengeId
ChallengeAnswer.hashOfSuppliedAnswer
ChallengeAnswer.suppliedAnswerExample
Chat
Chat Room
Cheat Sheet
CIBA
Client IP Address
client_id (Client ID)
closing_time
code
collected
company
completed
Connector
Connector Method
Connector Metrics
Connector.User.Authentication
ConnectorMethod.connectorMethodId
Consent
Consent_Account_Onboarding
consent_id
consent_reference_id
consent_request_id
Consumer
Consumer, Consent, Transport and Payload Security
Consumer.consumer_key (Consumer Key)
Consumption Device (CD)
conversion_value
corporate_location
Counterparties
counterparty_limit_id
Counterparty-Limits
Counterparty.counterpartyId
Counterparty.counterpartyName
Counterparty.isBeneficiary
country
country_code
CRL
Cross-Device Authorization
Customer
Customer.attributeAlias
Customer.attributeId
Customer.attributeName
Customer.attributeType
Customer.attributeValue
Customer.consumerId
Customer.Credit.rating
Customer.Credit.source
Customer.customer_id
Customer.customerAccountLinkId
Customer.customerAttributeId
Customer.customerAttributeName
Customer.customerAttributeType
Customer.customerAttributeValue
Customer.customerId
Customer.customerNumber
Customer.customerType
Customer.dependants
Customer.dependents
Customer.employmentStatus
Customer.highestEducationAttained
Customer.key
Customer.kycStatus
Customer.legalName
Customer.mobileNumber
Customer.nameSuffix
Customer.parentCustomerId
Customer.relationshipStatus
Customer.relationshipType
Customer.secret
Customer.title
Customer.url
CustomerMessage.id
Data Model Overview
data.bankid
Database Connection Hold Warnings
date_of_application
DAuth
description
dob_of_dependants
Domain APIs
Dummy Customer Logins
duration
duration_time
Dynamic Change Request
Dynamic Code Paths
Dynamic Endpoint Manage
Dynamic Entity Webhooks
Dynamic linking (PSD2 context)
Dynamic Message Doc
Dynamic Query
Dynamic Resource Doc
Dynamic Resource Doc Introduction
Dynamic-Entities
Dynamic-Entity-Access-Model
Dynamic-Entity-Intro
DynamicConnectorMethod.lang
DynamicConnectorMethod.methodBody.Java
DynamicConnectorMethod.methodBody.Js
DynamicConnectorMethod.methodBody.scala
DynamicResourceDoc.description
DynamicResourceDoc.dynamicResourceDocId
DynamicResourceDoc.errorResponseBodies
DynamicResourceDoc.exampleRequestBody
DynamicResourceDoc.isFeatured
DynamicResourceDoc.methodBody
DynamicResourceDoc.partialFunctionName
DynamicResourceDoc.requestUrl
DynamicResourceDoc.requestVerb
DynamicResourceDoc.successResponseBody
DynamicResourceDoc.summary
Echo Request Headers
effective_date
Email Validation for OBP Local Users
enabled
Endpoint
Endpoint Mapping
EndpointTag.endpointTagId
EndpointTag.tagName
entity_address
entity_certificate_public_key
entity_code
entity_country
entity_id
entity_name
entity_post_code
entity_town_city
entity_type
entity_web_site
example_inbound_message
example_outbound_message
execution_date
FAPI
FAPI 1.0
FAPI 2.0
FeaturedApiCollection.featuredApiCollectionId
FeaturedApiCollection.sortOrder
first_name
frequency
from_date
from_department
from_person
full_name
future_date
FX-Rates
Groups
Hello AI Agents
hide_metadata_if_alias_used
Hola App log trace
How OpenID Connect Works
html
http_method
id
instructedamount
inverse_conversion_value
is_active
is_bank_id_exact_match
is_public
JSON Schema Validation
Just In Time Entitlements
jwt
Keycloak Onboarding
KYC (Know Your Customer)
last_failure_date
last_lock_date
last_name
last_ok_date
latitude
License.id
License.name
logo
logo_url
longitude
Mandates
max_monthly_amount
max_number_of_monthly_transactions
max_number_of_transactions
max_number_of_yearly_transactions
max_single_amount
max_total_amount
max_yearly_amount
maximum_response_time
message
Message Doc
Method Routing
mobile_phone_number
more_info
more_info_url
Multi-factor authentication (MFA)
My-Dynamic-Entities
name
Network.ipAddress
new_balance
OAuth 2.0 Client Credentials Flow Manual
OBP Bank Node
OBP-MCP
OBP-Sentinel
OCSP
OIDC
ok
On Behalf Of
on_hot_list
OpenID Connect with Google
Opey
order_date
other_account_routing_address
other_account_routing_scheme
overall_balance
overall_balance_date
parent_product_code
Password Policy
Password Reset for OBP Local Users
payload
paymentService
per_day
per_month
per_second
per_second_call_limit
per_week
Platform Apps
post_code
posted
process
product_code
product_fee_id
product_id
product_name
provider
purpose
QSealC
Qualified Certificate Profiles (PSD2 context)
QWAC
rank_amount1
Rate Limiting
Redirect URL
redirect_url
Regulated-Entities
RegulatedEntity.attribute_id
RegulatedEntity.attribute_name
RegulatedEntity.attribute_type
RegulatedEntity.attribute_value
requested_current_rate_amount2
require_scopes_for_listed_roles
requiredfieldinfo
Resource Doc
Risk-based authentication
roles
Roles of Open Bank Project
Run via IntelliJ IDEA
Sandbox Introduction
Sandbox Populator
satisfied
SCA (Strong Customer Authentication)
Scenario 1: Onboarding a User
Scenario 2: Create a Public Account
Scenario 3: Create counterparty and make payment
Scenario 4: Grant account access to another User
Scenario 5: Onboarding a User using Auth Context
Scenario 6: Update credit score based on transaction and device data.
Scenario 7: Onboarding a User with multiple User Auth Context records
scheduled_date
scheme
SDKs
sepaB2b
sepaCardClearing
sepaCreditTransfer
sepaDirectDebit
sepaSddCore
services
Signal Channels
Space
Static Endpoint
supported_currencies
supported_languages
tags
tax_number
technology
Telemetry
Template.attributeName
Template.attributeType
Tenancy-Model-Open-Bank-Project
terms_and_conditions_url_example
to_currency_code
to_date
TPP
TPP Certificate Verification
Transaction
Transaction request challenge threshold
Transaction Requests
Transaction Requests.attributeId
Transaction Requests.attributeName
Transaction Requests.attributeType
Transaction Requests.attributeValue
Transaction Requests.id
Transaction Requests.Transaction Request Refund Reason Code
Transaction Requests.Transaction Request Type
Transaction-Request-Introduction
Transaction.attributeId
Transaction.attributeName
Transaction.attributeType
Transaction.attributeValue
Transaction.charge_policy
Transaction.otherAccountProvider
Transaction.transaction_id
Transaction.transactionDescription
Transaction.transactionId
Transaction.transactionType
TransactionRequest.status
transport
type
User
User Customer Links
User.attributeId
User.attributeName
User.attributeType
User.attributeValue
User.isPersonal
User.password
User.provider
User.provider_id
User.user_id
User.userId
User.username
User.userNameExample
users
valid_from
view.description
view.id
view.is_system
view.name
View.view_id
Virtual Entitlements
vrp_consent_request.payload
website
webui_props
when
which_alias_to_use
Register
Login
API Explorer
https://obp-api-sandbox.nmbbank.co.tz
Opey
← Glossary
new_balance
Example value: 20
Description: no-description-provided