API Explorer

v4.0.0 filtered by tags: Customer ... (56 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Add Social Media Handle

Add a social media handle for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

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 Address

Create an Address for a Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

  • tags: Create-My-User

JSON response body fields:

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":"2017-09-19T00: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.
Version: OBPv3.1.0, function_name: by createCustomerAddress, operation_id: OBPv3.1.0-createCustomerAddress Tags: Customer, New-Style,

Create Credit Limit Order Request

NOTE: This endpoint currently only returns example data.

Create credit limit order request

Authentication is Optional

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "execution_time":"String", "execution_date":"String", "token":"String", "short_reference":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createCreditLimitRequest, operation_id: OBPv3.1.0-createCreditLimitRequest Tags: Customer, New-Style,

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:

JSON request body fields:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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:
Version: OBPv3.1.0, function_name: by createCustomer, operation_id: OBPv3.1.0-createCustomer Tags: Customer, Person, New-Style,

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:

JSON request body fields:

JSON response body fields:

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
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:
Version: OBPv4.0.0, function_name: by createCustomerAttribute, operation_id: OBPv4.0.0-createCustomerAttribute Tags: Customer, New-Style,

Create Tax Residence

Create a Tax Residence for a Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

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.
Version: OBPv3.1.0, function_name: by createTaxResidence, operation_id: OBPv3.1.0-createTaxResidence Tags: Customer, KYC, New-Style,

Link a User to a Customer

Authentication is Mandatory

CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.

URL Parameters:

JSON request body fields:

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

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

JSON response body fields:

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

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

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv2.0.0, function_name: by createUserCustomerLinks, operation_id: OBPv2.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:

JSON response body fields:

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:
Version: OBPv4.0.0, function_name: by createOrUpdateCustomerAttributeAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition Tags: Customer, New-Style,

Delete Customer Address

Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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.
Version: OBPv3.1.0, function_name: by deleteCustomerAddress, operation_id: OBPv3.1.0-deleteCustomerAddress Tags: Customer, KYC, New-Style,

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:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Required Roles:
  • CanDeleteCustomerAttributeAtOneBank - 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, New-Style,

Delete Customer Attribute Definition

Delete Customer Attribute Definition by ATTRIBUTE_DEFINITION_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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, New-Style,

Delete Tax Residence

Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
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.
Version: OBPv3.1.0, function_name: by deleteTaxResidence, operation_id: OBPv3.1.0-deleteTaxResidence Tags: Customer, KYC, New-Style,

Delete User Customer Link by USER_CUSTOMER_LINK_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Version: OBPv4.0.0, function_name: by deleteUserCustomerLink, operation_id: OBPv4.0.0-deleteUserCustomerLink Tags: Customer, New-Style,

Get CRM Events

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z", "actual_date":"2017-09-19T00: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 Credit Limit Order Request By Request Id

NOTE: This endpoint currently only returns example data.

    Get Credit Limit Order Request By Request Id

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "rank_amount_1":"String", "nominal_interest_1":"String", "rank_amount_2":"String", "nominal_interest_2":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCreditLimitRequestByRequestId, operation_id: OBPv3.1.0-getCreditLimitRequestByRequestId Tags: Customer, New-Style,

Get Credit Limit Order Requests

NOTE: This endpoint currently only returns example data.

Get Credit Limit Order Requests

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "rank_amount_1":"String", "nominal_interest_1":"String", "rank_amount_2":"String", "nominal_interest_2":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getCreditLimitRequests, operation_id: OBPv3.1.0-getCreditLimitRequests Tags: Customer, New-Style,

Get Customer Addresses

Get the Addresses of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00: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.
Version: OBPv3.1.0, function_name: by getCustomerAddresses, operation_id: OBPv3.1.0-getCustomerAddresses Tags: Customer, KYC, New-Style,

Get Customer Attribute By Id

Get Customer Attribute By Id

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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
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:
Version: OBPv4.0.0, function_name: by getCustomerAttributeById, operation_id: OBPv4.0.0-getCustomerAttributeById Tags: Customer, New-Style,

Get Customer Attribute Definition

Get Customer Attribute Definition

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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, New-Style,

Get Customer Attributes

Get Customer Attributes

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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
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:
Version: OBPv4.0.0, function_name: by getCustomerAttributes, operation_id: OBPv4.0.0-getCustomerAttributes Tags: Customer, New-Style,

Get Customer Social Media Handles

Get social media handles for a customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "checks":[{ "customer_number":"5987953", "type":"PlaceholderString", "handle":"PlaceholderString", "date_added":"2017-09-19T00:00:00Z", "date_activated":"2017-09-19T00: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:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00: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" }] }
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.
Version: OBPv3.1.0, function_name: by getCustomerByCustomerId, operation_id: OBPv3.1.0-getCustomerByCustomerId Tags: Customer, New-Style,

