API Explorer

⯆

API Explorer

My Collections

API
- Get API Info (root)
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
Account Public
- Get Public Accounts at Bank
- Get Public Accounts at all Banks
Bank
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
- Get Transaction Types at Bank
Bank Accounts (Dynamic Endpoint)
- Get Bank Account By Id
- Post Accounts
Branch
- Get Bank Branches
Card
- Get cards for the current user
- Get cards for the specified bank
Counterparty
- 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 Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
Customer Message
- Create Customer Message
- Get Customer Messages for all Customers
Data Warehouse
- Search Warehouse Data Via Elasticsearch
Documentation
- Get Bank Level Dynamic Resource Docs
- Get Resource Docs
- Get Resource Docs
- Get Swagger documentation
Dynamic Resource Doc
- A test endpoint
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
Metric
- Search API Metrics via Elasticsearch
Person
- Get all customers for logged in user
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get all Entitlements
Transaction
- 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
- Get Transaction Request Types for Account
User
- Create User
- Get User (Current)
- Get Users by Email Address
View Custom
- 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
_Covid APIDays
- Create new Covid APIDays
- Delete Covid APIDays by id
- Get Covid APIDays List
- Get Covid APIDays by id
- Update Covid APIDays
_Customer Cars
- Create new Customer Cars
- Delete Customer Cars by id
- Get Customer Cars List
- Get Customer Cars by id
- Update Customer Cars
_D Entity1(gh.29.uk)
- Create new D Entity1
- Delete D Entity1 by id
- Get D Entity1 List
- Get D Entity1 by id
- Update D Entity1
_Fish Port
- Create new Fish Port
- Delete Fish Port by id
- Get Fish Port List
- Get Fish Port by id
- Update Fish Port
_Foo Bar
- Create new Foo Bar
- Delete Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Update Foo Bar
_Insurance Policy(gh.29.uk)
- Create new Insurance Policy
- Delete Insurance Policy by id
- Get Insurance Policy List
- Get Insurance Policy by id
- Update Insurance Policy
_Insurance Premium(gh.29.uk)
- Create new Insurance Premium
- Delete Insurance Premium by id
- Get Insurance Premium List
- Get Insurance Premium by id
- Update Insurance Premium
_March Hare(gh.29.uk)
- Create new March Hare
- Delete March Hare by id
- Get March Hare List
- Get March Hare by id
- Update March Hare
_Obp Activity(obp.testing.01)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity
_Odometer(gh.29.uk)
- Create new Odometer
- Delete Odometer by id
- Get Odometer List
- Get Odometer by id
- Update Odometer
_Simon Covid
- Create new Simon Covid
- Delete Simon Covid by id
- Get Simon Covid List
- Get Simon Covid by id
- Update Simon Covid
_Sustrans
- Create new Sustrans
- Delete Sustrans by id
- Get Sustrans List
- Get Sustrans by id
- Update Sustrans
_Test Daniel707
- Create new My Test Daniel707
- Create new Test Daniel707
- Delete My Test Daniel707 by id
- Delete Test Daniel707 by id
- Get My Test Daniel707 List
- Get My Test Daniel707 by id
- Get Test Daniel707 List
- Get Test Daniel707 by id
- Update My Test Daniel707
- Update Test Daniel707
_Test1
- Create new Test1
- Delete Test1 by id
- Get Test1 List
- Get Test1 by id
- Update Test1

v2.0.0 (189 APIs)

API Host: https://apisandbox.openbankproject.com

Get API Info (root)

Returns information about:

API version
Hosted by information
Git Commit

Authentication is Optional

JSON response body fields:

connector: connector

email: felixsmith@example.com

git_commit: 59623811dd8a41f6ffe67be46954eee11913dc28

organisation:

organisation_website:

version_status:

Typical Successful Response:

								
									{
  "version":"String",
  "version_status":"String",
  "git_commit":"String",
  "connector":"String",
  "hosted_by":{
    "organisation":"String",
    "email":"String",
    "phone":"String",
    "organisation_website":"String"
  }
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-50000: Unknown Error.
no connector set

Connector Methods:

Version: OBPv2.0.0, function_name: by root, operation_id: OBPv2.0.0-root Tags: API,

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.
API_Explorer Commit