-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Tax Residence
- Delete Customer Address
- Delete Tax Residence
- Get Customer Addresses
- Get Customer Overview
- Get Customer Overview Flat
- Get Customer by CUSTOMER_NUMBER
- Get Customers by Legal Name
- Get Customers by MOBILE_PHONE_NUMBER
- Get Tax Residences of Customer
-
-
Customer
- Create Tax Residence
- Delete Customer Address
- Delete Tax Residence
- Get Customer Addresses
- Get Customer Overview
- Get Customer Overview Flat
- Get Customer by CUSTOMER_NUMBER
- Get Customers by Legal Name
- Get Customers by MOBILE_PHONE_NUMBER
- Get Tax Residences of Customer
-
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
-
User Invitation
v5.1.0 filtered by tag: KYC (20 APIs)
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:
tax_number: 456
JSON response body fields:
tax_number: 456
{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}
-
CanCreateTaxResidence
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
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:
-
CanDeleteCustomerAddress
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
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:
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- 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:
city:
country_code: 1254
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
insert_date: 2020-01-27
tags: Create-My-User
{
"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":"1100-01-01T00:00:00Z"
}]
}
-
CanGetCustomerAddress
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
Get Customer Overview
Gets the Customer Overview specified by customer_number and bank_code.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_number: 5987953
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
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
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
label: My Account
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
product_code: 1234BW
relationship_status: single
scheme: OBP
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
value: 5987953
contract_code: contract_code
contracts: contracts
{
"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-12-11T21:00:24Z",
"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"
}],
"accounts":[{
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"My Account",
"product_code":"787LOW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"branch_id":"DERBY6",
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"contract_code":"LKJL98769F",
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}]
}]
}
-
CanGetCustomerOverview
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Customer Overview Flat
Gets the Customer Overview Flat specified by customer_number and bank_code.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
customer_number: 5987953
JSON response body fields:
account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
amount: 10.12
balance: 10
bank_id: gh.29.uk
branch_id: DERBY6
contract_code: contract_code
currency: EUR
customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
customer_number: 5987953
date_of_birth: 2018-03-09
label: My Account
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
product_code: 1234BW
scheme: OBP
title: Dr.
type:
value: 5987953
branch_code: branch_code
cancellation_date: cancellation_date
contract_code: contract_code
contracts: contracts
form_of_payment: form_of_payment
instrument_status_code: instrument_status_code
instrument_status_definition: instrument_status_definition
interest_amount: interest_amount
interest_rate: interest_rate
is_substituted: is_substituted
issuance_amount: issuance_amount
maturity_date: maturity_date
opening_date: opening_date
payment_method: payment_method
product_description: product_description
renewal_date: renewal_date
term: term
{
"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",
"date_of_birth":"1100-01-01T00: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"
}],
"accounts":[{
"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
"label":"My Account",
"product_code":"787LOW",
"balance":{
"currency":"EUR",
"amount":"0"
},
"branch_id":"DERBY6",
"contracts":[{
"product_code":"787LOW",
"contract_code":"LKJL98769F",
"payment_method":"cache"
}],
"account_routings":[{
"scheme":"OBP",
"address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
}],
"account_attributes":[{
"contract_code":"LKJL98769F",
"product_code":"1234BW",
"account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
"name":"OVERDRAFT_START_DATE",
"type":"DATE_WITH_DAY",
"value":"2012-04-23"
}]
}]
}
-
CanGetCustomerOverviewFlat
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 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
dependants: 1
dob_of_dependants: [2019-09-08, 2017-07-12]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
name: ACCOUNT_MANAGEMENT_FEE
name_suffix: Sr
relationship_status: single
title: Dr.
type:
url: http://www.example.com/id-docs/123/image.png
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":"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-12-11T21:00:24Z",
"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
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 Legal Name
Gets the Customers specified by Legal Name.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
legal_name: Eveline Tripman
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]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
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":"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-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanGetCustomer
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 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:
mobile_phone_number: +49 30 901820
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]
employment_status: worker
highest_education_attained: Master
kyc_status: false
last_ok_date: 2023-12-11T21:00:24.360Z
legal_name: Eveline Tripman
mobile_phone_number: +49 30 901820
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":"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-12-11T21:00:24Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanGetCustomer
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 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_number: 456
{
"tax_residence":[{
"domain":"Enter some domain",
"tax_number":"Enter some number",
"tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
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
how:
id: d8839721-ad8f-45dd-9f78-2080414b93f9
satisfied: false
{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"date":"1100-01-01T00: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
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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
id: d8839721-ad8f-45dd-9f78-2080414b93f9
issue_date: 2020-01-27
type:
{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"1100-01-01T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"1100-01-01T00:00:00Z"
}
-
CanAddKycDocument
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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
id: d8839721-ad8f-45dd-9f78-2080414b93f9
type:
{
"bank_id":"gh.29.uk",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"1100-01-01T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}
-
CanAddKycMedia
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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: false
{
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"ok":true,
"date":"1100-01-01T00:00:00Z"
}
-
CanAddKycStatus
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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
how:
id: d8839721-ad8f-45dd-9f78-2080414b93f9
satisfied: false
{
"checks":[{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"date":"1100-01-01T00: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
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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
id: d8839721-ad8f-45dd-9f78-2080414b93f9
issue_date: 2020-01-27
type:
{
"documents":[{
"bank_id":"gh.29.uk",
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"number":"PlaceholderString",
"issue_date":"1100-01-01T00:00:00Z",
"issue_place":"PlaceholderString",
"expiry_date":"1100-01-01T00:00:00Z"
}]
}
-
CanGetAnyKycDocuments
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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: false
{
"statuses":[{
"customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"customer_number":"5987953",
"ok":true,
"date":"1100-01-01T00:00:00Z"
}]
}
-
CanGetAnyKycStatuses
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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
id: d8839721-ad8f-45dd-9f78-2080414b93f9
type:
{
"medias":[{
"bank_id":"gh.29.uk",
"customer_id":"PlaceholderString",
"id":"PlaceholderString",
"customer_number":"5987953",
"type":"PlaceholderString",
"url":"PlaceholderString",
"date":"1100-01-01T00:00:00Z",
"relates_to_kyc_document_id":"PlaceholderString",
"relates_to_kyc_check_id":"PlaceholderString"
}]
}
-
CanGetAnyKycMedia
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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:
Create User Invitation
Create User Invitation.
This endpoint will send an invitation email to the developers, then they can use the link to create the obp user.
purpose filed only support:List(DEVELOPER, CUSTOMER).
You can customise the email details use the following webui props:
when purpose == DEVELOPER
webui_developer_user_invitation_email_subject
webui_developer_user_invitation_email_from
webui_developer_user_invitation_email_text
webui_developer_user_invitation_email_html_text
when purpose = == CUSTOMER
webui_customer_user_invitation_email_subject
webui_customer_user_invitation_email_from
webui_customer_user_invitation_email_text
webui_customer_user_invitation_email_html_text
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
JSON response body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
{
"first_name":"Tom",
"last_name":"Smith",
"email":"felixsmith@example.com",
"company":"Tesobe GmbH",
"country":"Germany",
"purpose":"DEVELOPER",
"status":""
}
-
CanCreateUserInvitation
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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 User Invitation Information
Get User Invitation Information.
Authentication is Optional
URL Parameters:
BANK_ID: gh.29.uk
JSON request body fields:
secret_key: secret_key
JSON response body fields:
company: Tesobe GmbH
country: Germany
first_name: Tom
last_name: Smith
purpose: DEVELOPER
{
"first_name":"Tom",
"last_name":"Smith",
"email":"felixsmith@example.com",
"company":"Tesobe GmbH",
"country":"Germany",
"purpose":"DEVELOPER",
"status":""
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-30008: User Customer Link not found by USER_ID
- OBP-37882: Cannot get user invitation.
- OBP-37883: Cannot find user invitation.
- OBP-50000: Unknown Error.