Get Customer by CUSTOMER_NUMBER

Gets the Customer specified by CUSTOMER_NUMBER.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00: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" }] }
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:
Version: OBPv3.1.0, function_name: by getCustomerByCustomerNumber, operation_id: OBPv3.1.0-getCustomerByCustomerNumber Tags: Customer, KYC, New-Style,

Get Customers by ATTRIBUTES

Gets the Customers specified by attributes

URL params example: /banks/some-bank-id/customers?name=John&age=8
URL params example: /banks/some-bank-id/customers?manager=John&count=8

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00: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" }] }] }
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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30008: User Customer Link not found by USER_ID
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv4.0.0, function_name: by getCustomersByAttributes, operation_id: OBPv4.0.0-getCustomersByAttributes Tags: Customer, New-Style,

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:

JSON request body fields:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv4.0.0, function_name: by getCustomersByCustomerPhoneNumber, operation_id: OBPv4.0.0-getCustomersByCustomerPhoneNumber Tags: Customer, KYC, New-Style,

Get Customers for Current User

Gets all Customers that are linked to a User.

Authentication is Mandatory

JSON response body fields:

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":"2017-09-19T00: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":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.0.0, function_name: by getCustomersForUser, operation_id: OBPv3.0.0-getCustomersForUser Tags: Customer, User, New-Style,

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: 2020-09-21T06:27:28.333Z. NOTE! The default value is one year ago (2020-09-21T06:27:28.333Z).
  • to_date=DATE => example value: 2021-09-21T06:27:28.333Z. NOTE! The default value is now (2021-09-21T06:27:28.333Z).

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

eg3:?sort_direction=ASC&limit=100&offset=0&from_date=2017-09-19T02:31:05.000Z&to_date=2017-09-19T02:31:05.000Z

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z" }] }
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.
Version: OBPv3.1.0, function_name: by getFirehoseCustomers, operation_id: OBPv3.1.0-getFirehoseCustomers Tags: Customer, FirehoseData, New-Style,

Get Tax Residences of Customer

Get the Tax Residences of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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.
Version: OBPv3.1.0, function_name: by getTaxResidence, operation_id: OBPv3.1.0-getTaxResidence Tags: Customer, KYC, New-Style,

Get User Customer Links by Customer

Get User Customer Links by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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

  • 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":"2017-09-19T00: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, New-Style,

Get User Customer Links by User

Get User Customer Links by USER_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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

  • 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":"2017-09-19T00: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, New-Style,

Update Customer Attribute

Update Customer Attribute

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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
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:
Version: OBPv4.0.0, function_name: by updateCustomerAttribute, operation_id: OBPv4.0.0-updateCustomerAttribute Tags: Customer, New-Style,

Update the Address of a Customer

Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00: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.
Version: OBPv3.1.0, function_name: by updateCustomerAddress, operation_id: OBPv3.1.0-updateCustomerAddress Tags: Customer, New-Style,

Update the Branch of a Customer

Update the Branch of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerBranch, operation_id: OBPv3.1.0-updateCustomerBranch Tags: Customer, New-Style,

Update the credit limit of a Customer

Update the credit limit of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerCreditLimit, operation_id: OBPv3.1.0-updateCustomerCreditLimit Tags: Customer, New-Style,

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:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "title":"Dr.", "branch_id":"DERBY6", "name_suffix":"Sr" }
Required Roles:
  • CanUpdateCustomerCreditRatingAndSource - 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.
Version: OBPv3.1.0, function_name: by updateCustomerCreditRatingAndSource, operation_id: OBPv3.1.0-updateCustomerCreditRatingAndSource Tags: Customer, New-Style,

Update the email of a Customer

Update an email of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerEmail, operation_id: OBPv3.1.0-updateCustomerEmail Tags: Customer, New-Style,

Update the identity data of a Customer

Update the identity data of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerIdentity, operation_id: OBPv3.1.0-updateCustomerIdentity Tags: Customer, New-Style,

Update the mobile number of a Customer

Update the mobile number of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerMobileNumber, operation_id: OBPv3.1.0-updateCustomerMobileNumber Tags: Customer, New-Style,

Update the number of a Customer

Update the number of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerNumber, operation_id: OBPv3.1.0-updateCustomerNumber Tags: Customer, New-Style,

Update the other data of a Customer

