right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (606 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

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:

city:

country_code: 1254

county:

line_1:

line_2:

line_3:

postcode:

state:

status:

tags: Create-My-User

JSON response body fields:

city:

country_code: 1254

county:

customer_address_id:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

insert_date: 2020-01-27

line_1:

line_2:

line_3:

postcode:

state:

status:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "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"
}
Required Roles:
  • CanCreateCustomerAddress - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCustomerAddress, operation_id: OBPv3.1.0-createCustomerAddress Tags: Customer,

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:

amount: 10.12

currency: EUR

date: 2020-01-27

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

source:

url: http://www.example.com/id-docs/123/image.png

branch_id: DERBY6

credit_limit:

credit_rating:

customer_number: 5987953

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanCreateCustomer - Please login to request this Role
  • CanCreateCustomerAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv5.0.0, function_name: by createCustomer, operation_id: OBPv5.0.0-createCustomer Tags: Customer, Person,

Create Customer Account Link

Link a Customer to a Account

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

relationship_type: Owner

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

relationship_type: Owner

Typical Successful Response: 

								
									
{
  "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "relationship_type":"Owner"
}
Required Roles:
  • CanCreateCustomerAccountLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_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-30223: The Account is already linked to a Customer at the bank specified by BANK_ID
  • OBP-30224: Could not create the customer account link.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by createCustomerAccountLink, operation_id: OBPv5.0.0-createCustomerAccountLink Tags: Customer, Account,

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:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

JSON response body fields:

customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"SPECIAL_TAX_NUMBER",
  "type":"STRING",
  "value":"123456789"
}
Required Roles:
  • CanCreateCustomerAttributeAtOneBank - Please login to request this Role
  • CanCreateCustomerAttributeAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by createCustomerAttribute, operation_id: OBPv4.0.0-createCustomerAttribute Tags: Customer,

Create Customer Social Media Handle

Create a customer 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

date_activated:

date_added:

handle:

type:

JSON response body fields:

success:

Typical Successful Response: 

								
									
{
  "success":"Success"
}
Required Roles:
  • CanAddSocialMediaHandle - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv2.0.0, function_name: by addSocialMediaHandle, operation_id: OBPv2.0.0-addSocialMediaHandle Tags: Customer,

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:

domain:

tax_number: 456

JSON response body fields:

domain:

tax_number: 456

tax_residence_id:

Typical Successful Response: 

								
									
{
  "domain":"Enter some domain",
  "tax_number":"Enter some number",
  "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}
Required Roles:
  • CanCreateTaxResidence - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by createTaxResidence, operation_id: OBPv3.1.0-createTaxResidence Tags: Customer, KYC,

Create User Customer Link

Link a User to a Customer

Authentication is Mandatory

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

date_inserted:

is_active: false

user_customer_link_id:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00:00:00Z",
  "is_active":true
}
Required Roles:
  • CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role
  • CanCreateUserCustomerLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by createUserCustomerLinks, operation_id: OBPv4.0.0-createUserCustomerLinks Tags: Customer, User,

Create or Update Customer Attribute Definition

Create or Update Customer Attribute Definition

The category field must be one of: Customer

The type field must be one of; DOUBLE, STRING, INTEGER and DATE_WITH_DAY

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

Typical Successful Response: 

								
									
{
  "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
}
Required Roles:
  • CanCreateCustomerAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by createOrUpdateCustomerAttributeAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition Tags: Customer,

Delete Customer Account Link

Delete Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteCustomerAccountLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv5.0.0, function_name: by deleteCustomerAccountLinkById, operation_id: OBPv5.0.0-deleteCustomerAccountLinkById Tags: Customer,

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_ADDRESS_ID:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteCustomerAddress - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteCustomerAddress, operation_id: OBPv3.1.0-deleteCustomerAddress Tags: Customer, KYC,

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:

Typical Successful Response:
Required Roles:
  • CanDeleteCustomerAttributeAtOneBank - Please login to request this Role
  • CanDeleteCustomerAttributeAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteCustomerAttribute, operation_id: OBPv4.0.0-deleteCustomerAttribute Tags: Customer,

Delete Customer Attribute Definition

Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

URL Parameters:

ATTRIBUTE_DEFINITION_ID:

