-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Create Bank Level Endpoint Tag
- Create System Level Endpoint Tag
- Delete Bank Level Endpoint Tag
- Delete System Level Endpoint Tag
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Bank Level Endpoint Tags
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Mapper Database Info
- Get Rate Limiting Info
- Get Suggested Session Timeout
- Get System Level Endpoint Tags
- Get the Call Context of a current call
- Update Bank Level Endpoint Tag
- Update System Level Endpoint Tag
- Verify Request and Sign Response of a current call
- Waiting For Godot
-
-
ATM
- Create ATM
- Create ATM Attribute
- Delete ATM
- Delete ATM Attribute
- Get ATM Attribute By ATM_ATTRIBUTE_ID
- Get ATM Attributes
- Get Bank ATM
- Get Bank ATMS
- Head Bank ATMS
- UPDATE ATM
- Update ATM Accessibility Features
- Update ATM Attribute
- Update ATM Location Categories
- Update ATM Notes
- Update ATM Services
- Update ATM Supported Currencies
- Update ATM Supported Languages
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Check Available Funds
- Create Account (POST)
- Create Account (PUT)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Access by USER_ID
- Get Account Attribute Definition
- Get Account Balances
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID
- Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Core) through the VIEW_ID
- Get Account by Id (Full)
- Get Accounts Held
- Get Accounts Minimal for a Customer
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Accounts by Account Routing Regex
- Get Checkbook orders
- Get Fast Firehose Accounts at Bank
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN
-
-
Account Access
-
Account Access governs access to Bank Accounts by end Users. It is an intersecting entity between tMore...
- Create (DAuth) User with Account Access
- Grant User access to View
- Revoke User access to View
-
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get All API Collections
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
- Update My Api Collection By API_COLLECTION_ID
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Bank Attribute
- Create Settlement Account
- Create Transaction Type at bank
- Create or Update Bank Attribute Definition
- Delete Bank Attribute
- Delete Bank Cascade
- Get Bank
- Get Bank Attribute By BANK_ATTRIBUTE_ID
- Get Bank Attributes
- Get Banks
- Get Settlement accounts at Bank
- Get Transaction Types at Bank
- Update Bank
- Update Bank Attribute
-
-
Connector Method
-
Developers can override all the existing Connector methods. This function needs to be used togethMore...
- Create Connector Method
- Get Connector Method by Id
- Get all Connector Methods
- Update Connector Method
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- Add User to a Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Create Consent By CONSENT_REQUEST_ID (EMAIL)
- Create Consent By CONSENT_REQUEST_ID (IMPLICIT)
- Create Consent By CONSENT_REQUEST_ID (SMS)
- Create Consent Request
- Create Consent Request VRP
- Get Consent By Consent Id
- Get Consent By Consent Id
- Get Consent By Consent Request Id
- Get Consent Request
- Get Consents
- Get Consents Info
- Provide client's certificate info of a current call
- Revoke Consent
- Revoke Consent at Bank
- Revoke Consent used in the Current Call
- Update Consent Status
-
-
Consumer
-
The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on beMore...
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Post a Consumer
- Set Rate Limits / Call Limits per Consumer
- Update Consumer RedirectUrl
-
-
Counterparty
- Create Counterparty (Explicit)
- Create Counterparty for any account (Explicit)
- Delete Counterparty (Explicit)
- Delete Counterparty for any account (Explicit)
- Get Counterparties (Explicit)
- Get Counterparties for any account (Explicit)
- Get Counterparty by Id (Explicit)
- Get Counterparty by Id for any account (Explicit)
- Get Counterparty by name for any account (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Address
- Create Customer
- Create Customer Account Link
- Create Customer Attribute
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Account Link
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Customer Cascade
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Correlated Entities for the current User
- Get Correlated User Info by Customer
- Get Customer Account Link by Id
- Get Customer Account Links by ACCOUNT_ID
- Get Customer Account Links by CUSTOMER_ID
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Overview
- Get Customer Overview Flat
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers Minimal at Any Bank
- Get Customers Minimal at Bank
- Get Customers at Any Bank
- Get Customers at Bank
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Customers for Current User (IDs only)
- Get Firehose Customers
- Get My Customers
- Get My Customers at Bank
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Account Link by Id
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
-
-
Dynamic Endpoint Manage
-
If you want to create endpoints from Swagger / Open API specification files, use Dynamic EndpointsMore...
- Delete Bank Level Dynamic Endpoint
- Delete Dynamic Endpoint
- Get Bank Level Dynamic Endpoint
- Get Dynamic Endpoints
- Update Bank Level Dynamic Endpoint Host
- Update Dynamic Endpoint Host
- Create Bank Level Dynamic Endpoint
- Create Dynamic Endpoint
- Delete My Dynamic Endpoint
- Get Bank Level Dynamic Endpoints
- Get Dynamic Endpoint
- Get My Dynamic Endpoints
-
-
Dynamic Entity Manage
-
Dynamic Entities can be used to store and retrieve custom data objects (think your own tables andMore...
- Create Bank Level Dynamic Entity
- Create System Level Dynamic Entity
- Delete Bank Level Dynamic Entity
- Delete My Dynamic Entity
- Delete System Level Dynamic Entity
- Get Bank Level Dynamic Entities
- Get My Dynamic Entities
- Get System Dynamic Entities
- Update Bank Level Dynamic Entity
- Update My Dynamic Entity
- Update System Level Dynamic Entity
-
-
Dynamic Message Doc
-
In OBP we represent messages sent by a Connector method / function as MessageDocs. A MessageDoc dMore...
- Create Bank Level Dynamic Message Doc
- Create Dynamic Message Doc
- Delete Bank Level Dynamic Message Doc
- Delete Dynamic Message Doc
- Get Bank Level Dynamic Message Doc
- Get Dynamic Message Doc
- Get all Bank Level Dynamic Message Docs
- Get all Dynamic Message Docs
- Update Bank Level Dynamic Message Doc
- Update Dynamic Message Doc
-
-
Dynamic Resource Doc
- A test endpoint
- Create Bank Level Dynamic Resource Doc
- Create Dynamic Resource Doc
- Create Dynamic Resource Doc endpoint code
- Delete Bank Level Dynamic Resource Doc
- Delete Dynamic Resource Doc
- Get Bank Level Dynamic Resource Doc by Id
- Get Dynamic Resource Doc by Id
- Get all Bank Level Dynamic Resource Docs
- Get all Dynamic Resource Docs
- Update Bank Level Dynamic Resource Doc
- Update Dynamic Resource Doc
-
Endpoint Mapping
-
Endpoint Mapping can be used to map each JSON field in a Dynamic Endpoint to different Dynamic EntiMore...
- Create Bank Level Endpoint Mapping
- Create Endpoint Mapping
- Delete Bank Level Endpoint Mapping
- Delete Endpoint Mapping
- Get Bank Level Endpoint Mapping
- Get Endpoint Mapping by Id
- Get all Bank Level Endpoint Mappings
- Get all Endpoint Mappings
- Update Bank Level Endpoint Mapping
- Update Endpoint Mapping
-
-
JSON Schema Validation
-
JSON Schema is "a vocabulary that allows you to annotate and validate JSON documents". By applyinMore...
- Create a JSON Schema Validation
- Delete a JSON Schema Validation
- Get a JSON Schema Validation
- Get all JSON Schema Validations
- Get all JSON Schema Validations - public
- Update a JSON Schema Validation
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
Product
- Create Product
- Create Product Attribute
- Create Product Fee
- Create or Update Product Attribute Definition
- Delete Product Attribute
- Delete Product Attribute Definition
- Delete Product Cascade
- Delete Product Fee
- Get Bank Product
- Get Product Attribute
- Get Product Attribute Definition
- Get Product Fee
- Get Product Fees
- Get Product Tree
- Get Products
- Update Product Attribute
- Update Product Fee
-
Role
- Add Entitlement for a User
- Create (DAuth) User with Roles
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements and Permissions for a User
- Get Entitlements for One Bank
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Balancing Transaction
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
Transaction Request
- Answer Transaction Request Challenge
- Create Historical Transactions
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (CARD)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request (SIMPLE)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Answer User Auth Context Update Challenge
- Create My Personal User Attribute
- Create Non Personal User Attribute
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete Non Personal User Attribute
- Delete User Auth Context
- Delete User's Auth Contexts
- Delete a User
- Get Logout Link
- Get My Personal User Attributes
- Get My Spaces
- Get Non Personal User Attributes
- Get User (Current)
- Get User Auth Contexts
- Get User Id (Current)
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get User with Attributes by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- Update My Personal User Attribute
-
-
API
-
Create Bank Level Endpoint Tag
-
Create System Level Endpoint Tag
-
Delete Bank Level Endpoint Tag
-
Delete System Level Endpoint Tag
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Bank Level Endpoint Tags
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Mapper Database Info
-
Get Rate Limiting Info
-
Get Suggested Session Timeout
-
Get System Level Endpoint Tags
-
Get the Call Context of a current call
-
Update Bank Level Endpoint Tag
-
Update System Level Endpoint Tag
-
Verify Request and Sign Response of a current call
-
Waiting For Godot
-
Create Bank Level Endpoint Tag
-
ATM
-
Create ATM
-
Create ATM Attribute
-
Delete ATM
-
Delete ATM Attribute
-
Get ATM Attribute By ATM_ATTRIBUTE_ID
-
Get ATM Attributes
-
Get Bank ATM
-
Get Bank ATMS
-
Head Bank ATMS
-
UPDATE ATM
-
Update ATM Accessibility Features
-
Update ATM Attribute
-
Update ATM Location Categories
-
Update ATM Notes
-
Update ATM Services
-
Update ATM Supported Currencies
-
Update ATM Supported Languages
-
Create ATM
-
Account
-
Check Available Funds
-
Create Account (POST)
-
Create Account (PUT)
-
Create Account Attribute
-
Create or Update Account Attribute Definition
-
Delete Account Attribute Definition
-
Delete Account Cascade
-
Get Account Access by USER_ID
-
Get Account Attribute Definition
-
Get Account Balances
-
Get Account Balances by BANK_ID
-
Get Account Balances by BANK_ID
-
Get Account Balances by BANK_ID and ACCOUNT_ID through the VIEW_ID
-
Get Account by Account Routing
-
Get Account by Id (Core)
-
Get Account by Id (Core) through the VIEW_ID
-
Get Account by Id (Full)
-
Get Accounts Held
-
Get Accounts Minimal for a Customer
-
Get Accounts at Bank
-
Get Accounts at Bank (IDs only)
-
Get Accounts at Bank (Minimal)
-
Get Accounts at all Banks (private)
-
Get Accounts by Account Routing Regex
-
Get Checkbook orders
-
Get Fast Firehose Accounts at Bank
-
Get Firehose Accounts at Bank
-
Update Account
-
Update Account Attribute
-
Update Account Label
-
Validate and check IBAN
-
Check Available Funds
-
Account Access
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Metadata
-
Account Public
-
Api Collection
-
Create My Api Collection
-
Create My Api Collection Endpoint
-
Create My Api Collection Endpoint By Id
-
Delete My Api Collection
-
Delete My Api Collection Endpoint
-
Delete My Api Collection Endpoint By Id
-
Delete My Api Collection Endpoint By Id
-
Get All API Collections
-
Get Api Collection Endpoints
-
Get Api Collections for User
-
Get Featured Api Collections
-
Get My Api Collection By Id
-
Get My Api Collection By Name
-
Get My Api Collection Endpoint
-
Get My Api Collection Endpoints
-
Get My Api Collection Endpoints By Id
-
Get My Api Collections
-
Get Sharable Api Collection By Id
-
Update My Api Collection By API_COLLECTION_ID
-
Create My Api Collection
-
Authentication Type Validation
-
Create an Authentication Type Validation
-
Delete an Authentication Type Validation
-
Get all Authentication Type Validations
-
Get all Authentication Type Validations - public
-
Get an Authentication Type Validation
-
Update an Authentication Type Validation
-
Create an Authentication Type Validation
-
Bank
-
Create Bank
-
Create Bank Attribute
-
Create Settlement Account
-
Create Transaction Type at bank
-
Create or Update Bank Attribute Definition
-
Delete Bank Attribute
-
Delete Bank Cascade
-
Get Bank
-
Get Bank Attribute By BANK_ATTRIBUTE_ID
-
Get Bank Attributes
-
Get Banks
-
Get Settlement accounts at Bank
-
Get Transaction Types at Bank
-
Update Bank
-
Update Bank Attribute
-
Create Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Create or Update Card Attribute Definition
-
Delete Card
-
Delete Card Attribute Definition
-
Get Card Attribute Definition
-
Get Card By Id
-
Get Cards for the specified bank
-
Get cards for the current user
-
Get status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
-
Connector Method
-
Create Connector Method
-
Get Connector Method by Id
-
Get all Connector Methods
-
Update Connector Method
-
Create Connector Method
-
Consent
-
Add User to a Consent
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (IMPLICIT)
-
Create Consent (SMS)
-
Create Consent By CONSENT_REQUEST_ID (EMAIL)
-
Create Consent By CONSENT_REQUEST_ID (IMPLICIT)
-
Create Consent By CONSENT_REQUEST_ID (SMS)
-
Create Consent Request
-
Create Consent Request VRP
-
Get Consent By Consent Id
-
Get Consent By Consent Id
-
Get Consent By Consent Request Id
-
Get Consent Request
-
Get Consents
-
Get Consents Info
-
Provide client's certificate info of a current call
-
Revoke Consent
-
Revoke Consent at Bank
-
Revoke Consent used in the Current Call
-
Update Consent Status
-
Add User to a Consent
-
Consumer
-
Enable or Disable Consumers
-
Get Call Limits for a Consumer
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Post a Consumer
-
Set Rate Limits / Call Limits per Consumer
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Create Counterparty for any account (Explicit)
-
Delete Counterparty (Explicit)
-
Delete Counterparty for any account (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparties for any account (Explicit)
-
Get Counterparty by Id (Explicit)
-
Get Counterparty by Id for any account (Explicit)
-
Get Counterparty by name for any account (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
Counterparty Limits
-
Create Counterparty Limit
-
Delete Counterparty Limit
-
Get Counterparty Limit
-
Update Counterparty Limit
-
Create Counterparty Limit
-
Counterparty Metadata
-
Add Corporate Location to Counterparty
-
Add Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url to other bank account
-
Add physical location to other bank account
-
Add public alias to other bank account
-
Add url to other bank account
-
Create Other Account Private Alias
-
Delete Counterparty Corporate Location
-
Delete Counterparty Image URL
-
Delete Counterparty Open Corporates URL
-
Delete Counterparty Physical Location
-
Delete Counterparty Private Alias
-
Delete Counterparty Public Alias
-
Delete more info of other bank account
-
Delete url of other bank account
-
Get Other Account Metadata
-
Get Other Account Private Alias
-
Get public alias of other bank account
-
Update Counterparty Corporate Location
-
Update Counterparty Image Url
-
Update Counterparty More Info
-
Update Counterparty Physical Location
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Corporate Location to Counterparty
-
Customer
-
Create Address
-
Create Customer
-
Create Customer Account Link
-
Create Customer Attribute
-
Create Customer Social Media Handle
-
Create Tax Residence
-
Create User Customer Link
-
Create or Update Customer Attribute Definition
-
Delete Customer Account Link
-
Delete Customer Address
-
Delete Customer Attribute
-
Delete Customer Attribute Definition
-
Delete Customer Cascade
-
Delete Tax Residence
-
Delete User Customer Link
-
Get CRM Events
-
Get Correlated Entities for the current User
-
Get Correlated User Info by Customer
-
Get Customer Account Link by Id
-
Get Customer Account Links by ACCOUNT_ID
-
Get Customer Account Links by CUSTOMER_ID
-
Get Customer Addresses
-
Get Customer Attribute By Id
-
Get Customer Attribute Definition
-
Get Customer Attributes
-
Get Customer Overview
-
Get Customer Overview Flat
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers Minimal at Any Bank
-
Get Customers Minimal at Bank
-
Get Customers at Any Bank
-
Get Customers at Bank
-
Get Customers by MOBILE_PHONE_NUMBER
-
Get Customers for Current User
-
Get Customers for Current User (IDs only)
-
Get Firehose Customers
-
Get My Customers
-
Get My Customers at Bank
-
Get Tax Residences of Customer
-
Get User Customer Links by Customer
-
Get User Customer Links by User
-
Update Customer Account Link by Id
-
Update Customer Attribute
-
Update the Address of a Customer
-
Update the Branch of a Customer
-
Update the credit limit of a Customer
-
Update the credit rating and source of a Customer
-
Update the email of a Customer
-
Update the identity data of a Customer
-
Update the mobile number of a Customer
-
Update the number of a Customer
-
Update the other data of a Customer
-
Create Address
-
Customer Meeting
-
Customer Message
-
Create Customer Message
-
Create Customer Message
-
Get Customer Messages for a Customer
-
Get Customer Messages for all Customers
-
Create Customer Message
-
Data Warehouse
-
Direct Debit
-
Directory
-
Create Regulated Entity
-
Create a Consumer
-
Delete Regulated Entity
-
Get Regulated Entities
-
Get Regulated Entity
-
Create Regulated Entity
-
Documentation
-
Get Bank Level Dynamic Resource Docs
-
Get Glossary of the API
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Resource Docs
-
Get Swagger documentation
-
Get scanned API Versions
-
Get Bank Level Dynamic Resource Docs
-
Dynamic Endpoint Manage
-
Delete Bank Level Dynamic Endpoint
-
Delete Dynamic Endpoint
-
Get Bank Level Dynamic Endpoint
-
Get Dynamic Endpoints
-
Update Bank Level Dynamic Endpoint Host
-
Update Dynamic Endpoint Host
-
Create Bank Level Dynamic Endpoint
-
Create Dynamic Endpoint
-
Delete My Dynamic Endpoint
-
Get Bank Level Dynamic Endpoints
-
Get Dynamic Endpoint
-
Get My Dynamic Endpoints
-
Delete Bank Level Dynamic Endpoint
-
Dynamic Entity Manage
-
Create Bank Level Dynamic Entity
-
Create System Level Dynamic Entity
-
Delete Bank Level Dynamic Entity
-
Delete My Dynamic Entity
-
Delete System Level Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get My Dynamic Entities
-
Get System Dynamic Entities
-
Update Bank Level Dynamic Entity
-
Update My Dynamic Entity
-
Update System Level Dynamic Entity
-
Create Bank Level Dynamic Entity
-
Dynamic Message Doc
-
Create Bank Level Dynamic Message Doc
-
Create Dynamic Message Doc
-
Delete Bank Level Dynamic Message Doc
-
Delete Dynamic Message Doc
-
Get Bank Level Dynamic Message Doc
-
Get Dynamic Message Doc
-
Get all Bank Level Dynamic Message Docs
-
Get all Dynamic Message Docs
-
Update Bank Level Dynamic Message Doc
-
Update Dynamic Message Doc
-
Create Bank Level Dynamic Message Doc
-
Dynamic Resource Doc
-
A test endpoint
-
Create Bank Level Dynamic Resource Doc
-
Create Dynamic Resource Doc
-
Create Dynamic Resource Doc endpoint code
-
Delete Bank Level Dynamic Resource Doc
-
Delete Dynamic Resource Doc
-
Get Bank Level Dynamic Resource Doc by Id
-
Get Dynamic Resource Doc by Id
-
Get all Bank Level Dynamic Resource Docs
-
Get all Dynamic Resource Docs
-
Update Bank Level Dynamic Resource Doc
-
Update Dynamic Resource Doc
-
A test endpoint
-
Endpoint Mapping
-
Create Bank Level Endpoint Mapping
-
Create Endpoint Mapping
-
Delete Bank Level Endpoint Mapping
-
Delete Endpoint Mapping
-
Get Bank Level Endpoint Mapping
-
Get Endpoint Mapping by Id
-
Get all Bank Level Endpoint Mappings
-
Get all Endpoint Mappings
-
Update Bank Level Endpoint Mapping
-
Update Endpoint Mapping
-
Create Bank Level Endpoint Mapping
-
FX
-
JSON Schema Validation
-
Create a JSON Schema Validation
-
Delete a JSON Schema Validation
-
Get a JSON Schema Validation
-
Get all JSON Schema Validations
-
Get all JSON Schema Validations - public
-
Update a JSON Schema Validation
-
Create a JSON Schema Validation
-
KYC
-
Add KYC Check
-
Add KYC Document
-
Add KYC Media
-
Add KYC Status
-
Get Customer KYC Checks
-
Get Customer KYC Documents
-
Get Customer KYC statuses
-
Get KYC Media for a customer
-
Add KYC Check
-
Method Routing
-
Metric
-
Get Aggregate Metrics
-
Get Connector Metrics
-
Get Metrics
-
Get Metrics at Bank
-
Get Top APIs
-
Get Top Consumers
-
Search API Metrics via Elasticsearch
-
Get Aggregate Metrics
-
Product
-
Create Product
-
Create Product Attribute
-
Create Product Fee
-
Create or Update Product Attribute Definition
-
Delete Product Attribute
-
Delete Product Attribute Definition
-
Delete Product Cascade
-
Delete Product Fee
-
Get Bank Product
-
Get Product Attribute
-
Get Product Attribute Definition
-
Get Product Fee
-
Get Product Fees
-
Get Product Tree
-
Get Products
-
Update Product Attribute
-
Update Product Fee
-
Create Product
-
Product Collection
-
Role
-
Add Entitlement for a User
-
Create (DAuth) User with Roles
-
Create Entitlement Request for current User
-
Delete Entitlement
-
Delete Entitlement Request
-
Get Entitlement Requests for a User
-
Get Entitlement Requests for the current User
-
Get Entitlements and Permissions for a User
-
Get Entitlements for One Bank
-
Get Entitlements for User
-
Get Entitlements for User at Bank
-
Get Entitlements for the current User
-
Get Roles
-
Get all Entitlement Requests
-
Get all Entitlements
-
Add Entitlement for a User
-
Sandbox
-
Scope
-
Standing Order
-
System Integrity
-
Check Custom View Names
-
Check System View Names
-
Check Unique Index at Account Access
-
Check for Orphaned Accounts
-
Check for Sensible Currencies
-
Check Custom View Names
-
Transaction
-
Create Transaction Attribute
-
Create or Update Transaction Attribute Definition
-
Delete Transaction Attribute Definition
-
Delete Transaction Cascade
-
Get Balancing Transaction
-
Get Double Entry Transaction
-
Get Firehose Transactions for Account
-
Get Other Account of Transaction
-
Get Transaction Attribute By Id
-
Get Transaction Attribute Definition
-
Get Transaction Attributes
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Update Transaction Attribute
-
Create Transaction Attribute
-
Transaction Metadata
-
Add a Transaction Comment
-
Add a Transaction Image
-
Add a Transaction Narrative
-
Add a Transaction Tag
-
Add a Transaction where Tag
-
Delete a Transaction Comment
-
Delete a Transaction Image
-
Delete a Transaction Narrative
-
Delete a Transaction Tag
-
Delete a Transaction Tag
-
Get Transaction Comments
-
Get Transaction Images
-
Get Transaction Tags
-
Get a Transaction Narrative
-
Get a Transaction where Tag
-
Update a Transaction Narrative
-
Update a Transaction where Tag
-
Add a Transaction Comment
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Historical Transactions
-
Create Transaction Request (ACCOUNT)
-
Create Transaction Request (ACCOUNT_OTP)
-
Create Transaction Request (CARD)
-
Create Transaction Request (COUNTERPARTY)
-
Create Transaction Request (FREE_FORM)
-
Create Transaction Request (REFUND)
-
Create Transaction Request (SANDBOX_TAN)
-
Create Transaction Request (SEPA)
-
Create Transaction Request (SIMPLE)
-
Create Transaction Request Attribute
-
Create or Update Transaction Request Attribute Definition
-
Delete Transaction Request Attribute Definition
-
Get Transaction Request
-
Get Transaction Request Attribute By Id
-
Get Transaction Request Attribute Definition
-
Get Transaction Request Attributes
-
Get Transaction Request Types at Bank
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Save Historical Transactions
-
Update Transaction Request Attribute
-
Answer Transaction Request Challenge
-
User
-
Answer User Auth Context Update Challenge
-
Create My Personal User Attribute
-
Create Non Personal User Attribute
-
Create User
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Create password reset url
-
Delete Non Personal User Attribute
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Delete a User
-
Get Logout Link
-
Get My Personal User Attributes
-
Get My Spaces
-
Get Non Personal User Attributes
-
Get User (Current)
-
Get User Auth Contexts
-
Get User Id (Current)
-
Get User Lock Status
-
Get User by USERNAME
-
Get User by USER_ID
-
Get User with Attributes by USER_ID
-
Get Users by Email Address
-
Get all Users
-
Lock the user
-
Refresh User
-
Unlock the user
-
Update My Personal User Attribute
-
Answer User Auth Context Update Challenge
-
User Invitation
-
View Custom
-
Create Custom View
-
Create Custom View
-
Delete Custom View
-
Delete Custom View
-
Get Account access for User
-
Get Custom View
-
Get Views for Account
-
Get access
-
Update Custom View
-
Update Custom View
-
Create Custom View
-
View System
-
WebUi Props
-
Webhook
-
Create an Account Webhook
-
Create bank level Account Notification Webhook
-
Create system level Account Notification Webhook
-
Enable/Disable an Account Webhook
-
Get Account Webhooks
-
Create an Account Webhook
v5.1.0 (529 APIs)
Get Bank Level Dynamic 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.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
See the Resource Doc endpoint for more information.
Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?tags=Account,Bank
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?locale=es_ES
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/banks/BANK_ID/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
connector_methods: connector_methods
description: This an optional field. Maximum length is 2000. It can be any characters here.
description_markdown: description_markdown
error_response_bodies: 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.
example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
function: function
implemented_by: implemented_by
is_featured: false
operation_id: OBPv4.0.0-getBanks
request_url: /my_user/MY_USER_ID
request_verb: POST
resource_docs: resource_docs
role:
success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
tags: Create-My-User
typed_request_body: typed_request_body
typed_success_response_body: typed_success_response_body
created_by_bank_id: created_by_bank_id
meta:
roles: CanCreateMyUser
{
"resource_docs":[{
"operation_id":"OBPv1.4.0-testResourceDoc",
"implemented_by":{
"version":"OBPv1.4.0",
"function":"testResourceDoc"
},
"request_verb":"GET",
"request_url":"/dummy",
"summary":"Test Resource Doc",
"description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
"description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
"example_request_body":{
"jsonString":"{}"
},
"success_response_body":{
"jsonString":"{}"
},
"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
"tags":["Documentation"],
"typed_request_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"typed_success_response_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"roles":[{
"role":"CanGetCustomers",
"requires_bank_id":true
}],
"is_featured":false,
"special_instructions":"",
"specified_url":"",
"connector_methods":[]
}]
}
-
CanReadDynamicResourceDocsAtOneBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Glossary of the API
Get API Glossary
Returns the glossary of the API
Authentication is Optional
JSON response body fields:
description: This an optional field. Maximum length is 2000. It can be any characters here.
html: html format content
title: Dr.
{
"glossary_items":[{
"title":"Dr.",
"description":{
"markdown":"String",
"html":"String"
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Message Docs
These 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.
Integrators can use these messages to build Adapters that provide core banking services to OBP.
Note: API Explorer provides a Message Docs page where these messages are displayed.
CONNECTOR
: kafka_vSept2018, stored_procedure_vDec2019 ...
Authentication is Optional
URL Parameters:
CONNECTOR: CONNECTOR
JSON response body fields:
description: This an optional field. Maximum length is 2000. It can be any characters here.
name: ACCOUNT_MANAGEMENT_FEE
process: obp.getBank
requiredFieldInfo: false
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30211: Invalid Connector. Please specify a valid value for CONNECTOR.
- OBP-50000: Unknown Error.
Get Message Docs Swagger
This endpoint provides example message docs in swagger format.
It is only relavent for REST Connectors.
This endpoint can be used by the developer building a REST Adapter that connects to the Core Banking System (CBS).
That is, the Adapter developer can use the Swagger surfaced here to build the REST APIs that the OBP REST connector will call to consume CBS services.
i.e.:
OBP API (Core OBP API code) -> OBP REST Connector (OBP REST Connector code) -> OBP REST Adapter (Adapter developer code) -> CBS (Main Frame)
Authentication is Optional
URL Parameters:
CONNECTOR: CONNECTOR
JSON response body fields:
description: This an optional field. Maximum length is 2000. It can be any characters here.
name: ACCOUNT_MANAGEMENT_FEE
process: obp.getBank
requiredFieldInfo: false
{
"message_docs":[{
"process":"getAccounts",
"message_format":"KafkaV2017",
"outbound_topic":"to.obp.api.1.caseclass.OutboundGetAccounts",
"inbound_topic":"from.obp.api.1.to.adapter.mf.caseclass.OutboundGetAccounts",
"description":"get Banks",
"example_outbound_message":{
"jsonString":"{}"
},
"example_inbound_message":{
"jsonString":"{}"
},
"outboundAvroSchema":{
"jsonString":"{}"
},
"inboundAvroSchema":{
"jsonString":"{}"
},
"adapter_implementation":{
"group":"CORE",
"suggested_order":3
},
"dependent_endpoints":[{
"name":"getAccounts",
"version":"OBPv3.0.0"
},{
"name":"getBalances",
"version":"OBPv2.0.0"
}],
"requiredFieldInfo":{
"data.bankId":["v2.2.0","v3.1.0"]
}
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
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.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
See the Resource Doc endpoint for more information.
Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
Authentication is Mandatory
URL Parameters:
JSON response body fields:
connector_methods: connector_methods
description: This an optional field. Maximum length is 2000. It can be any characters here.
description_markdown: description_markdown
error_response_bodies: 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.
example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
function: function
implemented_by: implemented_by
is_featured: false
operation_id: OBPv4.0.0-getBanks
request_url: /my_user/MY_USER_ID
request_verb: POST
resource_docs: resource_docs
response_date: response_date
role:
success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
tags: Create-My-User
typed_request_body: typed_request_body
typed_success_response_body: typed_success_response_body
created_by_bank_id: created_by_bank_id
meta:
roles: CanCreateMyUser
{
"resource_docs":[{
"operation_id":"OBPv1.4.0-testResourceDoc",
"implemented_by":{
"version":"OBPv1.4.0",
"function":"testResourceDoc"
},
"request_verb":"GET",
"request_url":"/dummy",
"summary":"Test Resource Doc",
"description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
"description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
"example_request_body":{
"jsonString":"{}"
},
"success_response_body":{
"jsonString":"{}"
},
"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
"tags":["Documentation"],
"typed_request_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"typed_success_response_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"roles":[{
"role":"CanGetCustomers",
"requires_bank_id":true
}],
"is_featured":false,
"special_instructions":"",
"specified_url":"",
"connector_methods":[]
}],
"meta":{
"response_date":"2024-09-07T21:01:05Z",
"count":1
}
}
-
CanReadResourceDoc
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
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.
You may filter this endpoint using the 'content' url parameter, e.g. ?content=dynamic
if set content=dynamic, only show dynamic endpoints, if content=static, only show the static endpoints. if omit this parameter, we will show all the endpoints.
You may need some other language resource docs, now we support en_GB and es_ES at the moment.
You can filter with api-collection-id, but api-collection-id can not be used with others together. If api-collection-id is used in URL, it will ignore all other parameters.
See the Resource Doc endpoint for more information.
Note: Dynamic Resource Docs are cached, TTL is 3600 seconds
Static Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?tags=Account,Bank
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?functions=getBanks,bankById
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?locale=es_ES
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?content=static,dynamic,all
https://obp-api-sandbox.nmbbank.co.tz/obp/v4.0.0/resource-docs/v4.0.0/obp?api-collection-id=4e866c86-60c3-4268-a221-cb0bbf1ad221
- operation_id is concatenation of "v", version and function and should be unique (used for DOM element IDs etc. maybe used to link to source code)
- version references the version that the API call is defined in.
- function is the (scala) partial function that implements this endpoint. It is unique per version of the API.
- request_url is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the implemented version (the version where this endpoint was defined) e.g. /obp/v1.2.0/resource
- specified_url (recommended to use) is empty for the root call, else the path. It contains the standard prefix (e.g. /obp) and the version specified in the call e.g. /obp/v3.1.0/resource. In OBP, endpoints are first made available at the request_url, but the same resource (function call) is often made available under later versions (specified_url). To access the latest version of all endpoints use the latest version available on your OBP instance e.g. /obp/v3.1.0 - To get the original version use the request_url. We recommend to use the specified_url since non semantic improvements are more likely to be applied to later implementations of the call.
- summary is a short description inline with the swagger terminology.
- description may contain html markup (generated from markdown on the server).
Authentication is Mandatory
URL Parameters:
JSON response body fields:
connector_methods: connector_methods
description: This an optional field. Maximum length is 2000. It can be any characters here.
description_markdown: description_markdown
error_response_bodies: 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.
example_request_body: {"name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
function: function
implemented_by: implemented_by
is_featured: false
operation_id: OBPv4.0.0-getBanks
request_url: /my_user/MY_USER_ID
request_verb: POST
resource_docs: resource_docs
role:
success_response_body: {"my_user_id": "some_id_value", "name": "Jhon", "age": 12, "hobby": ["coding"],"optional_fields": ["hobby"]}
tags: Create-My-User
typed_request_body: typed_request_body
typed_success_response_body: typed_success_response_body
created_by_bank_id: created_by_bank_id
meta:
roles: CanCreateMyUser
{
"resource_docs":[{
"operation_id":"OBPv1.4.0-testResourceDoc",
"implemented_by":{
"version":"OBPv1.4.0",
"function":"testResourceDoc"
},
"request_verb":"GET",
"request_url":"/dummy",
"summary":"Test Resource Doc",
"description":"<p>I am only a test Resource Doc</p>\n<p>Authentication is Mandatory</p>\n<p><strong>JSON response body fields:</strong></p>\n",
"description_markdown":"I am only a test Resource Doc\n\nAuthentication is Mandatory\n\n\n**JSON response body fields:**\n\n\n",
"example_request_body":{
"jsonString":"{}"
},
"success_response_body":{
"jsonString":"{}"
},
"error_response_bodies":["OBP-50000: Unknown Error.","OBP-20001: User not logged in. Authentication is required!","OBP-20006: User is missing one or more roles: "],
"tags":["Documentation"],
"typed_request_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"typed_success_response_body":{
"type":"object",
"properties":{
"jsonString":{
"type":"string"
}
}
},
"roles":[{
"role":"CanGetCustomers",
"requires_bank_id":true
}],
"is_featured":false,
"special_instructions":"",
"specified_url":"",
"connector_methods":[]
}]
}
-
CanReadResourceDoc
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Swagger documentation
Returns 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=getBanks,bankById
(Each endpoint is implemented in the OBP Scala code by a 'function')
See the Resource Doc endpoint for more information.
Note: Resource Docs are cached, TTL is 3600 seconds
Following are more examples:
https://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger
https://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank
https://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?functions=getBanks,bankById
https://obp-api-sandbox.nmbbank.co.tz/obp/v3.1.0/resource-docs/v3.1.0/swagger?tags=Account,Bank,PSD2&functions=getBanks,bankById
Authentication is Optional
URL Parameters:
JSON response body fields:
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get scanned API Versions
Get all the scanned API Versions.
Authentication is Optional
JSON response body fields:
{
"scanned_api_versions":[{
"urlPrefix":"obp",
"apiStandard":"obp",
"apiShortVersion":"v3.1.0",
"API_VERSION":"v3.1.0"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.