API Explorer

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
- Get the Call Context of a current call
ATM
- Create ATM
- Get Bank ATM
- Get Bank ATMS
Account
- Check Available Funds
- Create Account
- Create Account (POST)
- Create Account Attribute
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank (IDs only).
- Get Accounts at Bank (Minimal).
- Get Accounts at Bank.
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account Attribute
- Update Account Label.
- Update Account.
Account Access
- Grant User access to View.
- Revoke User access to View.
Account Application
- Create Account Application
- Get Account Application by Id
- Get Account Applications
- Update Account Application Status
Account Metadata
- Add a tag on account.
- Delete a tag on account.
- Get tags on account.
Account Public
- Get Public Account by Id
- Get Public Accounts at Bank
- Get Public Accounts at all Banks.
Bank
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Banks
- Get Transaction Types at Bank
Branch
- Create Branch
- Delete Branch
- Get Branch
- Get Branches for a Bank
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 (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 Calls Limit for a 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
- Add Address to Customer
- Add Social Media Handle
- Add Tax Residence to Customer
- Create Credit Limit Order Request
- Create Customer.
- Create User Customer Link.
- Delete Customer Address
- Delete Tax Residence
- Get CRM Events
- Get Credit Limit Order Request By Request Id
- Get Credit Limit Order Requests
- Get Customer Addresses
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers by MOBILE_PHONE_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
- Create Meeting (video conference/call)
- Get Meeting
- Get Meetings
Customer Message
- Create Customer Message.
- Get Customer Messages (current)
Data Warehouse
- Data Warehouse Search
- Data Warehouse Statistics
Direct Debit
- Create Direct Debit
- Create Direct Debit (management)
Documentation
- Get API Glossary
- Get Message Docs
- Get Message Docs Swagger
- Get Resource Docs.
- Get Swagger documentation
Dynamic Entity
- Create DynamicEntity
- Delete DynamicEntity
- Get DynamicEntities
- Update DynamicEntity
FX
- Create Fx
- Get Current FxRate
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
- Add MethodRouting
- Delete MethodRouting
- Get MethodRoutings
- Update MethodRouting
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
- Create Product Collection
- Get Product Collection
Role
- Add Entitlement Request for current User.
- Add Entitlement for a User.
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User.
- Get Entitlement Requests for the current 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
Sandbox
- Create sandbox
Scope
- Add Scope for a Consumer.
- Delete Consumer Scope
- Get Scopes for Consumer
Standing Order
- Create Standing Order
- Create Standing Order (management)
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 tag.
- Add an image.
- Add comment.
- Add narrative.
- Add where tag.
- Delete a tag.
- Delete an image
- Delete comment.
- Delete narrative.
- Delete where tag.
- Get comments.
- Get images.
- Get narrative.
- Get tags.
- Get where tag.
- Update narrative.
- Update where tag.
Transaction Request
- Answer Transaction Request Challenge.
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM).
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types for Account
- Get Transaction Requests.
- Get supported Transaction Request Types
- Save Historical Transactions
User
- Answer Auth Context Update Challenge
- Create User Auth Context
- Create User Auth Context Update
- Create User.
- Create password reset url
- 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 View.
- Delete View
- Get Account access for User.
- Get Views for Account.
- Get access.
- Grant User access to View.
- Revoke access to one View.
- Update View.
View (System)
- Create System View.
- Delete System View
- Get System View
- Update System View.
WebUi Props
- Add WebUiProps
- Delete WebUiProps
- Get WebUiProps
Webhook
- Create an Account Webhook
- Enable/Disable an Account Webhook
- Get Account Webhooks

Log off

v4.0.0 (266 APIs)

API Host: https://psd2-api.openbankproject.com

Add a tag on account.

Posts a tag about an account ACCOUNT_ID on a view VIEW_ID.

Authentication is Mandatory

Authentication is required as the tag is linked with the user.

Typical Successful Response:

								
									{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}

Headers:

Required Roles:

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-10001: Incorrect json format.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Connector Methods:

Implemented in OBPv4.0.0 by addTagForViewOnAccount

Delete a tag on account.

Deletes the tag TAG_ID about the account ACCOUNT_ID made on view.

Authentication is Mandatory

Authentication is required as the tag is linked with the user.

Typical Successful Response:

								
									{
  "jsonString":"{}"
}

Headers:

Required Roles:

Possible Errors:

OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Connector Methods:

Implemented in OBPv4.0.0 by deleteTagForViewOnAccount

Get tags on account.

Returns the account ACCOUNT_ID tags made on a view (VIEW_ID).
Authentication is Mandatory

Authentication is required as the tag is linked with the user.

Typical Successful Response:

								
									{
  "tags":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}

Headers:

Required Roles:

Possible Errors:

OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-30022: The current view does not have the permission:
OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
OBP-50000: Unknown Error.

Connector Methods:

Implemented in OBPv4.0.0 by getTagsForViewOnAccount

Get documentation about the selected endpoints as:

Resource Docs JSON
Swagger 2 JSON
中文版本
Partial Functions

Note: You can list just the APIs that are implemented in a certain version by appending &native=true to the index URL.

Featured APIs

API Explorer

v4.0.0 (266 APIs)

Add a tag on account.

Delete a tag on account.

Get tags on account.