BANK_ID: gh.29.uk

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteCustomerAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteCustomerAttributeDefinition, operation_id: OBPv4.0.0-deleteCustomerAttributeDefinition Tags: Customer,

Delete Customer Cascade

Delete a Customer Cascade 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:

Typical Successful Response:
Required Roles:
  • CanDeleteCustomerCascade - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteCustomerCascade, operation_id: OBPv4.0.0-deleteCustomerCascade Tags: Customer,

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

TAX_RESIDENCE_ID:

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by deleteTaxResidence, operation_id: OBPv3.1.0-deleteTaxResidence Tags: Customer, KYC,

Delete User Customer Link

Delete User Customer Link by USER_CUSTOMER_LINK_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

USER_CUSTOMER_LINK_ID:

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteUserCustomerLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteUserCustomerLink, operation_id: OBPv4.0.0-deleteUserCustomerLink Tags: Customer,

Get CRM Events

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

actual_date: 2020-01-27

bank_id: gh.29.uk

category:

channel:

crm_events:

customer_name:

customer_number: 5987953

detail:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

result:

scheduled_date: 2020-01-27

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00:00:00Z",
    "actual_date":"1100-01-01T00:00:00Z",
    "result":"String"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv1.4.0, function_name: by getCrmEvents, operation_id: OBPv1.4.0-getCrmEvents Tags: Customer,

Get Correlated Entities for the current User

Correlated Entities are users and customers linked to the currently authenticated user via User-Customer-Links

Authentication is Mandatory

JSON response body fields:

amount: 10.12

bank_id: gh.29.uk

branch_id: DERBY6

correlated_entities: correlated_entities

currency: EUR

customer:

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

insert_date: 2020-01-27

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

user_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

user_attributes: user_attributes

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

users: user list

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "correlated_entities":[{
    "customer":{
      "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-10-28T22:23:21Z",
      "title":"Dr.",
      "branch_id":"DERBY6",
      "name_suffix":"Sr"
    },
    "users":[{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"felixsmith@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith",
      "user_attributes":[{
        "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
        "name":"BATTERY_LEVEL",
        "type":"STRING",
        "value":"90",
        "insert_date":"2024-10-28T22:23:21Z"
      }]
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv4.0.0, function_name: by getMyCorrelatedEntities, operation_id: OBPv4.0.0-getMyCorrelatedEntities Tags: Customer,

Get Correlated User Info by Customer

Get Correlated User Info 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:

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

insert_date: 2020-01-27

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

provider: ETHEREUM

provider_id:

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

user_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

user_attributes: user_attributes

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

username: felixsmith

users: user list

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "customer":{
    "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-10-28T22:23:21Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  },
  "users":[{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"felixsmith@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith",
    "user_attributes":[{
      "user_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
      "name":"BATTERY_LEVEL",
      "type":"STRING",
      "value":"90",
      "insert_date":"2024-10-28T22:23:21Z"
    }]
  }]
}
Required Roles:
  • CanGetCorrelatedUsersInfoAtAnyBank - Please login to request this Role
  • CanGetCorrelatedUsersInfo - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCorrelatedUsersInfoByCustomerId, operation_id: OBPv4.0.0-getCorrelatedUsersInfoByCustomerId Tags: Customer,

Get Customer Account Link by Id

Get Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

relationship_type: Owner

Typical Successful Response: 

								
									
{
  "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "relationship_type":"Owner"
}
Required Roles:
  • CanGetCustomerAccountLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomerAccountLinkById, operation_id: OBPv5.0.0-getCustomerAccountLinkById Tags: Customer,

Get Customer Account Links by ACCOUNT_ID

Get Customer Account Links by ACCOUNT_ID

Authentication is Mandatory

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

links: links

relationship_type: Owner

Typical Successful Response: 

								
									
{
  "links":[{
    "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "relationship_type":"Owner"
  }]
}
Required Roles:
  • CanGetCustomerAccountLinks - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomerAccountLinksByBankIdAccountId, operation_id: OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId Tags: Customer,

Get Customer Account Links by CUSTOMER_ID

Get Customer Account 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:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

links: links

relationship_type: Owner

Typical Successful Response: 

								
									
{
  "links":[{
    "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "bank_id":"gh.29.uk",
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "relationship_type":"Owner"
  }]
}
Required Roles:
  • CanGetCustomerAccountLinks - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • 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-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomerAccountLinksByCustomerId, operation_id: OBPv5.0.0-getCustomerAccountLinksByCustomerId Tags: Customer,

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:

addresses:

city:

country_code: 1254

county:

customer_address_id:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

insert_date: 2020-01-27

line_1:

line_2:

line_3:

postcode:

state:

status:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "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"
  }]
}
Required Roles:
  • CanGetCustomerAddress - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCustomerAddresses, operation_id: OBPv3.1.0-getCustomerAddresses Tags: Customer, KYC,

Get Customer Attribute By Id

Get Customer Attribute By Id

Authentication is Mandatory

URL Parameters:

ATTRIBUTE_ID:

BANK_ID: gh.29.uk

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"SPECIAL_TAX_NUMBER",
  "type":"STRING",
  "value":"123456789"
}
Required Roles:
  • CanGetCustomerAttributeAtOneBank - Please login to request this Role
  • CanGetCustomerAttributeAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomerAttributeById, operation_id: OBPv4.0.0-getCustomerAttributeById Tags: Customer,

