API Explorer
- API
- ATM
- Account
- Account Public
- Bank
- Branch
- Card
- 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
- Customer Meeting
- Customer Message
- Data Warehouse
- Documentation
- FX
- KYC
- Metric
- Product
- Role
- Sandbox
- Transaction
- Transaction Metadata
- Transaction Request
- User
- View (Custom)
-
API
-
ATM
-
Account
- Create Account
- Create View
- Get Account by Id (Core)
- Get Account by Id (Full)
- Get Accounts at Bank
- Get Accounts at all Banks (Private)
- Get all Accounts at all Banks
- Get private accounts at one bank
- Update Account Label
- Update View
-
Account Public
-
Bank
- Create Bank
- Create Transaction Type at bank
- Get Bank
- Get Bank ATMS
- Get Banks
- Get Transaction Types at Bank
-
Branch
-
Card
-
Consumer
-
Counterparty
- Create Counterparty (Explicit)
- Get Counterparties (Explicit)
- Get Counterparty by Counterparty Id (Explicit)
- Get Other Account by Id
- Get Other Accounts of one Account
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Customer
- Add Social Media Handle
- Create Customer
- Create User Customer Link
- Get CRM Events
- Get Customer Social Media Handles
- Get Customers for current User at Bank
-
Customer Meeting
-
Customer Message
-
Data Warehouse
-
Documentation
-
FX
-
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
-
Product
-
Role
- Add Entitlement for a User
- Delete Entitlement
- Get Entitlements for User
- Get Entitlements for User at Bank
- Get Roles
- Get all Entitlements
-
Sandbox
-
Transaction
-
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 (COUNTERPARTY)
- Create Transaction Request (FREE_FORM)
- Create Transaction Request (SANDBOX_TAN)
- Create Transaction Request (SEPA)
- Get Transaction Request Types at Bank
- Get Transaction Request Types for Account
- Get Transaction Requests
-
User
-
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.2.0 (143 APIs)
Add KYC Check
Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
satisfied: true
{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"date":"2017-09-19T00:00:00Z",
"how":"PlaceholderString",
"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}
-
CanAddKycCheck
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Add KYC Document
Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
expiry_date: 2021-01-27
-
issue_date: 2020-01-27
{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2017-09-19T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2017-09-19T00:00:00Z"
}
-
CanAddKycDocument
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- Server error: could not add KycDocument
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Add KYC Media
Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc
Authentication is Mandatory
URL Parameters:
-
BANK_ID: gh.29.uk
-
CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
{
"bank_id":"gh.29.uk",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}
-
CanAddKycMedia
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-00004: Server error: could not add message
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Add KYC Status
Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer
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
-
customer_number: 5987953
-
date: 2020-01-27
-
ok: true
{
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"ok":true,
"date":"2017-09-19T00:00:00Z"
}
-
CanAddKycStatus
- 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-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-00004: Server error: could not add message
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-20006: User is missing one or more roles:
Get Customer KYC Checks
Get KYC checks for the Customer specified by CUSTOMER_ID.
Authentication is Mandatory
URL Parameters:
- CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
satisfied: true
{
"checks":[{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"date":"2017-09-19T00:00:00Z",
"how":"PlaceholderString",
"staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"staff_name":"PlaceholderString",
"satisfied":true,
"comments":"PlaceholderString"
}]
}
-
CanGetAnyKycChecks
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customer KYC Documents
Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
Get a list of documents that affirm the identity of the customer
Passport, driving licence etc.
Authentication is Optional
Authentication is Mandatory
URL Parameters:
- CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
expiry_date: 2021-01-27
-
issue_date: 2020-01-27
{
"documents":[{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"2017-09-19T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"2017-09-19T00:00:00Z"
}]
}
-
CanGetAnyKycDocuments
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get Customer KYC statuses
Get the KYC statuses for a customer specified by CUSTOMER_ID over time.
Authentication is Mandatory
URL Parameters:
- CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
-
ok: true
{
"statuses":[{
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"ok":true,
"date":"2017-09-19T00:00:00Z"
}]
}
-
CanGetAnyKycStatuses
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Get KYC Media for a customer
Get KYC media (scans, pictures, videos) that affirms the identity of the customer.
Authentication is Mandatory
URL Parameters:
- CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
-
bank_id: gh.29.uk
-
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
customer_number: 5987953
-
date: 2020-01-27
{
"medias":[{
"bank_id":"gh.29.uk",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"2017-09-19T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}]
}
-
CanGetAnyKycMedia
- Please login to request this Role
- OBP-20001: User not logged in. Authentication is required!
- OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles: