API Explorer

⯆

API Explorer

My Collections

API
- The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeably
  More...
- 获取API信息（根）
- 获取API配置
- 获取JSON Web密钥（JWK）
- 获取JSON Web密钥（JWK）URI
- 获取当前通话的通话上下文
- 获取连接器状态（环回）
- 获取适配器信息
- 获取速率限制信息
- 获取银行的适配器信息
ATM
Account
- The thing that tokens of value (money) come in and out of. An account has one or more `owners` which
  More...
- 创建帐号
- 创建帐户属性
- 创建帐户（POST）
- 在所有银行（私人）获取帐户
- 在银行获取Firehose帐户
- 在银行获取帐户。
- 在银行获取帐户（仅ID）。
- 在银行获取帐户（最低）。
- 按ID获取帐户（完整）
- 按ID获取帐户（核心）
- 更新帐户属性
- 更新帐户标签。
- 更新账户。
- 查看可用资金
- 获取帐户余额
- 获取持有的帐户
- 获取支票簿订单
Account Application
Account Metadata
Account Public
Bank
- A Bank (aka Space) represents a financial institution, brand or organizational unit under which res
  More...
- 取得银行
- 建立银行
- 映射（类型->字符串）
- 映射（类型->字符串）
- 获取银行
Branch
Card
Consent
- Consents provide a mechanism by which a third party App or User can access resources on behalf of a
  More...
- 取得同意
- 回答同意挑战
- 建立同意书（EMAIL）
- 建立同意书（SMS）
- 撤销同意
Consumer
- The "consumer" of the API, i.e. the web, mobile or serverside "App" that calls on the OBP API on be
  More...
- 启用或禁用消费者
- 吸引消费者
- 吸引消费者
- 吸引消费者（登录用户）
- 更新使用者RedirectUrl
- 获取消费者的通话限制
- 设置消费者的通话限制
Counterparty
Counterparty Metadata
Customer
Customer Meeting
Customer Message
Data Warehouse
Direct Debit
Documentation
Dynamic Entity
FX
KYC
Method Routing
- Open Bank Project can have different connectors, to connect difference data sources. We support
  More...
- 删除方法
- 更新方法
- 添加方法
- 获取MethodRoutings
Metric
Product
Product Collection
Role
Sandbox
- 创建沙箱
Scope
Standing Order
System View
Transaction
- Transactions are records of successful movements of value into or out of an `Account`. OBP Transac
  More...
- 获取其他交易帐户
- 获取帐户交易（完整）
- 获取帐户交易（核心）
- 获取帐户的Firehose交易
- 通过ID获取交易。
Transaction Metadata
Transaction Request
User
- The entity that accesses the API with a login / authorisation token and has access to zero or more
  More...
- 创建密码重置网址
- 创建用户。
- 创建用户身份验证上下文
- 创建用户身份验证上下文更新
- 删除用户的身份验证上下文
- 删除用户身份验证上下文
- 刷新用户。
- 回答身份验证上下文更新挑战
- 获取所有用户
- 获取用户身份验证上下文
- 获取用户锁定状态
- 获取用户（当前）
- 解锁用户
- 通过USERNAME获取用户
- 通过USER_ID获取用户
- 通过电子邮件地址获取用户
View
WebUi Props
Webhook

Log off

v5.1.0 (267 APIs)

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

创建账户申请

身份验证是强制性的

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"GENODEM1GLS",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"eveline@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-18T22:00:00Z"
    },
    "date_of_birth":"2017-09-18T22:00:00Z",
    "relationship_status":"single",
    "dependants":10,
    "dob_of_dependants":["2017-09-18T22:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-18T22:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-18T22:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by createAccountApplication, operation_id: OBPv3.1.0-createAccountApplication Tags: Account-Application, Account, New-Style,

更新帐户申请状态

身份验证是强制性的

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"GENODEM1GLS",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"eveline@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-18T22:00:00Z"
    },
    "date_of_birth":"2017-09-18T22:00:00Z",
    "relationship_status":"single",
    "dependants":10,
    "dob_of_dependants":["2017-09-18T22:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-18T22:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-18T22:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by updateAccountApplicationStatus, operation_id: OBPv3.1.0-updateAccountApplicationStatus Tags: Account-Application, Account, New-Style,

获取帐户申请

获取帐户申请。

身份验证是强制性的

Typical Successful Response:

								
									{
  "account_applications":[{
    "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
    "product_code":"saveing1",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith"
    },
    "customer":{
      "bank_id":"GENODEM1GLS",
      "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "customer_number":"5987953",
      "legal_name":"Eveline Tripman",
      "mobile_phone_number":"+44 07972 444 876",
      "email":"eveline@example.com",
      "face_image":{
        "url":"www.openbankproject",
        "date":"2017-09-18T22:00:00Z"
      },
      "date_of_birth":"2017-09-18T22:00:00Z",
      "relationship_status":"single",
      "dependants":10,
      "dob_of_dependants":["2017-09-18T22:00:00Z"],
      "credit_rating":{
        "rating":"OBP",
        "source":"OBP"
      },
      "credit_limit":{
        "currency":"EUR",
        "amount":"10"
      },
      "highest_education_attained":"Master",
      "employment_status":"worker",
      "kyc_status":true,
      "last_ok_date":"2017-09-18T22:00:00Z",
      "title":"Dr.",
      "branch_id":"DERBY6",
      "name_suffix":"Sr"
    },
    "date_of_application":"2017-09-18T22:00:00Z",
    "status":"REQUESTED"
  }]
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by getAccountApplications, operation_id: OBPv3.1.0-getAccountApplications Tags: Account-Application, Account, New-Style,

通过ID获取帐户申请

获取帐户申请。

身份验证是强制性的

Typical Successful Response:

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"saveing1",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"GENODEM1GLS",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"eveline@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"2017-09-18T22:00:00Z"
    },
    "date_of_birth":"2017-09-18T22:00:00Z",
    "relationship_status":"single",
    "dependants":10,
    "dob_of_dependants":["2017-09-18T22:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"10"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":true,
    "last_ok_date":"2017-09-18T22:00:00Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"2017-09-18T22:00:00Z",
  "status":"REQUESTED"
}

Request Headers:

Response Headers:

Required Roles:

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: OBPv3.1.0, function_name: by getAccountApplication, operation_id: OBPv3.1.0-getAccountApplication Tags: Account-Application, Account, New-Style,

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

v5.1.0 (267 APIs)

创建账户申请

更新帐户申请状态

获取帐户申请

通过ID获取帐户申请