-
Customer
-
The legal entity that has the relationship to the bank. Customers are linked to Users via `User CusMore...
- Create Customer
-
v5.1.0 filtered by tag: Person (3 APIs)
Create Customer
The Customer resource stores the customer number (which is set by the backend), legal name, email, phone number, their date of birth, relationship status, education attained, a url for a profile image, KYC status etc.
Dates need to be in the format 2013-01-21T23:08:00Z
Note: If you need to set a specific customer number, use the Update Customer Number endpoint after this call.
Authentication is Mandatory
URL Parameters:
- BANK_ID: gh.29.uk
JSON request body fields:
-
*legal_name: Eveline Tripman
-
*mobile_phone_number: +49 30 901820
-
branch_id: DERBY6
-
customer_number: 5987953
-
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: true
-
last_ok_date: 2022-01-23T13:11:23.192Z
-
name_suffix: Sr
-
relationship_status: single
-
title: Dr.
JSON response body fields:
-
*bank_id: gh.29.uk
-
*branch_id: DERBY6
-
*customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
*customer_number: 5987953
-
*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: true
-
*last_ok_date: 2022-01-23T13:11:23.192Z
-
*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":true,
"last_ok_date":"2022-01-23T13:11:23Z",
"title":"Dr.",
"branch_id":"DERBY6",
"name_suffix":"Sr"
}
-
CanCreateCustomer
- Please login to request this Role
-
CanCreateCustomerAtAnyBank
- 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-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 Message
Create a message 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:
-
*from_department: Open Bank
-
*from_person: Tom
-
*message: 123456
JSON response body fields:
{
"success":"Success"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Create Customer Message
Create a message 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:
-
*from_department: Open Bank
-
*from_person: Tom
-
*message: 123456
-
*transport: SMS
JSON response body fields:
{
"success":"Success"
}
-
CanCreateCustomerMessage
- 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-20006: User is missing one or more roles: