API Explorer
- API
- Account
- Account Public
- Bank
- Branch
- Card
- 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
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- KYC
- Metric
- Person
- Role
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at Bank (Private)
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
Account Public
-
Bank
-
Branch
-
Card
-
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 Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get customer for logged in user
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
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
-
Person
-
Role
-
Transaction
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Core)
- Get Transactions for Account (Full)
-
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
-
Transaction Request
- Answer Transaction Request Challenge
- Create Transaction Request
- Get Transaction Request Types for Account
- Get Transaction Requests
-
User
-
View (Custom)
- Delete 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
v2.0.0 (115 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 Customer
Add a customer linked to the user specified by user_id
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.
This call may require additional permissions/role in the future.
For now the authenticated user can create at most one linked customer.
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:
-
branchId: branchId
-
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
-
nameSuffix: nameSuffix
-
relationship_status: single
-
title: Dr.
-
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
-
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
{
"customer_id":"String",
"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"],
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z"
}
-
CanCreateCustomer
- Please login to request this Role
-
CanCreateUserCustomerLink
- Please login to request this Role
- 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-20001: User not logged in. Authentication is required!
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30006: Customer Number already exists. Please specify a different value for BANK_ID or CUSTOMER_NUMBER.
- OBP-20006: User is missing one or more roles:
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30024: Could not create Consumer
- 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 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.
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 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 for logged in user
Information about the currently authenticated user.
Authentication via OAuth is required.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON response body fields:
-
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
{
"customer_id":"String",
"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"],
"highest_education_attained":"Master",
"employment_status":"worker",
"kyc_status":true,
"last_ok_date":"2017-09-19T00:00:00Z"
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.