Get Customer Attribute Definition

Get Customer Attribute Definition

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

alias:

attribute_definition_id:

attributes: attribute value in form of (name, value)

bank_id: gh.29.uk

can_be_seen_on_views: false

category:

description: This an optional field. Maximum length is 2000. It can be any characters here.

is_active: false

name: ACCOUNT_MANAGEMENT_FEE

type:

Typical Successful Response: 

								
									
{
  "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
  }]
}
Required Roles:
  • CanGetCustomerAttributeDefinitionAtOneBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomerAttributeDefinition, operation_id: OBPv4.0.0-getCustomerAttributeDefinition Tags: Customer,

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

customer_attributes:

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "customer_attributes":[{
    "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"SPECIAL_TAX_NUMBER",
    "type":"STRING",
    "value":"123456789"
  }]
}
Required Roles:
  • CanGetCustomerAttributesAtOneBank - Please login to request this Role
  • CanGetCustomerAttributesAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomerAttributes, operation_id: OBPv4.0.0-getCustomerAttributes Tags: Customer,

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_attribute_id:

account_attributes:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

account_routings:

accounts:

address:

amount: 10.12

balance: 10

bank_id: gh.29.uk

branch_id: DERBY6

currency: EUR

customer_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_attributes:

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

label: My Account

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

product_code: 1234BW

rating:

relationship_status: single

scheme: scheme value

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

value: 5987953

contract_code: contract_code

contracts: contracts

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "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":"AccountNumber",
      "address":"4930396"
    }],
    "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"
    }]
  }]
}
Required Roles:
  • CanGetCustomerOverview - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomerOverview, operation_id: OBPv5.0.0-getCustomerOverview Tags: Customer, KYC,

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_attribute_id:

account_attributes:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

account_routings:

accounts:

address:

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_attributes:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

date_of_birth: 2018-03-09

email: felixsmith@example.com

label: My Account

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

product_code: 1234BW

scheme: scheme value

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

Typical Successful Response: 

								
									
{
  "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":"AccountNumber",
      "address":"4930396"
    }],
    "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"
    }]
  }]
}
Required Roles:
  • CanGetCustomerOverviewFlat - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomerOverviewFlat, operation_id: OBPv5.0.0-getCustomerOverviewFlat Tags: Customer, KYC,

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:

checks:

customer_number: 5987953

date_activated:

date_added:

handle:

type:

Typical Successful Response: 

								
									
{
  "checks":[{
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "handle":"PlaceholderString",
    "date_added":"1100-01-01T00:00:00Z",
    "date_activated":"1100-01-01T00:00:00Z"
  }]
}
Required Roles:
  • CanGetSocialMediaHandles - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv2.0.0, function_name: by getSocialMediaHandles, operation_id: OBPv2.0.0-getSocialMediaHandles Tags: Customer,

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_attributes:

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "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"
  }]
}
Required Roles:
  • CanGetCustomer - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCustomerByCustomerId, operation_id: OBPv3.1.0-getCustomerByCustomerId Tags: Customer,

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_attributes:

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "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"
  }]
}
Required Roles:
  • CanGetCustomer - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv3.1.0, function_name: by getCustomerByCustomerNumber, operation_id: OBPv3.1.0-getCustomerByCustomerNumber Tags: Customer, KYC,