Update the other data of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z" }, "date_of_birth":"2017-09-19T00:00:00Z", "relationship_status":"single", "dependants":1, "dob_of_dependants":["2017-09-19T00:00:00Z"], "credit_rating":{ "rating":"OBP", "source":"OBP" }, "credit_limit":{ "currency":"EUR", "amount":"0" }, "highest_education_attained":"Master", "employment_status":"worker", "kyc_status":true, "last_ok_date":"2017-09-19T00:00:00Z", "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.
Version: OBPv3.1.0, function_name: by updateCustomerData, operation_id: OBPv3.1.0-updateCustomerData Tags: Customer, New-Style,

Create Meeting (video conference/call)

Create Meeting: Initiate a video conference/call with the bank.

The Meetings resource contains meta data about video/other conference sessions

provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).

purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).

Login is required.

This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"gh.29.uk", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-19T00:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "status":"String, eg: Good" }] }
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.
Version: OBPv3.1.0, function_name: by createMeeting, operation_id: OBPv3.1.0-createMeeting Tags: Customer-Meeting, Customer, Experimental, New-Style,

Get Meeting

Get Meeting specified by BANK_ID / MEETING_ID
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.

The actual conference/chats are handled by external services.

Login is required.

This call is experimental and will require further authorisation in the future.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"gh.29.uk", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-19T00:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "status":"String, eg: Good" }] }
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-30104: Meeting not found.
  • OBP-50000: Unknown Error.
Version: OBPv3.1.0, function_name: by getMeeting, operation_id: OBPv3.1.0-getMeeting Tags: Customer-Meeting, Customer, Experimental, New-Style,

Get Meetings

Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.

The actual conference/chats are handled by external services.

Login is required.

This call is experimental and will require further authorisation in the future.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "meetings":[{ "meeting_id":"UUID-String", "provider_id":"Chris", "purpose_id":"String, eg: onboarding", "bank_id":"gh.29.uk", "present":{ "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1" }, "keys":{ "session_id":"String", "staff_token":"String", "customer_token":"String" }, "when":"2017-09-19T00:00:00Z", "creator":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "invitees":[{ "contact_details":{ "name":"Simon ", "mobile_phone":"+44 07972 444 876", "email_address":"felixsmith@example.com" }, "status":"String, eg: Good" }] }] }
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.
Version: OBPv3.1.0, function_name: by getMeetings, operation_id: OBPv3.1.0-getMeetings Tags: Customer-Meeting, Customer, Experimental, New-Style,

Create Customer Message

Create a message for the customer specified by CUSTOMER_ID

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
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.
Version: OBPv1.4.0, function_name: by createCustomerMessage, operation_id: OBPv1.4.0-createCustomerMessage Tags: Customer-Message, Customer, Person,

Get Customer Messages (current)

Get messages for the logged in customer
Messages sent to the currently authenticated user.

Authentication via OAuth is required.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "messages":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "date":"2017-09-19T00:00:00Z", "message":"String", "from_department":"String", "from_person":"String" }] }
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: OBPv1.4.0, function_name: by getCustomerMessages, operation_id: OBPv1.4.0-getCustomerMessages Tags: Customer-Message, Customer,

Add KYC Check

Add a KYC check for the customer specified by CUSTOMER_ID. KYC Checks store details of checks on a customer made by the KYC team, their comments and a satisfied status

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "date":"2017-09-19T00:00:00Z", "how":"PlaceholderString", "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "staff_name":"PlaceholderString", "satisfied":true, "comments":"PlaceholderString" }
Required Roles:
  • CanAddKycCheck - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by addKycCheck, operation_id: OBPv2.0.0-addKycCheck Tags: KYC, Customer, New-Style,

Add KYC Document

Add a KYC document for the customer specified by CUSTOMER_ID. KYC Documents contain the document type (e.g. passport), place of issue, expiry etc.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "number":"PlaceholderString", "issue_date":"2017-09-19T00:00:00Z", "issue_place":"PlaceholderString", "expiry_date":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanAddKycDocument - 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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • Server error: could not add KycDocument
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by addKycDocument, operation_id: OBPv2.0.0-addKycDocument Tags: KYC, Customer, New-Style,

Add KYC Media

Add some KYC media for the customer specified by CUSTOMER_ID. KYC Media resources relate to KYC Documents and KYC Checks and contain media urls for scans of passports, utility bills etc

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "bank_id":"gh.29.uk", "customer_id":"PlaceholderString", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "url":"PlaceholderString", "date":"2017-09-19T00:00:00Z", "relates_to_kyc_document_id":"PlaceholderString", "relates_to_kyc_check_id":"PlaceholderString" }
Required Roles:
  • CanAddKycMedia - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-00004: Server error: could not add message
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by addKycMedia, operation_id: OBPv2.0.0-addKycMedia Tags: KYC, Customer, New-Style,

