API Explorer

Open Bank Project
Login

OBP v3.1.0 filtered by tag: Customer, KYC, Onboarding (42 APIs)

API Host: https://api.openbankproject.com

Bank

Accounts

Views

Counterparties

Transactions

Create Account

Create Account at bank specified by BANK_ID with Id specified by ACCOUNT_ID.

The User can create an Account for themself - or - the User that has the USER_ID specified in the POST body.

If the PUT body USER_ID is specified, the logged in user must have the Role canCreateAccount. Once created, the Account will be owned by the User specified by USER_ID.

If the PUT body USER_ID is not specified, the account will be owned by the logged in User.

The 'type' field SHOULD be a product_code from Product.
If the type matches a product_code from Product, account attributes will be created that match the Product Attributes.

Note: The Amount MUST be zero.

Typical Successful Response:

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "label":"My Account",
  "type":"AC",
  "balance":{
    "currency":"EUR",
    "amount":"10"
  },
  "branch_id":"DERBY6",
  "account_routing":{
    "scheme":"AccountNumber",
    "address":"4930396"
  },
  "account_attributes":[{
    "product_code":"saving1",
    "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
    "name":"OVERDRAFT_START_DATE",
    "type":"DATE_WITH_DAY",
    "value":"2012-04-23"
  }]
}
Headers:
Required Roles:
  • CanCreateAccount - Please login to request this Role
Possible Errors:
  • OBP-10001: Incorrect json format.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30107: Invalid User Id.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • 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-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30106: Invalid Balance Amount.
  • OBP-30112: Invalid Number. Initial balance must be a number, e.g 1000.00
  • OBP-30109: Initial Balance of Account must be Zero (0).
  • OBP-30105: Invalid Balance Currency.
  • OBP-30208: Account_ID already exists at the Bank.
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by createAccount

Add Address to Customer

Add an Address to the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

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"
}
Headers:
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

Add Social Media Handle

Add a social media handle for the customer specified by CUSTOMER_ID.

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
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.
Implemented in OBPv2.0.0 by addSocialMediaHandle

Add Tax Residence to Customer

Add a Tax Residence to the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
Headers:
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

Create Credit Limit Order Request

NOTE: This endpoint currently only returns example data.

Create credit limit order request

Typical Successful Response:

								
									
{
  "execution_time":"String",
  "execution_date":"String",
  "token":"String",
  "short_reference":"String"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by 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

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
Required Roles:
  • CanCreateCustomer - Please login to request this Role
  • CanCreateUserCustomerLink - Please login to request this Role
  • CanCreateCustomerAtAnyBank - Please login to request this Role
  • CanCreateUserCustomerLinkAtAnyBank - 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.
Implemented in OBPv3.1.0 by createCustomer

Create User Customer Link.

Link a User to a Customer

Authentication is Mandatory

CanCreateUserCustomerLink OR CanCreateUserCustomerLinkAtAnyBank entitlements are required.

Typical Successful Response:

								
									
{
  "user_customer_link_id":"String",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "date_inserted":"2017-09-19T00:00:00Z",
  "is_active":true
}
Headers:
Required Roles:
  • CanCreateUserCustomerLink - Please login to request this Role
  • CanCreateUserCustomerLinkAtAnyBank - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-20006: User is missing one or more roles:
  • OBP-30007: The User is already linked to a Customer at the bank specified by BANK_ID
  • OBP-30025: Could not create user_customer_links
  • OBP-50000: Unknown Error.
Implemented in OBPv2.0.0 by createUserCustomerLinks

Delete Customer Address

Delete an Address of the Customer specified by CUSTOMER_ADDRESS_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
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

Delete Tax Residence

Delete a Tax Residence of the Customer specified by TAX_RESIDENCE_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
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 deleteTaxResidence

Get CRM Events
Typical Successful Response:

								
									
{
  "crm_events":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "bank_id":"GENODEM1GLS",
    "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"
  }]
}
Headers:
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.
Implemented in OBPv1.4.0 by 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
Typical Successful Response:

								
									
{
  "rank_amount_1":"String",
  "nominal_interest_1":"String",
  "rank_amount_2":"String",
  "nominal_interest_2":"String"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getCreditLimitRequestByRequestId

Get Credit Limit Order Requests

NOTE: This endpoint currently only returns example data.

Get Credit Limit Order Requests

Typical Successful Response:

								
									
{
  "rank_amount_1":"String",
  "nominal_interest_1":"String",
  "rank_amount_2":"String",
  "nominal_interest_2":"String"
}
Headers:
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv3.1.0 by getCreditLimitRequests

Get Customer Addresses

Get the Addresses of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

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"
  }]
}
Headers:
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

Get Customer Social Media Handles

Get social media handles for a customer specified by CUSTOMER_ID.

Authentication is Mandatory

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"
  }]
}
Headers:
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.
Implemented in OBPv2.0.0 by getSocialMediaHandles

Get Customer by CUSTOMER_ID

Gets the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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.1.0 by getCustomerByCustomerId

Get Customer by CUSTOMER_NUMBER

Gets the Customer specified by CUSTOMER_NUMBER.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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.1.0 by getCustomerByCustomerNumber

Get Customers for Current User

Gets all Customers that are linked to a User.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"2017-09-19T00:00:00Z"
  },
  "date_of_birth":"19900101",
  "relationship_status":"single",
  "dependants":10,
  "dob_of_dependants":["19900101"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Get Customers for current User at Bank

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

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z"
}
Headers:
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-30008: User Customer Link not found by USER_ID
  • OBP-30046: Customer not found. Please specify a valid value for CUSTOMER_ID.
  • OBP-50000: Unknown Error.
Implemented in OBPv2.1.0 by getCustomersForCurrentUserAtBank

Get Tax Residences of Customer

