API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- Get API Info (root)
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- 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
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- Get Bank
- Get Bank ATMS
- Get Bank Products
- Get Banks
- Get Transaction Types at Bank
Branch
- Get Bank Branches
Card
Counterparty
Counterparty Metadata
Customer
- The legal entity that has the relationship to the bank. Customers are linked to Users via `User Cus
  More...
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
Customer Meeting
Customer Message
Data Warehouse
- Search Warehouse Data Via Elasticsearch
Documentation
KYC
Metric
- Search API Metrics via Elasticsearch
Person
- Get all customers for logged in user
Role
Transaction
- Records of successful movements of money from / to an `Account`. OBP Transactions don't contain any
  More...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
Transaction Metadata
Transaction Request
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- Create User
- Get User (Current)
- Get Users by Email Address
View Custom

Log off

v2.0.0 (116 APIs)

Anfitrión de la API: https://api3.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

Respuesta Exitosa Típica:

								
									{
  "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:

Roles Requeridos:

Validaciones:

Required JSON Validation: No
Allowed Authentication Types: Not set

Posibles Errores:

OBP-50000: Unknown Error.
no connector set

Métodos de conector::

Version: OBPv1.2.1, function_name: by root, operation_id: OBPv1.2.1-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

Featured APIs

API Explorer

v2.0.0 (116 APIs)

Get API Info (root)