API Explorer

v4.0.0 (361 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
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:
Implemented in OBPv2.0.0 by addSocialMediaHandle, operation_id: OBPv2.0.0-addSocialMediaHandle

Create Address

Create an Address for a Customer specified by CUSTOMER_ID.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

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
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.
Implemented in OBPv3.1.0 by createCustomerAddress, operation_id: OBPv3.1.0-createCustomerAddress

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" }
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by createCreditLimitRequest, operation_id: OBPv3.1.0-createCreditLimitRequest

Create Customer

The Customer resource stores the customer number, 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

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
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:
Implemented in OBPv3.1.0 by createCustomer, operation_id: OBPv3.1.0-createCustomer

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
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:
Implemented in OBPv4.0.0 by createCustomerAttribute, operation_id: OBPv4.0.0-createCustomerAttribute

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
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.
Implemented in OBPv3.1.0 by createTaxResidence, operation_id: OBPv3.1.0-createTaxResidence

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

Implemented in OBPv2.0.0 by createUserCustomerLinks, operation_id: OBPv2.0.0-createUserCustomerLinks

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
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:
Implemented in OBPv4.0.0 by createOrUpdateCustomerAttributeAttributeDefinition, operation_id: OBPv4.0.0-createOrUpdateCustomerAttributeAttributeDefinition

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
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by deleteCustomerAddress, operation_id: OBPv3.1.0-deleteCustomerAddress

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
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.
Implemented in OBPv4.0.0 by deleteCustomerAttribute, operation_id: OBPv4.0.0-deleteCustomerAttribute

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
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:
Implemented in OBPv4.0.0 by deleteCustomerAttributeDefinition, operation_id: OBPv4.0.0-deleteCustomerAttributeDefinition

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":"{}" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by deleteTaxResidence, operation_id: OBPv3.1.0-deleteTaxResidence

Delete User Customer Link by USER_CUSTOMER_LINK_ID

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Implemented in OBPv4.0.0 by deleteUserCustomerLink, operation_id: OBPv4.0.0-deleteUserCustomerLink

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" }] }
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:
Implemented in OBPv1.4.0 by getCrmEvents, operation_id: OBPv1.4.0-getCrmEvents

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" }
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCreditLimitRequestByRequestId, operation_id: OBPv3.1.0-getCreditLimitRequestByRequestId

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" }
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.1.0 by getCreditLimitRequests, operation_id: OBPv3.1.0-getCreditLimitRequests

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
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getCustomerAddresses, operation_id: OBPv3.1.0-getCustomerAddresses

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
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:
Implemented in OBPv4.0.0 by getCustomerAttributeById, operation_id: OBPv4.0.0-getCustomerAttributeById

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
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:
Implemented in OBPv4.0.0 by getCustomerAttributeDefinition, operation_id: OBPv4.0.0-getCustomerAttributeDefinition

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
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:
Implemented in OBPv4.0.0 by getCustomerAttributes, operation_id: OBPv4.0.0-getCustomerAttributes

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
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:
Implemented in OBPv2.0.0 by getSocialMediaHandles, operation_id: OBPv2.0.0-getSocialMediaHandles

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
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.
Implemented in OBPv3.1.0 by getCustomerByCustomerId, operation_id: OBPv3.1.0-getCustomerByCustomerId

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
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:
Implemented in OBPv3.1.0 by getCustomerByCustomerNumber, operation_id: OBPv3.1.0-getCustomerByCustomerNumber

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
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:
Implemented in OBPv4.0.0 by getCustomersByAttributes, operation_id: OBPv4.0.0-getCustomersByAttributes

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" }
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.
Implemented in OBPv4.0.0 by getCustomersByCustomerPhoneNumber, operation_id: OBPv4.0.0-getCustomersByCustomerPhoneNumber

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" }] }
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.
Implemented in OBPv3.0.0 by getCustomersForUser, operation_id: OBPv3.0.0-getCustomersForUser

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

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
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.
Implemented in OBPv3.1.0 by getFirehoseCustomers, operation_id: OBPv3.1.0-getFirehoseCustomers

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" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getTaxResidence, operation_id: OBPv3.1.0-getTaxResidence

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
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:
Implemented in OBPv4.0.0 by getUserCustomerLinksByCustomerId, operation_id: OBPv4.0.0-getUserCustomerLinksByCustomerId

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
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:
Implemented in OBPv4.0.0 by getUserCustomerLinksByUserId, operation_id: OBPv4.0.0-getUserCustomerLinksByUserId

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
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:
Implemented in OBPv4.0.0 by updateCustomerAttribute, operation_id: OBPv4.0.0-updateCustomerAttribute

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" }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by updateCustomerAddress, operation_id: OBPv3.1.0-updateCustomerAddress

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
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.
Implemented in OBPv3.1.0 by updateCustomerBranch, operation_id: OBPv3.1.0-updateCustomerBranch

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
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.
Implemented in OBPv3.1.0 by updateCustomerCreditLimit, operation_id: OBPv3.1.0-updateCustomerCreditLimit

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
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.
Implemented in OBPv3.1.0 by updateCustomerCreditRatingAndSource, operation_id: OBPv3.1.0-updateCustomerCreditRatingAndSource

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
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.
Implemented in OBPv3.1.0 by updateCustomerEmail, operation_id: OBPv3.1.0-updateCustomerEmail

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
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.
Implemented in OBPv3.1.0 by updateCustomerIdentity, operation_id: OBPv3.1.0-updateCustomerIdentity

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
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.
Implemented in OBPv3.1.0 by updateCustomerMobileNumber, operation_id: OBPv3.1.0-updateCustomerMobileNumber

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
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.
Implemented in OBPv3.1.0 by updateCustomerNumber, operation_id: OBPv3.1.0-updateCustomerNumber

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
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.
Implemented in OBPv3.1.0 by updateCustomerData, operation_id: OBPv3.1.0-updateCustomerData