Get the Tax Residences of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
Headers:
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 getTaxResidence

Update the Address of a Customer

Update an Address of the Customer specified by CUSTOMER_ADDRESS_ID.

Authentication is Mandatory

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"
}
Headers:
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 updateCustomerAddress

Update the Branch of a Customer

Update the Branch of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the credit limit of a Customer

Update the credit limit of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

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

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the email of a Customer

Update an email of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the identity data of a Customer

Update the identity data of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the mobile number of a Customer

Update the mobile number of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the number of a Customer

Update the number of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

Update the other data of a Customer

Update the other data of the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"eveline@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":10,
  "dob_of_dependants":["2017-09-19T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"10"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":true,
  "last_ok_date":"2017-09-19T00:00:00Z",
  "title":"Dr.",
  "branchId":"DERBY6",
  "nameSuffix":"Sr"
}
Headers:
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

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.

Typical Successful Response:

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"String, eg: tokbox",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"GENODEM1GLS",
  "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":"eveline@example.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"eveline@example.com"
    },
    "status":"String, eg: Good"
  }]
}
Headers:
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.
Implemented in OBPv3.1.0 by createMeeting

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.

Typical Successful Response:

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"String, eg: tokbox",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"GENODEM1GLS",
  "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":"eveline@example.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"eveline@example.com"
    },
    "status":"String, eg: Good"
  }]
}
Headers:
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.
Implemented in OBPv3.1.0 by getMeeting

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.

Typical Successful Response:

								
									
{
  "meetings":[{
    "meeting_id":"UUID-String",
    "provider_id":"String, eg: tokbox",
    "purpose_id":"String, eg: onboarding",
    "bank_id":"GENODEM1GLS",
    "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":"eveline@example.com"
    },
    "invitees":[{
      "contact_details":{
        "name":"Simon ",
        "mobile_phone":"+44 07972 444 876",
        "email_address":"eveline@example.com"
      },
      "status":"String, eg: Good"
    }]
  }]
}
Headers:
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.
Implemented in OBPv3.1.0 by getMeetings

Create Customer Message.

Create a message for the customer specified by CUSTOMER_ID

Typical Successful Response:

								
									
{
  "success":"Success"
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv1.4.0 by createCustomerMessage

Get Customer Messages (current)

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

Authentication via OAuth is required.

Typical Successful Response:

								
									
{
  "messages":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "date":"2017-09-19T00:00:00Z",
    "message":"String",
    "from_department":"String",
    "from_person":"String"
  }]
}
Headers:
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implemented in OBPv1.4.0 by getCustomerMessages

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.

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "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"
}
Headers:
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.
Implemented in OBPv2.0.0 by addKycCheck

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.

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "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"
}
Headers:
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.
Implemented in OBPv2.0.0 by addKycDocument

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.

Typical Successful Response:

								
									
{
  "bank_id":"GENODEM1GLS",
  "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"
}
Headers:
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.
Implemented in OBPv2.0.0 by addKycMedia

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

Typical Successful Response:

								
									
{
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "ok":true,
  "date":"2017-09-19T00:00:00Z"
}
Headers:
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.
Implemented in OBPv2.0.0 by addKycStatus

Get Customer KYC Checks

Get KYC checks for the Customer specified by CUSTOMER_ID.

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "checks":[{
    "bank_id":"GENODEM1GLS",
    "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"
  }]
}
Headers:
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.
Implemented in OBPv2.0.0 by getKycChecks

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

Typical Successful Response:

								
									
{
  "documents":[{
    "bank_id":"GENODEM1GLS",
    "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"
  }]
}
Headers:
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.
Implemented in OBPv2.0.0 by getKycDocuments

Get Customer KYC statuses

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

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "statuses":[{
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "ok":true,
    "date":"2017-09-19T00:00:00Z"
  }]
}
Headers:
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.
Implemented in OBPv2.0.0 by getKycStatuses

Get KYC Media for a customer

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

Authentication is Mandatory

Typical Successful Response:

								
									
{
  "medias":[{
    "bank_id":"GENODEM1GLS",
    "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"
  }]
}
Headers:
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.
Implemented in OBPv2.0.0 by getKycMedia

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.

Typical Successful Response:

								
									
{
  "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "email":"eveline@example.com",
  "provider_id":"OBP",
  "provider":"OBP",
  "username":"robert.x.0.gh",
  "entitlements":{
    "list":[{
      "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
      "role_name":"CanQueryOtherUser",
      "bank_id":"GENODEM1GLS"
    }]
  }
}
Headers:
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.
Implemented in OBPv2.0.0 by createUser

Get documentation about the selected endpoints as:

Resource Docs JSON

 

Swagger 2 JSON

This list can be used as a basis to limit the available endpoints by editing the API Props:

[createAccount, createCustomerAddress, addSocialMediaHandle, createTaxResidence, createCreditLimitRequest, createCustomer, createUserCustomerLinks, deleteCustomerAddress, deleteTaxResidence, getCrmEvents, getCreditLimitRequestByRequestId, getCreditLimitRequests, getCustomerAddresses, getSocialMediaHandles, getCustomerByCustomerId, getCustomerByCustomerNumber, getCustomersForUser, getCustomersForCurrentUserAtBank, getTaxResidence, updateCustomerAddress, updateCustomerBranch, updateCustomerCreditLimit, updateCustomerCreditRatingAndSource, updateCustomerEmail, updateCustomerIdentity, updateCustomerMobileNumber, updateCustomerNumber, updateCustomerData, createMeeting, getMeeting, getMeetings, createCustomerMessage, getCustomerMessages, addKycCheck, addKycDocument, addKycMedia, addKycStatus, getKycChecks, getKycDocuments, getKycStatuses, getKycMedia, createUser]