Add KYC Status

Add a kyc_status for the customer specified by CUSTOMER_ID. KYC Status is a timeline of the KYC status of the customer

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "ok":true, "date":"2017-09-19T00:00:00Z" }
Required Roles:
  • CanAddKycStatus - 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-50000: Unknown Error.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-00004: Server error: could not add message
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by addKycStatus, operation_id: OBPv2.0.0-addKycStatus Tags: KYC, Customer, New-Style,

Get Customer KYC Checks

Get KYC checks for the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "checks":[{ "bank_id":"gh.29.uk", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "date":"2017-09-19T00:00:00Z", "how":"PlaceholderString", "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "staff_name":"PlaceholderString", "satisfied":true, "comments":"PlaceholderString" }] }
Required Roles:
  • CanGetAnyKycChecks - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by getKycChecks, operation_id: OBPv2.0.0-getKycChecks Tags: KYC, Customer, New-Style,

Get Customer KYC Documents

Get KYC (know your customer) documents for a customer specified by CUSTOMER_ID
Get a list of documents that affirm the identity of the customer
Passport, driving licence etc.
Authentication is Optional

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "documents":[{ "bank_id":"gh.29.uk", "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "number":"PlaceholderString", "issue_date":"2017-09-19T00:00:00Z", "issue_place":"PlaceholderString", "expiry_date":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetAnyKycDocuments - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by getKycDocuments, operation_id: OBPv2.0.0-getKycDocuments Tags: KYC, Customer, New-Style,

Get Customer KYC statuses

Get the KYC statuses for a customer specified by CUSTOMER_ID over time.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "statuses":[{ "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh", "customer_number":"5987953", "ok":true, "date":"2017-09-19T00:00:00Z" }] }
Required Roles:
  • CanGetAnyKycStatuses - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by getKycStatuses, operation_id: OBPv2.0.0-getKycStatuses Tags: KYC, Customer, New-Style,

Get KYC Media for a customer

Get KYC media (scans, pictures, videos) that affirms the identity of the customer.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "medias":[{ "bank_id":"gh.29.uk", "customer_id":"PlaceholderString", "id":"PlaceholderString", "customer_number":"5987953", "type":"PlaceholderString", "url":"PlaceholderString", "date":"2017-09-19T00:00:00Z", "relates_to_kyc_document_id":"PlaceholderString", "relates_to_kyc_check_id":"PlaceholderString" }] }
Required Roles:
  • CanGetAnyKycMedia - 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-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Version: OBPv2.0.0, function_name: by getKycMedia, operation_id: OBPv2.0.0-getKycMedia Tags: KYC, Customer, New-Style,

Create User

Creates OBP user.
No authorisation (currently) required.

Mimics current webform to Register.

Requires username(email) and password.

Returns 409 error if username not unique.

May require validation of email address.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1", "email":"felixsmith@example.com", "provider_id":"Chris", "provider":"http://127.0.0.1:8080", "username":"felixsmith", "entitlements":{ "list":[{ "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723", "role_name":"CanQueryOtherUser", "bank_id":"gh.29.uk" }] } }
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-30207: Invalid Password Format. Your password should EITHER be at least 10 characters long and contain mixed numbers and both upper and lower case letters and at least one special character, OR be longer than 16 characters.
  • Error occurred during user creation.
  • User with the same username already exists.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by createUser, operation_id: OBPv2.0.0-createUser Tags: User, Onboarding,

Create User Invitation

Create User Invitation.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "first_name":"no-example-provided", "last_name":"no-example-provided", "email":"felixsmith@example.com", "company":"TESOBE", "country":"Germany", "purpose":"Developer", "status":"CREATED" }
Required Roles:
  • CanCreateUserInvitation - 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-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 createUserInvitation, operation_id: OBPv4.0.0-createUserInvitation Tags: User-Invitation, KYC, New-Style,

Get User Invitation Information

Create User Invitation Information.

Authentication is Optional

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "first_name":"no-example-provided", "last_name":"no-example-provided", "email":"felixsmith@example.com", "company":"TESOBE", "country":"Germany", "purpose":"Developer", "status":"CREATED" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • 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: OBPv4.0.0, function_name: by getUserInvitationAnonymous, operation_id: OBPv4.0.0-getUserInvitationAnonymous Tags: User-Invitation, KYC, New-Style,