API Explorer

								
									{
  "account_application_id":"gc23a7e2-7dd2-4bdf-a0b4-ae31232a4763",
  "product_code":"1234BW",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith"
  },
  "customer":{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "legal_name":"Eveline Tripman",
    "mobile_phone_number":"+44 07972 444 876",
    "email":"felixsmith@example.com",
    "face_image":{
      "url":"www.openbankproject",
      "date":"1100-01-01T00:00:00Z"
    },
    "date_of_birth":"1100-01-01T00:00:00Z",
    "relationship_status":"single",
    "dependants":1,
    "dob_of_dependants":["1100-01-01T00:00:00Z"],
    "credit_rating":{
      "rating":"OBP",
      "source":"OBP"
    },
    "credit_limit":{
      "currency":"EUR",
      "amount":"0"
    },
    "highest_education_attained":"Master",
    "employment_status":"worker",
    "kyc_status":false,
    "last_ok_date":"2023-10-11T13:23:44Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "date_of_application":"1100-01-01T00: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.
OBP-20001: User not logged in. Authentication is required!

Connector Methods:

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

Create 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.

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON request body fields:

value: 5987953

JSON response body fields:

date: 2020-01-27

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

provider: ETHEREUM

user:

value: 5987953

Typical Successful Response:

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

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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-10001: Incorrect json format.
OBP-30022: The current view does not have the permission:
OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by addTagForViewOnAccount, operation_id: OBPv4.0.0-addTagForViewOnAccount Tags: Account-Metadata, Account,

Create Bank

Create a new bank (Authenticated access).

The user creating this will be automatically assigned the Role CanCreateEntitlementAtOneBank.
Thus the User can manage the bank they create and assign Roles to other Users.

Only SANDBOX mode
The settlement accounts are created specified by the bank in the POST body.
Name and account id are created in accordance to the next rules:
- Incoming account (name: Default incoming settlement account, Account ID: OBP_DEFAULT_INCOMING_ACCOUNT_ID, currency: EUR)
- Outgoing account (name: Default outgoing settlement account, Account ID: OBP_DEFAULT_OUTGOING_ACCOUNT_ID, currency: EUR)

Authentication is Mandatory

JSON request body fields:

address:

bank_code: CGHZ

scheme: scheme value

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

website: www.openbankproject.com

JSON response body fields:

address:

bank_code: CGHZ

bank_routings: bank routing in form of (scheme, address)

full_name: full name string

id: d8839721-ad8f-45dd-9f78-2080414b93f9

logo: logo url

name: ACCOUNT_MANAGEMENT_FEE

scheme: scheme value

value: 5987953

website: www.openbankproject.com

attributes: attribute value in form of (name, value)

Typical Successful Response:

								
									{
  "id":"gh.29.uk",
  "bank_code":"CGHZ",
  "full_name":"bank fullName string",
  "logo":"bank logoUrl string",
  "website":"bank logoUrl string",
  "bank_routings":[{
    "scheme":"scheme value",
    "address":""
  }],
  "attributes":[{
    "name":"ACCOUNT_MANAGEMENT_FEE",
    "value":"5987953"
  }]
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBank - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-10001: Incorrect json format.
OBP-20001: User not logged in. Authentication is required!
OBP-30210: Insufficient authorisation to Create Bank. You do not have the role CanCreateBank.
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.0.0, function_name: by createBank, operation_id: OBPv5.0.0-createBank Tags: Bank,

Create Card

Create Card at bank specified by BANK_ID .

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

allows: [credit,debit,cash_withdrawal]

brand: Visa

card_number: 364435172576215

card_type: Credit

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

enabled: false

expires_date: 2021-01-27

issue_number: 1

name_on_card: SusanSmith

networks:

pin_reset:

reason_requested:

requested_date: 2020-01-27

serial_number: 1324234

technology: technology1

valid_from_date: 2020-01-27

collected: 2020-01-27

posted: 2020-01-27

replacement:

JSON response body fields:

account:

alias:

allows: [credit,debit,cash_withdrawal]

bank_id: gh.29.uk

brand: Visa

can_add_comment:

can_add_corporate_location:

can_add_image:

can_add_image_url: false

can_add_more_info: false

can_add_open_corporates_url:

can_add_physical_location:

can_add_private_alias:

can_add_public_alias:

can_add_tag: false

can_add_url:

can_add_where_tag:

can_delete_comment:

can_delete_corporate_location: false

can_delete_image: false

can_delete_physical_location:

can_delete_tag:

can_delete_where_tag: false

can_edit_owner_comment: false

can_see_bank_account_balance:

can_see_bank_account_bank_name: false

can_see_bank_account_currency:

can_see_bank_account_iban:

can_see_bank_account_label: false

can_see_bank_account_national_identifier:

can_see_bank_account_number: false

can_see_bank_account_owners: false

can_see_bank_account_swift_bic:

can_see_bank_account_type:

can_see_comments:

can_see_corporate_location: false

can_see_image_url: false

can_see_images: false

can_see_more_info:

can_see_open_corporates_url:

can_see_other_account_bank_name:

can_see_other_account_iban:

can_see_other_account_kind:

can_see_other_account_metadata:

can_see_other_account_national_identifier: false

can_see_other_account_number: false

can_see_other_account_swift_bic: false

can_see_owner_comment:

can_see_physical_location:

can_see_private_alias:

can_see_public_alias:

can_see_tags:

can_see_transaction_amount: false

can_see_transaction_balance:

can_see_transaction_currency:

can_see_transaction_description: false

can_see_transaction_finish_date:

can_see_transaction_metadata:

can_see_transaction_other_bank_account:

can_see_transaction_start_date:

can_see_transaction_this_bank_account:

can_see_transaction_type:

can_see_url: false

can_see_where_tag: false

cancelled: false

card_id: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

card_number: 364435172576215

card_type: Credit

collected: 2020-01-27

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

cvv: 123

description: This an optional field. Maximum length is 2000. It can be any characters here.

enabled: false

expires_date: 2021-01-27

hide_metadata_if_alias_used: false

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: false

issue_number: 1

label: My Account

name_on_card: SusanSmith

networks:

on_hot_list: false

pin_reset:

posted: 2020-01-27

reason_requested:

replacement:

requested_date: 2020-01-27

serial_number: 1324234

short_name:

technology: technology1

valid_from_date: 2020-01-27

views_available:

Typical Successful Response:

								
									{
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "bank_id":"gh.29.uk",
  "card_number":"364435172576215",
  "card_type":"Credit",
  "name_on_card":"SusanSmith",
  "issue_number":"1",
  "serial_number":"1324234",
  "valid_from_date":"1100-01-01T00:00:00Z",
  "expires_date":"1100-01-01T00:00:00Z",
  "enabled":true,
  "cancelled":true,
  "on_hot_list":true,
  "technology":"technology1",
  "networks":[""],
  "allows":["credit","debit"],
  "account":{
    "id":"123",
    "label":"OBP",
    "views_available":[{
      "id":"123",
      "short_name":"short_name",
      "description":"description",
      "is_public":true,
      "alias":"None",
      "hide_metadata_if_alias_used":true,
      "can_add_comment":true,
      "can_add_corporate_location":true,
      "can_add_image":true,
      "can_add_image_url":true,
      "can_add_more_info":true,
      "can_add_open_corporates_url":true,
      "can_add_physical_location":true,
      "can_add_private_alias":true,
      "can_add_public_alias":true,
      "can_add_tag":true,
      "can_add_url":true,
      "can_add_where_tag":true,
      "can_delete_comment":true,
      "can_delete_corporate_location":true,
      "can_delete_image":true,
      "can_delete_physical_location":true,
      "can_delete_tag":true,
      "can_delete_where_tag":true,
      "can_edit_owner_comment":true,
      "can_see_bank_account_balance":true,
      "can_see_bank_account_bank_name":true,
      "can_see_bank_account_currency":true,
      "can_see_bank_account_iban":true,
      "can_see_bank_account_label":true,
      "can_see_bank_account_national_identifier":true,
      "can_see_bank_account_number":true,
      "can_see_bank_account_owners":true,
      "can_see_bank_account_swift_bic":true,
      "can_see_bank_account_type":true,
      "can_see_comments":true,
      "can_see_corporate_location":true,
      "can_see_image_url":true,
      "can_see_images":true,
      "can_see_more_info":true,
      "can_see_open_corporates_url":true,
      "can_see_other_account_bank_name":true,
      "can_see_other_account_iban":true,
      "can_see_other_account_kind":true,
      "can_see_other_account_metadata":true,
      "can_see_other_account_national_identifier":true,
      "can_see_other_account_number":true,
      "can_see_other_account_swift_bic":true,
      "can_see_owner_comment":true,
      "can_see_physical_location":true,
      "can_see_private_alias":true,
      "can_see_public_alias":true,
      "can_see_tags":true,
      "can_see_transaction_amount":true,
      "can_see_transaction_balance":true,
      "can_see_transaction_currency":true,
      "can_see_transaction_description":true,
      "can_see_transaction_finish_date":true,
      "can_see_transaction_metadata":true,
      "can_see_transaction_other_bank_account":true,
      "can_see_transaction_start_date":true,
      "can_see_transaction_this_bank_account":true,
      "can_see_transaction_type":true,
      "can_see_url":true,
      "can_see_where_tag":true
    }],
    "bank_id":"gh.29.uk"
  },
  "replacement":{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"RENEW"
  },
  "pin_reset":[{
    "requested_date":"1100-01-01T00:00:00Z",
    "reason_requested":"FORGOT"
  }],
  "collected":"1100-01-01T00:00:00Z",
  "posted":"1100-01-01T00:00:00Z",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "cvv":"123",
  "brand":"Visa"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCardsForBank - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20006: User is missing one or more roles:
OBP-10015: Allowed values are:
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv5.0.0, function_name: by addCardForBank, operation_id: OBPv5.0.0-addCardForBank Tags: Card,

Create Card Attribute

Card Attributes are used to describe a financial Product with a list of typed key value pairs.

Each Card Attribute is linked to its Card by CARD_ID

The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CARD_ID: 36f8a9e6-c2b1-407a-8bd0-421b7119307e

JSON request body fields:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

JSON response body fields:

name: ACCOUNT_MANAGEMENT_FEE

value: 5987953

Typical Successful Response:

								
									{
  "name":"OVERDRAFT_START_DATE",
  "card_id":"36f8a9e6-c2b1-407a-8bd0-421b7119307e ",
  "attribute_type":"DOUBLE",
  "bank_id":{
    "value":"gh.29.uk"
  },
  "value":"2012-04-23",
  "card_attribute_id":"b4e0352a-9a0f-4bfa-b30b-9003aa467f50"
}

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-10001: Incorrect json format.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv3.1.0, function_name: by createCardAttribute, operation_id: OBPv3.1.0-createCardAttribute Tags: Card,

Create Customer

The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z

Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

amount: 10.12

currency: EUR

date: 2020-01-27

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

source:

url: http://www.example.com/id-docs/123/image.png

branch_id: DERBY6

credit_limit:

credit_rating:

customer_number: 5987953

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-11T13:23:44.172Z

name_suffix: Sr

relationship_status: single

title: Dr.

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-11T13:23:44.172Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response:

								
									{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2023-10-11T13:23:44Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}

Request Headers:

Response Headers:

Required Roles:

CanCreateCustomer - Please login to request this Role
CanCreateCustomerAtAnyBank - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-10001: Incorrect json format.
OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
OBP-20005: User not found. Please specify a valid value for USER_ID.
OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
OBP-30024: Could not create Consumer
OBP-50000: Unknown Error.
OBP-20006: User is missing one or more roles:

Connector Methods:

Version: OBPv5.0.0, function_name: by createCustomer, operation_id: OBPv5.0.0-createCustomer Tags: Customer, Person,

Create Bank Level Dynamic Entity

Create a Bank Level DynamicEntity.

Authentication is Mandatory

Create a DynamicEntity. If creation is successful, the corresponding POST, GET, PUT and DELETE (Create, Read, Update, Delete or CRUD for short) endpoints will be generated automatically

The following field types are as supported:
[number, integer, boolean, string, DATE_WITH_DAY, reference]

The DATE_WITH_DAY format is: yyyy-MM-dd

Reference types are like foreign keys and composite foreign keys are supported. The value you need to supply as the (composite) foreign key is a UUID (or several UUIDs in the case of a composite key) that match value in another Entity..
The following list shows all the possible reference types in the system with corresponding examples values so you can see how to construct each reference type value.

"someField0": {
    "type": "reference:FooBar",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField1": {
    "type": "reference:risk_checks",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField2": {
    "type": "reference:BookMarkBankAndAccount",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField3": {
    "type": "reference:risk_check",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField4": {
    "type": "reference:BookMarkBankAndAccount_system",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField5": {
    "type": "reference:Hospital",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField6": {
    "type": "reference:Bank",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField7": {
    "type": "reference:Consumer",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField8": {
    "type": "reference:Customer",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField9": {
    "type": "reference:MethodRouting",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField10": {
    "type": "reference:DynamicEntity",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField11": {
    "type": "reference:TransactionRequest",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField12": {
    "type": "reference:ProductAttribute",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField13": {
    "type": "reference:AccountAttribute",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField14": {
    "type": "reference:TransactionAttribute",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField15": {
    "type": "reference:CustomerAttribute",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField16": {
    "type": "reference:AccountApplication",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField17": {
    "type": "reference:CardAttribute",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField18": {
    "type": "reference:Counterparty",
    "example": "9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff"
}

"someField19": {
    "type": "reference:Branch:bankId&branchId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&branchId=76a7750d-6750-4970-b705-6b03aec2e0ad"
}

"someField20": {
    "type": "reference:Atm:bankId&atmId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&atmId=76a7750d-6750-4970-b705-6b03aec2e0ad"
}

"someField21": {
    "type": "reference:BankAccount:bankId&accountId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&accountId=76a7750d-6750-4970-b705-6b03aec2e0ad"
}

"someField22": {
    "type": "reference:Product:bankId&productCode",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&productCode=76a7750d-6750-4970-b705-6b03aec2e0ad"
}

"someField23": {
    "type": "reference:PhysicalCard:bankId&cardId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&cardId=76a7750d-6750-4970-b705-6b03aec2e0ad"
}

"someField24": {
    "type": "reference:Transaction:bankId&accountId&transactionId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&accountId=76a7750d-6750-4970-b705-6b03aec2e0ad&transactionId=f3779061-4be7-4308-947d-e368c1287634"
}

"someField25": {
    "type": "reference:Counterparty:bankId&accountId&counterpartyId",
    "example": "bankId=9ad7bd25-48e9-4f1c-a3cb-f9fb78cf35ff&accountId=76a7750d-6750-4970-b705-6b03aec2e0ad&counterpartyId=f3779061-4be7-4308-947d-e368c1287634"
}

Note: if you set hasPersonalEntity = false, then OBP will not generate the CRUD my FooBar endpoints.

Typical Successful Response:

								
									{
  "bankId":"gh.29.uk",
  "FooBar":{
    "description":"description of this entity, can be markdown text.",
    "required":["name"],
    "properties":{
      "name":{
        "type":"string",
        "minLength":3,
        "maxLength":20,
        "example":"James Brown",
        "description":"description of **name** field, can be markdown text."
      },
      "number":{
        "type":"integer",
        "example":698761728,
        "description":"description of **number** field, can be markdown text."
      }
    }
  },
  "dynamicEntityId":"dynamic-entity-id",
  "userId":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "hasPersonalEntity":true
}

Request Headers:

Response Headers:

Required Roles:

CanCreateBankLevelDynamicEntity - Please login to request this Role

Validations:

Required JSON Validation: No
Allowed Authentication Types: Not set

Possible Errors:

OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
OBP-20001: User not logged in. Authentication is required!
OBP-20006: User is missing one or more roles:
OBP-10001: Incorrect json format.
OBP-50000: Unknown Error.

Connector Methods:

Version: OBPv4.0.0, function_name: by createBankLevelDynamicEntity, operation_id: OBPv4.0.0-createBankLevelDynamicEntity Tags: Dynamic-Entity-Manage, 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

v5.1.0 (7 APIs)

Create Account Application

Create a tag on account

Create Bank

Create Card

Create Card Attribute

Create Customer

Create Bank Level Dynamic Entity