{
  "domain":"Enter some domain",
  "tax_number":"Enter some number",
  "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanCreateTaxResidence - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-10001: Incorrect json format.
• OBP-50000: Unknown Error.

• obp.createTaxResidence
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

Request Headers:
                                        

Response Headers:
                                        

• CanDeleteCustomerAddress - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.deleteCustomerAddress
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.deleteTaxResidence
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "addresses":[{
    "customer_address_id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "line_1":"No 1 the Road",
    "line_2":"The Place",
    "line_3":"The Hill",
    "city":"Berlin",
    "county":"",
    "state":"Brandenburg",
    "postcode":"13359",
    "country_code":"DE",
    "tags":["mailing","home"],
    "status":"OK",
    "insert_date":"1100-01-01T00:00:00Z"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetCustomerAddress - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-20006: User is missing one or more roles:
• OBP-50000: Unknown Error.

• obp.getCustomerAddress
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2023-09-16T11:32:34Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr",
  "customer_attributes":[{
    "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"SPECIAL_TAX_NUMBER",
    "type":"STRING",
    "value":"123456789"
  }],
  "accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "product_code":"787LOW",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "branch_id":"DERBY6",
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_attributes":[{
      "contract_code":"LKJL98769F",
      "product_code":"1234BW",
      "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
      "name":"OVERDRAFT_START_DATE",
      "type":"DATE_WITH_DAY",
      "value":"2012-04-23"
    }]
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetCustomerOverview - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccounts
• obp.getCustomerAttributes
• obp.getCustomerByCustomerNumber

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "date_of_birth":"1100-01-01T00:00:00Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr",
  "customer_attributes":[{
    "customer_attribute_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "name":"SPECIAL_TAX_NUMBER",
    "type":"STRING",
    "value":"123456789"
  }],
  "accounts":[{
    "account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "label":"My Account",
    "product_code":"787LOW",
    "balance":{
      "currency":"EUR",
      "amount":"0"
    },
    "branch_id":"DERBY6",
    "contracts":[{
      "product_code":"787LOW",
      "contract_code":"LKJL98769F",
      "payment_method":"cache"
    }],
    "account_routings":[{
      "scheme":"AccountNumber",
      "address":"4930396"
    }],
    "account_attributes":[{
      "contract_code":"LKJL98769F",
      "product_code":"1234BW",
      "account_attribute_id":"613c83ea-80f9-4560-8404-b9cd4ec42a7f",
      "name":"OVERDRAFT_START_DATE",
      "type":"DATE_WITH_DAY",
      "value":"2012-04-23"
    }]
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetCustomerOverviewFlat - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getBankAccounts
• obp.getCustomerAttributes
• obp.getCustomerByCustomerNumber

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2023-09-16T11:32:34Z",
  "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"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetCustomer - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

• obp.getCustomerAttributes
• obp.getCustomerByCustomerNumber
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "legal_name":"Eveline Tripman",
  "mobile_phone_number":"+44 07972 444 876",
  "email":"felixsmith@example.com",
  "face_image":{
    "url":"www.openbankproject",
    "date":"1100-01-01T00:00:00Z"
  },
  "date_of_birth":"1100-01-01T00:00:00Z",
  "relationship_status":"single",
  "dependants":1,
  "dob_of_dependants":["1100-01-01T00:00:00Z"],
  "credit_rating":{
    "rating":"OBP",
    "source":"OBP"
  },
  "credit_limit":{
    "currency":"EUR",
    "amount":"0"
  },
  "highest_education_attained":"Master",
  "employment_status":"worker",
  "kyc_status":false,
  "last_ok_date":"2023-09-16T11:32:34Z",
  "title":"Dr.",
  "branch_id":"DERBY6",
  "name_suffix":"Sr"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.

• obp.getCustomersByCustomerPhoneNumber

								
									
{
  "tax_residence":[{
    "domain":"Enter some domain",
    "tax_number":"Enter some number",
    "tax_residence_id":"902ba3bb-dedd-45e7-9319-2fd3f2cd98a1"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-50000: Unknown Error.

• obp.getTaxResidence
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "date":"1100-01-01T00:00:00Z",
  "how":"PlaceholderString",
  "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "staff_name":"PlaceholderString",
  "satisfied":true,
  "comments":"PlaceholderString"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanAddKycCheck - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.createOrUpdateKycCheck
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "number":"PlaceholderString",
  "issue_date":"1100-01-01T00:00:00Z",
  "issue_place":"PlaceholderString",
  "expiry_date":"1100-01-01T00:00:00Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanAddKycDocument - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.createOrUpdateKycDocument
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "bank_id":"gh.29.uk",
  "customer_id":"PlaceholderString",
  "id":"PlaceholderString",
  "customer_number":"5987953",
  "type":"PlaceholderString",
  "url":"PlaceholderString",
  "date":"1100-01-01T00:00:00Z",
  "relates_to_kyc_document_id":"PlaceholderString",
  "relates_to_kyc_check_id":"PlaceholderString"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanAddKycMedia - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.createOrUpdateKycMedia
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "customer_number":"5987953",
  "ok":true,
  "date":"1100-01-01T00:00:00Z"
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanAddKycStatus - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.createOrUpdateKycStatus
• obp.getCustomerByCustomerId
• obp.getBank
• obp.getBankAccountsForUser

								
									
{
  "checks":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "date":"1100-01-01T00:00:00Z",
    "how":"PlaceholderString",
    "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "staff_name":"PlaceholderString",
    "satisfied":true,
    "comments":"PlaceholderString"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyKycChecks - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.getKycChecks
• obp.getCustomerByCustomerId
• obp.getBankAccountsForUser

								
									
{
  "documents":[{
    "bank_id":"gh.29.uk",
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "number":"PlaceholderString",
    "issue_date":"1100-01-01T00:00:00Z",
    "issue_place":"PlaceholderString",
    "expiry_date":"1100-01-01T00:00:00Z"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyKycDocuments - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.getKycDocuments
• obp.getCustomerByCustomerId
• obp.getBankAccountsForUser

								
									
{
  "statuses":[{
    "customer_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "customer_number":"5987953",
    "ok":true,
    "date":"1100-01-01T00:00:00Z"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyKycStatuses - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.getKycStatuses
• obp.getCustomerByCustomerId
• obp.getBankAccountsForUser

								
									
{
  "medias":[{
    "bank_id":"gh.29.uk",
    "customer_id":"PlaceholderString",
    "id":"PlaceholderString",
    "customer_number":"5987953",
    "type":"PlaceholderString",
    "url":"PlaceholderString",
    "date":"1100-01-01T00:00:00Z",
    "relates_to_kyc_document_id":"PlaceholderString",
    "relates_to_kyc_check_id":"PlaceholderString"
  }]
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanGetAnyKycMedia - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-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:

• obp.getKycMedias
• obp.getCustomerByCustomerId
• obp.getBankAccountsForUser

								
									
{
  "first_name":"Tom",
  "last_name":"Smith",
  "email":"felixsmith@example.com",
  "company":"Tesobe GmbH",
  "country":"Germany",
  "purpose":"DEVELOPER",
  "status":""
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• CanCreateUserInvitation - Please login to request this Role

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• OBP-20001: User not logged in. Authentication is required!
• OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
• OBP-30008: User Customer Link not found by USER_ID
• OBP-50000: Unknown Error.
• OBP-20006: User is missing one or more roles:

								
									
{
  "first_name":"Tom",
  "last_name":"Smith",
  "email":"felixsmith@example.com",
  "company":"Tesobe GmbH",
  "country":"Germany",
  "purpose":"DEVELOPER",
  "status":""
}
								
							

Request Headers:
                                        

Response Headers:
                                        

• Required JSON Validation: No
• Allowed Authentication Types: Not set

• 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.