Get Customers Minimal at Any Bank

Get Customers Minimal at Any Bank.

Authentication is Mandatory

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customers:

Typical Successful Response: 

								
									
{
  "customers":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}
Required Roles:
  • CanGetCustomersMinimalAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomersMinimalAtAnyBank, operation_id: OBPv4.0.0-getCustomersMinimalAtAnyBank Tags: Customer, User,

Get Customers Minimal at Bank

Get Customers Minimal at Bank.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customers:

Typical Successful Response: 

								
									
{
  "customers":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh"
  }]
}
Required Roles:
  • CanGetCustomersMinimal - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomersMinimalAtOneBank, operation_id: OBPv5.0.0-getCustomersMinimalAtOneBank Tags: Customer, User,

Get Customers at Any Bank

Get Customers at Any Bank.

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

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00: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":false,
    "last_ok_date":"2023-10-28T22:23:21Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  }]
}
Required Roles:
  • CanGetCustomersAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomersAtAnyBank, operation_id: OBPv4.0.0-getCustomersAtAnyBank Tags: Customer, User,

Get Customers at Bank

Get Customers at Bank.

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_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00: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":false,
    "last_ok_date":"2023-10-28T22:23:21Z",
    "title":"Dr.",
    "branch_id":"DERBY6",
    "name_suffix":"Sr"
  }]
}
Required Roles:
  • CanGetCustomers - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv5.0.0, function_name: by getCustomersAtOneBank, operation_id: OBPv5.0.0-getCustomersAtOneBank Tags: Customer, User,

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]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getCustomersByCustomerPhoneNumber, operation_id: OBPv4.0.0-getCustomersByCustomerPhoneNumber Tags: Customer, KYC,

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_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_attributes:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00: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":false,
    "last_ok_date":"2023-10-28T22:23:21Z",
    "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"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getCustomersForUser, operation_id: OBPv3.0.0-getCustomersForUser Tags: Customer, User,

Get Customers for Current User (IDs only)

Gets all Customers Ids 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_attribute_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_attributes:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_number: 5987953

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name: ACCOUNT_MANAGEMENT_FEE

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

type:

url: http://www.example.com/id-docs/123/image.png

value: 5987953

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00: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":false,
    "last_ok_date":"2023-10-28T22:23:21Z",
    "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"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.1.0, function_name: by getCustomersForUserIdsOnly, operation_id: OBPv5.1.0-getCustomersForUserIdsOnly Tags: Customer, User,

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: 1970-01-01T00:00:00.000Z. NOTE! The default value is one year ago (1970-01-01T00:00:00.000Z).
  • to_date=DATE => example value: 2024-10-28T22:23:23.247Z. NOTE! The default value is now (2024-10-28T22:23:23.247Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(1100-01-01T01:01:01.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.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

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"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-10-28T22:23:21Z"
  }]
}
Required Roles:
  • CanUseCustomerFirehoseAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by getFirehoseCustomers, operation_id: OBPv3.1.0-getFirehoseCustomers Tags: Customer, FirehoseData,

Get My Customers

Gets all Customers that are linked to me.

Authentication via OAuth is required.

Authentication is Mandatory

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv5.0.0, function_name: by getMyCustomersAtAnyBank, operation_id: OBPv5.0.0-getMyCustomersAtAnyBank Tags: Customer, User,

Get My Customers at Bank

Returns a list of Customers at the Bank that are linked to the currently authenticated User.

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

customers:

date: 2020-01-27

date_of_birth: 2018-03-09

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

rating:

relationship_status: single

source:

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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":"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-10-28T22:23:21Z"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv5.0.0, function_name: by getMyCustomersAtBank, operation_id: OBPv5.0.0-getMyCustomersAtBank Tags: Customer,

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:

domain:

tax_number: 456

tax_residence:

tax_residence_id:

Typical Successful Response: 

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getTaxResidence, operation_id: OBPv3.1.0-getTaxResidence Tags: Customer, KYC,

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

