API Explorer
- API
- ATM
-
Account
- Check Available Funds
- Create Account (POST)
- Create Account Attribute
- Create or Update Account Attribute Definition
- Delete Account Attribute Definition
- Delete Account Cascade
- Get Account Attribute Definition
- Get Account by Account Routing
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts Balances
- Get Accounts Held
- Get Accounts at Bank
- Get Accounts at Bank (IDs only)
- Get Accounts at Bank (Minimal)
- Get Accounts at all Banks (private)
- Get Checkbook orders
- Get Firehose Accounts at Bank
- Update Account
- Update Account Attribute
- Update Account Label
- Validate and check IBAN number
- Account Access
- Account Application
- Account Metadata
- Account Public
- Authentication Type Validation
- Bank
- Branch
- Card
- Consent
- Consumer
- Counterparty
-
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
- Add Social Media Handle
- Create Address
- Create Credit Limit Order Request
- Create Customer
- Create Customer Attribute
- Create Tax Residence
- Create User Customer Link
- Create or Update Customer Attribute Definition
- Delete Customer Address
- Delete Customer Attribute
- Delete Customer Attribute Definition
- Delete Tax Residence
- Delete User Customer Link
- Get CRM Events
- Get Credit Limit Order Request By Request Id
- Get Credit Limit Order Requests
- Get Customer Addresses
- Get Customer Attribute By Id
- Get Customer Attribute Definition
- Get Customer Attributes
- Get Customer Social Media Handles
- Get Customer by CUSTOMER_ID
- Get Customer by CUSTOMER_NUMBER
- Get Customers by ATTRIBUTES
- Get Customers by MOBILE_PHONE_NUMBER
- Get Customers for Current User
- Get Firehose Customers
- Get Tax Residences of Customer
- Get User Customer Links by Customer
- Get User Customer Links by User
- Update Customer Attribute
- Update the Address of a Customer
- Update the Branch of a Customer
- Update the credit limit of a Customer
- Update the credit rating and source of a Customer
- Update the email of a Customer
- Update the identity data of a Customer
- Update the mobile number of a Customer
- Update the number of a Customer
- Update the other data of a Customer
- Customer Meeting
- Customer Message
- Data Warehouse
- Direct Debit
- Documentation
- Dynamic Endpoint (Manage)
- Dynamic Entity (Manage)
- Example Title
- FX
- JSON Schema Validation
- KYC
- Method Routing
- Metric
- Product
- Product Collection
-
Role
- Add Entitlement for a User
- Create Entitlement Request for current User
- Delete Entitlement
- Delete Entitlement Request
- Get Entitlement Requests for a User
- Get Entitlement Requests for the current User
- Get Entitlements for One Bank
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Entitlements for the current User
- Get Roles
- Get all Entitlement Requests
- Get all Entitlements
- Sandbox
- Scope
- Standing Order
- Swagger Call getBanks
-
Transaction
- Create Transaction Attribute
- Create or Update Transaction Attribute Definition
- Delete Transaction Attribute Definition
- Delete Transaction Cascade
- Get Double Entry Transaction
- Get Firehose Transactions for Account
- Get Other Account of Transaction
- Get Transaction Attribute By Id
- Get Transaction Attribute Definition
- Get Transaction Attributes
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
- Update Transaction Attribute
- Transaction Metadata
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request (ACCOUNT)
- Create Transaction Request (ACCOUNT_OTP)
- Create Transaction Request (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (REFUND)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Create Transaction Request Attribute
- Create or Update Transaction Request Attribute Definition
- Delete Transaction Request Attribute Definition
- Get Transaction Request
- Get Transaction Request Attribute By Id
- Get Transaction Request Attribute Definition
- Get Transaction Request Attributes
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
- Save Historical Transactions
- Update Transaction Request Attribute
-
User
- Answer Auth Context Update Challenge
- Create User
- Create User Auth Context
- Create User Auth Context Update Request
- Create password reset url
- Delete User Auth Context
- Delete User's Auth Contexts
- Get Logout Link
- Get User (Current)
- Get User Auth Contexts
- Get User Lock Status
- Get User by USERNAME
- Get User by USER_ID
- Get Users by Email Address
- Get all Users
- Lock the user
- Refresh User
- Unlock the user
- View (Custom)
- View (System)
- WebUi Props
- Webhook
- _CreditApplicationForm
- _TESTING
-
API
-
Get API Configuration
-
Get API Info (root)
-
Get Adapter Info
-
Get Adapter Info for a bank
-
Get Connector Status (Loopback)
-
Get JSON Web Key (JWK)
-
Get JSON Web Key (JWK) URIs
-
Get Mapper Database Info
-
Get Rate Limiting Info
-
Get the Call Context of a current call
-
Get API Configuration
-
ATM
-
Account
-
Check Available Funds
-
Create Account (POST)
-
Create Account Attribute
-
Create or Update Account Attribute Definition
-
Delete Account Attribute Definition
-
Delete Account Cascade
-
Get Account Attribute Definition
-
Get Account by Account Routing
-
Get Account by Id (Core)
-
Get Account by Id (Full)
-
Get Accounts Balances
-
Get Accounts Held
-
Get Accounts at Bank
-
Get Accounts at Bank (IDs only)
-
Get Accounts at Bank (Minimal)
-
Get Accounts at all Banks (private)
-
Get Checkbook orders
-
Get Firehose Accounts at Bank
-
Update Account
-
Update Account Attribute
-
Update Account Label
-
Validate and check IBAN number
-
Check Available Funds
-
Account Access
-
Account Application
-
Create Account Application
-
Get Account Application by Id
-
Get Account Applications
-
Update Account Application Status
-
Create Account Application
-
Account Metadata
-
Account Public
-
Authentication Type Validation
-
Create a Authentication Type Validation
-
Delete a Authentication Type Validation
-
Get a Authentication Type Validation
-
Get all Authentication Type Validations
-
Update a Authentication Type Validation
-
Create a Authentication Type Validation
-
Bank
-
Create Bank
-
Create Settlement Account
-
Create Transaction Type at bank
-
Get Bank
-
Get Banks
-
Get Settlement accounts at Bank
-
Get Transaction Types at Bank
-
Create Bank
-
Branch
-
Card
-
Create Card
-
Create Card Attribute
-
Create or Update Card Attribute Definition
-
Delete Card
-
Delete Card Attribute Definition
-
Get Card Attribute Definition
-
Get Card By Id
-
Get Cards for the specified bank
-
Get cards for the current user
-
Get status of Credit Card order
-
Update Card
-
Update Card Attribute
-
Create Card
-
Consent
-
Add User to a Consent
-
Answer Consent Challenge
-
Create Consent (EMAIL)
-
Create Consent (SMS)
-
Get Consents
-
Revoke Consent
-
Update Consent Status
-
Add User to a Consent
-
Consumer
-
Enable or Disable Consumers
-
Get Call Limits for a Consumer
-
Get Consumer
-
Get Consumers
-
Get Consumers (logged in User)
-
Post a Consumer
-
Set Calls Limit for a Consumer
-
Update Consumer RedirectUrl
-
Enable or Disable Consumers
-
Counterparty
-
Create Counterparty (Explicit)
-
Create Counterparty for any account (Explicit)
-
Get Counterparties (Explicit)
-
Get Counterparty by Counterparty Id (Explicit)
-
Get Counterparty by name for any account (Explicit)
-
Get Other Account by Id
-
Get Other Accounts of one Account
-
Create Counterparty (Explicit)
-
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
-
Add Corporate Location to Counterparty
-
Customer
-
Add Social Media Handle
-
Create Address
-
Create Credit Limit Order Request
-
Create Customer
-
Create Customer Attribute
-
Create Tax Residence
-
Create User Customer Link
-
Create or Update Customer Attribute Definition
-
Delete Customer Address
-
Delete Customer Attribute
-
Delete Customer Attribute Definition
-
Delete Tax Residence
-
Delete User Customer Link
-
Get CRM Events
-
Get Credit Limit Order Request By Request Id
-
Get Credit Limit Order Requests
-
Get Customer Addresses
-
Get Customer Attribute By Id
-
Get Customer Attribute Definition
-
Get Customer Attributes
-
Get Customer Social Media Handles
-
Get Customer by CUSTOMER_ID
-
Get Customer by CUSTOMER_NUMBER
-
Get Customers by ATTRIBUTES
-
Get Customers by MOBILE_PHONE_NUMBER
-
Get Customers for Current User
-
Get Firehose Customers
-
Get Tax Residences of Customer
-
Get User Customer Links by Customer
-
Get User Customer Links by User
-
Update Customer Attribute
-
Update the Address of a Customer
-
Update the Branch of a Customer
-
Update the credit limit of a Customer
-
Update the credit rating and source of a Customer
-
Update the email of a Customer
-
Update the identity data of a Customer
-
Update the mobile number of a Customer
-
Update the number of a Customer
-
Update the other data of a Customer
-
Add Social Media Handle
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Direct Debit
-
Documentation
-
Get API Glossary
-
Get Message Docs
-
Get Message Docs Swagger
-
Get Resource Docs
-
Get Swagger documentation
-
Get scanned API Versions
-
Get API Glossary
-
Dynamic Endpoint (Manage)
-
Create Dynamic Endpoint
-
Delete Dynamic Endpoint
-
Get Dynamic Endpoint
-
Get Dynamic Endpoints
-
Delete My Dynamic Endpoint
-
Get My Dynamic Endpoints
-
Create Dynamic Endpoint
-
Dynamic Entity (Manage)
-
Create Dynamic Entity
-
Delete Dynamic Entity
-
Delete My Dynamic Entity
-
Get Bank Level Dynamic Entities
-
Get Dynamic Entities
-
Get My Dynamic Entities
-
Update Dynamic Entity
-
Update My Dynamic Entity
-
Create Dynamic Entity
-
Example Title
-
FX
-
JSON Schema Validation
-
Create a JSON Schema Validation
-
Delete a JSON Schema Validation
-
Get a JSON Schema Validation
-
Get all JSON Schema Validations
-
Update a JSON Schema Validation
-
Create a JSON Schema Validation
-
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
-
Add KYC Check
-
Method Routing
-
Metric
-
Get Aggregate Metrics
-
Get Connector Metrics
-
Get Metrics
-
Get Top APIs
-
Get Top Consumers
-
Search API Metrics via Elasticsearch
-
Get Aggregate Metrics
-
Product
-
Create Product
-
Create Product Attribute
-
Create or Update Product Attribute Definition
-
Delete Product Attribute
-
Delete Product Attribute Definition
-
Delete Product Cascade
-
Get Bank Product
-
Get Product Attribute
-
Get Product Attribute Definition
-
Get Product Tree
-
Get Products
-
Update Product Attribute
-
Create Product
-
Product Collection
-
Role
-
Add Entitlement for a User
-
Create Entitlement Request for current User
-
Delete Entitlement
-
Delete Entitlement Request
-
Get Entitlement Requests for a User
-
Get Entitlement Requests for the current User
-
Get Entitlements for One Bank
-
Get Entitlements for User
-
Get Entitlements for User at Bank
-
Get Entitlements for the current User
-
Get Roles
-
Get all Entitlement Requests
-
Get all Entitlements
-
Add Entitlement for a User
-
Sandbox
-
Scope
-
Standing Order
-
Swagger Call getBanks
-
Transaction
-
Create Transaction Attribute
-
Create or Update Transaction Attribute Definition
-
Delete Transaction Attribute Definition
-
Delete Transaction Cascade
-
Get Double Entry Transaction
-
Get Firehose Transactions for Account
-
Get Other Account of Transaction
-
Get Transaction Attribute By Id
-
Get Transaction Attribute Definition
-
Get Transaction Attributes
-
Get Transaction by Id
-
Get Transactions for Account (Core)
-
Get Transactions for Account (Full)
-
Update Transaction Attribute
-
Create Transaction Attribute
-
Transaction Metadata
-
Add a tag
-
Add an image
-
Add comment
-
Add narrative
-
Add where tag
-
Delete a tag
-
Delete an image
-
Delete comment
-
Delete narrative
-
Delete where tag
-
Get comments
-
Get images
-
Get narrative
-
Get tags
-
Get where tag
-
Update narrative
-
Update where tag
-
Add a tag
-
Transaction Request
-
Answer Transaction Request Challenge
-
Create Transaction Request (ACCOUNT)
-
Create Transaction Request (ACCOUNT_OTP)
-
Create Transaction Request (COUNTERPARTY)
-
Create Transaction Request (FREE_FORM)
-
Create Transaction Request (REFUND)
-
Create Transaction Request (SANDBOX_TAN)
-
Create Transaction Request (SEPA)
-
Create Transaction Request Attribute
-
Create or Update Transaction Request Attribute Definition
-
Delete Transaction Request Attribute Definition
-
Get Transaction Request
-
Get Transaction Request Attribute By Id
-
Get Transaction Request Attribute Definition
-
Get Transaction Request Attributes
-
Get Transaction Request Types at Bank
-
Get Transaction Request Types for Account
-
Get Transaction Requests
-
Save Historical Transactions
-
Update Transaction Request Attribute
-
Answer Transaction Request Challenge
-
User
-
Answer Auth Context Update Challenge
-
Create User
-
Create User Auth Context
-
Create User Auth Context Update Request
-
Create password reset url
-
Delete User Auth Context
-
Delete User's Auth Contexts
-
Get Logout Link
-
Get User (Current)
-
Get User Auth Contexts
-
Get User Lock Status
-
Get User by USERNAME
-
Get User by USER_ID
-
Get Users by Email Address
-
Get all Users
-
Lock the user
-
Refresh User
-
Unlock the user
-
Answer Auth Context Update Challenge
-
View (Custom)
-
View (System)
-
WebUi Props
-
Webhook
-
_CreditApplicationForm
-
Create new Credit Application Form
-
Delete Credit Application Form by id
-
Get Credit Application Form List
-
Get Credit Application Form by id
-
Update Credit Application Form
-
Create new Credit Application Form
-
_TESTING
v4.0.0 (353 APIs)
Add Social Media Handle
Add a social media handle for the customer specified by CUSTOMER_ID
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
- customer_number: 5987953
JSON response body fields:
{
"success":"Success"
}
-
CanAddSocialMediaHandle
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-20006: User is missing one or more roles:
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Create Address
Create an Address for a Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
insert_date: 2020-01-27
{
"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE",
"tags":["mailing","home"],
"status":"OK",
"insert_date":"2017-09-19T00:00:00Z"
}
-
CanCreateCustomerAddress
- Please login to request this Role
- 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.
Create Credit Limit Order Request
NOTE: This endpoint currently only returns example data.
Create credit limit order request
Authentication is Optional
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
JSON response body fields:
{
"execution_time":"String",
"execution_date":"String",
"token":"String",
"short_reference":"String"
}
- OBP-50000: Unknown Error.
Create Customer
The Customer resource stores the customer number, 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
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
amount: 10.12
-
branch_id: DERBY6
-
currency: EUR
-
date: 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanCreateCustomer
- Please login to request this Role
-
CanCreateCustomerAtAnyBank
- Please login to request this Role
- 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:
Create Customer Attribute
Create Customer Attribute
The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
- value: 5987953
JSON response body fields:
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
value: 5987953
{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}
-
CanCreateCustomerAttributeAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Create Tax Residence
Create a Tax Residence for a Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
JSON response body fields:
{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}
-
CanCreateTaxResidence
- Please login to request this Role
- 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.
Create User Customer Link
Link a User to a Customer
Authentication is Mandatory
CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"date_inserted":"2017-09-19T00:00:00Z",
"is_active":true
}
-
CanCreateUserCustomerLink
- Please login to request this Role
-
CanCreateUserCustomerLinkAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
- OBP-30025: Could not create user_customer_links
- OBP-50000: Unknown Error.
Create or Update Customer Attribute Definition
{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Customer",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}
-
CanCreateCustomerAttributeDefinitionAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Customer Address
Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"jsonString":"{}"
}
-
CanDeleteCustomerAddress
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Delete Customer Attribute
Delete Customer Attribute
CustomerAttributes are used to enhance the OBP Customer object with Bank specific entities.
Delete a Customer Attribute by its id.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"jsonString":"{}"
}
-
CanDeleteCustomerAttributeAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
Delete Customer Attribute Definition
Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
{
"jsonString":"{}"
}
-
CanDeleteCustomerAttributeDefinitionAtOneBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete Tax Residence
Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Delete User Customer Link
Delete User Customer Link by USER_CUSTOMER_LINK_ID
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
{
"jsonString":"{}"
}
-
CanDeleteUserCustomerLink
- Please login to request this Role
- 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-50000: Unknown Error.
Get CRM Events
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_number: 5987953
{
"crm_events":[{
"id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"bank_id":"gh.29.uk",
"customer_name":"String",
"customer_number":"5987953",
"category":"String",
"detail":"String",
"channel":"String",
"scheduled_date":"2017-09-19T00:00:00Z",
"actual_date":"2017-09-19T00:00:00Z",
"result":"String"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- No CRM Events available.
- OBP-50000: Unknown Error.
Get Credit Limit Order Request By Request Id
NOTE: This endpoint currently only returns example data.
Get Credit Limit Order Request By Request Id
Authentication is Optional
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"rank_amount_1":"String",
"nominal_interest_1":"String",
"rank_amount_2":"String",
"nominal_interest_2":"String"
}
- OBP-50000: Unknown Error.
Get Credit Limit Order Requests
NOTE: This endpoint currently only returns example data.
Get Credit Limit Order Requests
Authentication is Optional
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"rank_amount_1":"String",
"nominal_interest_1":"String",
"rank_amount_2":"String",
"nominal_interest_2":"String"
}
- OBP-50000: Unknown Error.
Get Customer Addresses
Get the Addresses of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
insert_date: 2020-01-27
{
"addresses":[{
"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE",
"tags":["mailing","home"],
"status":"OK",
"insert_date":"2017-09-19T00:00:00Z"
}]
}
-
CanGetCustomerAddress
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Customer Attribute By Id
Get Customer Attribute By Id
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
value: 5987953
{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}
-
CanGetCustomerAttributeAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customer Attribute Definition
{
"attributes":[{
"attribute_definition_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"bank_id":"gh.29.uk",
"name":"SPECIAL_TAX_NUMBER",
"category":"Customer",
"type":"STRING",
"description":"description",
"alias":"STRING",
"can_be_seen_on_views":["bank"],
"is_active":true
}]
}
-
CanGetCustomerAttributeDefinitionAtOneBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customer Attributes
Get Customer Attributes
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
value: 5987953
{
"customer_attributes":[{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}]
}
-
CanGetCustomerAttributesAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customer Social Media Handles
Get social media handles for a customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
- customer_number: 5987953
{
"checks":[{
"customer_number":"5987953",
"type":"PlaceholderString",
"handle":"PlaceholderString",
"date_added":"2017-09-19T00:00:00Z",
"date_activated":"2017-09-19T00:00:00Z"
}]
}
-
CanGetSocialMediaHandles
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
Get Customer by CUSTOMER_ID
Gets the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
amount: 10.12
-
bank_id: gh.29.uk
-
branch_id: DERBY6
-
currency: EUR
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
-
value: 5987953
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr",
"customer_attributes":[{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}]
}
-
CanGetCustomer
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customer by CUSTOMER_NUMBER
Gets the Customer specified by CUSTOMER_NUMBER.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
- customer_number: 5987953
JSON response body fields:
-
amount: 10.12
-
bank_id: gh.29.uk
-
branch_id: DERBY6
-
currency: EUR
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
-
value: 5987953
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr",
"customer_attributes":[{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}]
}
-
CanGetCustomer
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customers by ATTRIBUTES
Gets the Customers specified by attributes
URL params example: /banks/some-bank-id/customers?name=John&age=8
URL params example: /banks/some-bank-id/customers?manager=John&count=8
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
amount: 10.12
-
bank_id: gh.29.uk
-
branch_id: DERBY6
-
currency: EUR
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
-
value: 5987953
{
"customers":[{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr",
"customer_attributes":[{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}]
}]
}
-
CanGetCustomer
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customers by MOBILE_PHONE_NUMBER
Gets the Customers specified by MOBILE_PHONE_NUMBER.
There are two wildcards often used in conjunction with the LIKE operator:
% - The percent sign represents zero, one, or multiple characters
_ - The underscore represents a single character
For example {"customer_phone_number":"%381%"} lists all numbers which contain 381 sequence
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Customers for Current User
Gets all Customers that are linked to a User.
Authentication is Mandatory
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"customers":[{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"19900101",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["19900101"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-30008: User Customer Link not found by USER_ID
- OBP-50000: Unknown Error.
Get Firehose Customers
Get Customers that has a firehose View.
Allows bulk access to customers.
User must have the CanUseFirehoseAtAnyBank Role
Possible custom url parameters for pagination:
- limit=NUMBER ==> default value: 50
- offset=NUMBER ==> default value: 0
eg1:?limit=100&offset=0
- sort_direction=ASC/DESC ==> default value: DESC.
eg2:?limit=100&offset=0&sort_direction=ASC
- from_date=DATE => example value: 2022-09-26T08:36:16.643Z. NOTE! The default value is one year ago (2022-09-26T08:36:16.643Z).
- to_date=DATE => example value: 2023-09-26T08:36:16.643Z. NOTE! The default value is now (2023-09-26T08:36:16.643Z).
Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.
eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
amount: 10.12
-
bank_id: gh.29.uk
-
currency: EUR
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
date_of_birth: 2018-03-09
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
relationship_status: single
{
"customers":[{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z"
}]
}
-
CanUseCustomerFirehoseAtAnyBank
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-00012: Customer firehose is not allowed on this instance. Please set allow_customer_firehose = true in props files.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Tax Residences of Customer
Get the Tax Residences of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
{
"tax_residence":[{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}]
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get User Customer Links by Customer
Get User Customer Links by CUSTOMER_ID
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"user_customer_links":[{
"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"date_inserted":"2017-09-19T00:00:00Z",
"is_active":true
}]
}
-
CanGetUserCustomerLink
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get User Customer Links by User
Get User Customer Links by USER_ID
Authentication is Mandatory
URL Parameters:
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"user_customer_links":[{
"user_customer_link_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"date_inserted":"2017-09-19T00:00:00Z",
"is_active":true
}]
}
-
CanGetUserCustomerLink
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update Customer Attribute
Update Customer Attribute
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ATTRIBUTE_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
value: 5987953
{
"customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"name":"SPECIAL_TAX_NUMBER",
"type":"STRING",
"value":"123456789"
}
-
CanUpdateCustomerAttributeAtOneBank
- Please login to request this Role
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Update the Address of a Customer
Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
insert_date: 2020-01-27
{
"customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"line_1":"No 1 the Road",
"line_2":"The Place",
"line_3":"The Hill",
"city":"Berlin",
"county":"",
"state":"Brandenburg",
"postcode":"13359",
"country_code":"DE",
"tags":["mailing","home"],
"status":"OK",
"insert_date":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Update the Branch of a Customer
Update the Branch of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerIdentity
- Please login to request this Role
- 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.
Update the credit limit of a Customer
Update the credit limit of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerCreditLimit
- Please login to request this Role
- 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.
Update the credit rating and source of a Customer
Update the credit rating and source of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerCreditRatingAndSource
- Please login to request this Role
- 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.
Update the email of a Customer
Update an email of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerEmail
- Please login to request this Role
- 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.
Update the identity data of a Customer
Update the identity data of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerIdentity
- Please login to request this Role
- 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.
Update the mobile number of a Customer
Update the mobile number of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerMobilePhoneNumber
- Please login to request this Role
- 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.
Update the number of a Customer
Update the number of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerNumber
- Please login to request this Role
- 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.
Update the other data of a Customer
Update the other data of the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
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
-
employment_status: worker
-
highest_education_attained: Master
-
kyc_status: true
-
legal_name: Eveline Tripman
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
{
"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":"2017-09-19T00:00:00Z"
},
"date_of_birth":"2017-09-19T00:00:00Z",
"relationship_status":"single",
"dependants":1,
"dob_of_dependants":["2017-09-19T00:00:00Z"],
"credit_rating":{
"rating":"OBP",
"source":"OBP"
},
"credit_limit":{
"currency":"EUR",
"amount":"0"
},
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanUpdateCustomerIdentity
- Please login to request this Role
- 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.