API Explorer

⯆

API Explorer

My Collections

API
- Get API Configuration
- Get API Info (root)
ATM
- Create ATM
- Get Bank ATM
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- 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
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Bank ATMS
- Get Banks
- Get Transaction Types at Bank
Branch
- Create Branch
- Get Bank Branch
- Get Bank Branches
- Update Branch
Card
- Create Card
- Get cards for the current user
- Get cards for the specified bank
Consumer
- Enable or Disable Consumers
- Get Consumer
- Get Consumers
- Post 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
- Create Customer
- Create Customer Social Media Handle
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for current User at Bank
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 Message Docs
- Get Resource Docs
- Get Resource Docs
- Get Swagger documentation
Dynamic Resource Doc
- A test endpoint
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
Metric
- Get Connector Metrics
- Get Metrics
- Search API Metrics via Elasticsearch
Product
- Create Product
- Get Bank Product
- Get Bank Products
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Roles
- Get all Entitlements
Sandbox
- Create sandbox
Transaction
- Get Other Account of Transaction
- Get Transaction by Id
- 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
User
- Create User
- Get User (Current)
- Get Users by Email Address
- Get all Users
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
_Authority Data Request
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(000202)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(ADOPEM)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(APAP)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(BANRESERVAS)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(BHD LEON)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(CONFISA)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(POPULAR)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(SCOTIABANK)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Authority Data Request(brrd 01)
- Create new Authority Data Request
- Delete Authority Data Request by id
- Get Authority Data Request List
- Get Authority Data Request by id
- Update Authority Data Request
_Foo Bar
- Create new Foo Bar
- Delete Foo Bar by id
- Get Foo Bar List
- Get Foo Bar by id
- Update Foo Bar
_Obp Activity(trn.34.my.strings)
- Create new Obp Activity
- Delete Obp Activity by id
- Get Obp Activity List
- Get Obp Activity by id
- Update Obp Activity

v2.2.0 (203 APIs)

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

Get API Configuration

Returns information about:

API Config
Akka ports
Elastic search ports
Cached function

Authentication is Mandatory

JSON response body fields:

elastic_search:

function_name:

require_scopes_for_all_roles:

require_scopes_for_listed_roles: false

ttl_in_seconds:

value: 5987953

remote_data_secret_matched: remote_data_secret_matched

Typical Successful Response:

								
									{
  "akka":{
    "ports":[{
      "property":"default",
      "value":"8080"
    }],
    "log_level":"Debug",
    "remote_data_secret_matched":true
  },
  "elastic_search":{
    "metrics":[{
      "property":"String",
      "value":"Mapper"
    }],
    "warehouse":[{
      "property":"String",
      "value":"ElasticSearch"
    }]
  },
  "cache":[{
    "function_name":"getBanks",
    "ttl_in_seconds":5
  }],
  "scopes":{
    "require_scopes_for_all_roles":true,
    "require_scopes_for_listed_roles":["CanCreateUserAuthContextUpdate"]
  }
}

Request Headers:

Response Headers:

Required Roles:

CanGetConfig - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv2.2.0, function_name: by config, operation_id: OBPv2.2.0-config Tags: API,

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.2.0, function_name: by root, operation_id: OBPv2.2.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