date_inserted:

is_active: false

user_customer_link_id:

user_customer_links:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00:00:00Z",
    "is_active":true
  }]
}
Required Roles:
  • CanGetUserCustomerLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getUserCustomerLinksByCustomerId, operation_id: OBPv4.0.0-getUserCustomerLinksByCustomerId Tags: Customer,

Get User Customer Links by User

Get User Customer Links by USER_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

JSON response body fields:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

date_inserted:

is_active: false

user_customer_link_id:

user_customer_links:

user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1

Typical Successful Response: 

								
									
{
  "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":"1100-01-01T00:00:00Z",
    "is_active":true
  }]
}
Required Roles:
  • CanGetUserCustomerLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getUserCustomerLinksByUserId, operation_id: OBPv4.0.0-getUserCustomerLinksByUserId Tags: Customer,

Update Customer Account Link by Id

Update Customer Account Link by CUSTOMER_ACCOUNT_LINK_ID

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

CUSTOMER_ACCOUNT_LINK_ID: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

account_id: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

bank_id: gh.29.uk

customer_account_link_id: xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

relationship_type: Owner

Typical Successful Response: 

								
									
{
  "customer_account_link_id":"xyz8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "bank_id":"gh.29.uk",
  "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "relationship_type":"Owner"
}
Required Roles:
  • CanUpdateCustomerAccountLink - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv5.0.0, function_name: by updateCustomerAccountLinkById, operation_id: OBPv5.0.0-updateCustomerAccountLinkById Tags: Customer,

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

name: ACCOUNT_MANAGEMENT_FEE

type:

value: 5987953

Typical Successful Response: 

								
									
{
  "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "name":"SPECIAL_TAX_NUMBER",
  "type":"STRING",
  "value":"123456789"
}
Required Roles:
  • CanUpdateCustomerAttributeAtOneBank - Please login to request this Role
  • CanUpdateCustomerAttributeAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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:
Connector Methods:
Version: OBPv4.0.0, function_name: by updateCustomerAttribute, operation_id: OBPv4.0.0-updateCustomerAttribute Tags: Customer,

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_ADDRESS_ID:

CUSTOMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

JSON response body fields:

city:

country_code: 1254

county:

customer_address_id:

customer_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh

insert_date: 2020-01-27

line_1:

line_2:

line_3:

postcode:

state:

status:

tags: Create-My-User

Typical Successful Response: 

								
									
{
  "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"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerAddress, operation_id: OBPv3.1.0-updateCustomerAddress Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerIdentity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerBranch, operation_id: OBPv3.1.0-updateCustomerBranch Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerCreditLimit - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditLimit, operation_id: OBPv3.1.0-updateCustomerCreditLimit Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerCreditRatingAndSource - Please login to request this Role
  • CanUpdateCustomerCreditRatingAndSourceAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerCreditRatingAndSource, operation_id: OBPv3.1.0-updateCustomerCreditRatingAndSource Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerEmail - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerEmail, operation_id: OBPv3.1.0-updateCustomerEmail Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerIdentity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerIdentity, operation_id: OBPv3.1.0-updateCustomerIdentity Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerMobilePhoneNumber - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerMobileNumber, operation_id: OBPv3.1.0-updateCustomerMobileNumber Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerNumber - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerNumber, operation_id: OBPv3.1.0-updateCustomerNumber Tags: Customer,

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

dependants: 1

dob_of_dependants: [2019-09-08, 2017-07-12]

email: felixsmith@example.com

employment_status: worker

face_image:

highest_education_attained: Master

kyc_status: false

last_ok_date: 2023-10-28T22:23:20.538Z

legal_name: Eveline Tripman

mobile_phone_number: +49 30 901820

name_suffix: Sr

rating:

relationship_status: single

source:

title: Dr.

url: http://www.example.com/id-docs/123/image.png

credit_limit:

credit_rating:

Typical Successful Response: 

								
									
{
  "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-10-28T22:23:21Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
Required Roles:
  • CanUpdateCustomerIdentity - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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.
Connector Methods:
Version: OBPv3.1.0, function_name: by updateCustomerData, operation_id: OBPv3.1.0-updateCustomerData Tags: Customer,