-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Rate Limiting Info
-
-
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
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
-
-
Bank
-
A Bank (aka Space) represents a financial institution, brand or organizational unit under which resMore...
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
-
-
Consent
-
Consents provide a mechanism by which a third party App or User can access resources on behalf of aMore...
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
-
-
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)
- Set Rate Limiting (call limits) per Consumer
- Update Consumer RedirectUrl
-
-
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 Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- 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
-
-
Method Routing
-
Open Bank Project can have different connectors, to connect difference data sources. We supportMore...
- Create MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
-
-
Role
- Add Entitlement for a User
- 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 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...
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
-
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 Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
-
User
-
The entity that accesses the API with a login / authorisation token and has access to zero or moreMore...
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
-
-
API
- Get API Configuration
- Get API Info (root)
- Get Adapter Info
- Get Adapter Info for a bank
- Get Connector Status (Loopback)
- Get JSON Web Key (JWK)
- Get JSON Web Key (JWK) URIs
- Get Rate Limiting Info
-
ATM
-
Account
- Check Available Funds
- Create Account
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
-
Account Application
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
-
Account Public
-
Bank
-
Branch
-
Card
- Create Card
- Create Card Attribute
- Delete Card
- 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
-
Consent
- Answer Consent Challenge
- Create Consent (EMAIL)
- Create Consent (IMPLICIT)
- Create Consent (SMS)
- Get Consents
- Revoke Consent
-
Consumer
- Enable or Disable Consumers
- Get Call Limits for a Consumer
- Get Consumer
- Get Consumers
- Get Consumers (logged in User)
- Set Rate Limiting (call limits) per Consumer
- Update Consumer RedirectUrl
-
Counterparty
- Create Counterparty (Explicit)
- Get Counterparties (Explicit)
- Get Counterparty by Counterparty Id (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
- Create Address
- Create Customer
- Create Customer Social Media Handle
- Create Tax Residence
- Create User Customer Link
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers for Current User
- Get Customers for current User at Bank
- Get Firehose Customers
- Get Tax Residences of Customer
- 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
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
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
-
Dynamic Resource Doc
-
Example Title
-
FX
-
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
-
Method Routing
-
Metric
- Get Aggregate Metrics
- Get Connector Metrics
- Get Metrics
- Get Top APIs
- Get Top Consumers
- Search API Metrics via Elasticsearch
-
Product
- Create Product
- Create Product Attribute
- Delete Product Attribute
- Get Bank Product
- Get Product Attribute
- Get Product Tree
- Get Products
- Update Product Attribute
-
Product Collection
-
Role
- Add Entitlement for a User
- 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 for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
-
Sandbox
-
Scope
-
Swagger Call getBanks
-
Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
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 Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Delete User Auth Context
- Delete User's Auth Contexts
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Refresh User
- Unlock the user
-
View Custom
- Create Custom View
- Delete Custom View
- Get Account access for User
- Get Views for Account
- Get access
- Grant User access to View
- Grant User access to a list of views
- Revoke access to all Views on Account
- Revoke access to one View
- Update Custom View
-
View System
-
WebUi Props
-
Webhook
-
_Credit Application Form
- Create new Credit Application Form
- Delete Credit Application Form by id
- Get Credit Application Form List
- Get Credit Application Form by id
- Update Credit Application Form
-
_TESTING
v3.1.0 (266 APIs)
Add Entitlement for a User
Create Entitlement. Grant Role to User.
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is required and the user needs to be a Super Admin. Super Admins are listed in the Props file.
Authentication is Mandatory
URL Parameters:
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON request body fields:
bank_id: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}
-
CanCreateEntitlementAtOneBank
- Please login to request this Role
-
CanCreateEntitlementAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-20050: Current User is not a Super Admin!
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30216: Entitlement already exists for the user.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Create Entitlement Request for current User
Create Entitlement Request.
Any logged in User can use this endpoint to request an Entitlement
Entitlements are used to grant System or Bank level roles to Users. (For Account level privileges, see Views)
For a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
For a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
Authentication is Mandatory
JSON request body fields:
bank_id: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
list:
provider: ETHEREUM
user:
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
username: felixsmith
{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"1100-01-01T00:00:00Z"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-10001: Incorrect json format.
- OBP-10007: Incorrect Role name:
- OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
- OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
- OBP-30214: Entitlement Request already exists for the user.
- OBP-30217: Entitlement Request cannot be added.
- OBP-50000: Unknown Error.
Delete Entitlement
Delete Entitlement specified by ENTITLEMENT_ID for an user specified by USER_ID
Authentication is required and the user needs to be a Super Admin.
Super Admins are listed in the Props file.
Authentication is Mandatory
URL Parameters:
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
{
"jsonString":"{}"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-30212: EntitlementId not found
- OBP-50000: Unknown Error.
Delete Entitlement Request
Delete the Entitlement Request specified by ENTITLEMENT_REQUEST_ID for a user specified by USER_ID
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
CanDeleteEntitlementRequestsAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Entitlement Requests for a User
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"1100-01-01T00:00:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Entitlement Requests for the current User
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"1100-01-01T00:00:00Z"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Entitlements for User
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Entitlements for User at Bank
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
-
CanGetEntitlementsForAnyUserAtOneBank
- Please login to request this Role
-
CanGetEntitlementsForAnyUserAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Entitlements for the current User
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
Get Roles
{
"roles":[{
"role":"CanCreateBranch",
"requires_bank_id":true
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get all Entitlement Requests
{
"entitlement_requests":[{
"entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"user":{
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"email":"felixsmith@example.com",
"provider_id":"Chris",
"provider":"http://127.0.0.1:8080",
"username":"felixsmith",
"entitlements":{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
},
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk",
"created":"1100-01-01T00:00:00Z"
}]
}
-
CanGetEntitlementRequestsAtAnyBank
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50200: Connector cannot return the data we requested.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get all Entitlements
{
"list":[{
"entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
"role_name":"CanQueryOtherUser",
"bank_id":"gh.29.uk"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.