openbankproject_client.customer module
Customer endpoints for the OpenBankProject API Client.
- class openbankproject_client.customer.CustomerEndpoints(client)[source]
Bases:
objectCustomer-related API endpoints.
- __init__(client)[source]
Initialize the endpoint group.
- Parameters:
client – OpenBankProjectClient instance
- get_customers(bank_id: str, params: Dict | None = None) Dict[source]
Get all customers at a specific bank.
- Parameters:
bank_id – Bank identifier
params – Optional query parameters like limit, offset, etc.
- Returns:
Dict containing customer information
- get_customer_by_id(bank_id: str, customer_id: str) Dict[source]
Get customer by ID at a specific bank.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer information
- create_customer(bank_id: str, data: Dict) Dict[source]
Create a new customer at a specific bank.
- Parameters:
bank_id – Bank identifier
data – Customer data
- Returns:
Dict containing created customer information
- update_customer(bank_id: str, customer_id: str, data: Dict) Dict[source]
Update an existing customer at a specific bank.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – Updated customer data
- Returns:
Dict containing updated customer information
- delete_customer(bank_id: str, customer_id: str) Dict[source]
Delete a customer at a specific bank.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing deletion status
- get_customer_attributes(bank_id: str, customer_id: str) Dict[source]
Get attributes for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer attribute information
- add_customer_attribute(bank_id: str, customer_id: str, data: Dict) Dict[source]
Add an attribute to a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – Attribute data
- Returns:
Dict containing added attribute information
- update_customer_attribute(bank_id: str, customer_id: str, attribute_id: str, data: Dict) Dict[source]
Update an attribute of a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
attribute_id – Attribute identifier
data – Updated attribute data
- Returns:
Dict containing updated attribute information
- delete_customer_attribute(bank_id: str, customer_id: str, attribute_id: str) Dict[source]
Delete an attribute from a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
attribute_id – Attribute identifier
- Returns:
Dict containing deletion status
- get_customer_messages(bank_id: str, customer_id: str) Dict[source]
Get messages for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer message information
- add_customer_message(bank_id: str, customer_id: str, data: Dict) Dict[source]
Add a message to a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – Message data
- Returns:
Dict containing added message information
- update_customer_message(bank_id: str, customer_id: str, message_id: str, data: Dict) Dict[source]
Update a message of a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
message_id – Message identifier
data – Updated message data
- Returns:
Dict containing updated message information
- delete_customer_message(bank_id: str, customer_id: str, message_id: str) Dict[source]
Delete a message from a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
message_id – Message identifier
- Returns:
Dict containing deletion status
- get_customer_kyc_status(bank_id: str, customer_id: str) Dict[source]
Get KYC status for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer KYC status information
- get_customer_kyc_media(bank_id: str, customer_id: str) Dict[source]
Get KYC media for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer KYC media information
- get_customer_kyc_documents(bank_id: str, customer_id: str) Dict[source]
Get KYC documents for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer KYC document information
- get_customer_kyc_checks(bank_id: str, customer_id: str) Dict[source]
Get KYC checks for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer KYC check information
- get_customer_user_links(bank_id: str, customer_id: str) Dict[source]
Get user links for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer user link information
- create_customer_user_link(bank_id: str, customer_id: str, data: Dict) Dict[source]
Create a user link for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – User link data
- Returns:
Dict containing created user link information
- update_customer_user_link(bank_id: str, customer_id: str, link_id: str, data: Dict) Dict[source]
Update a user link for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
link_id – User link identifier
data – Updated user link data
- Returns:
Dict containing updated user link information
- delete_customer_user_link(bank_id: str, customer_id: str, link_id: str) Dict[source]
Delete a user link from a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
link_id – User link identifier
- Returns:
Dict containing deletion status
- get_customer_account_links(bank_id: str, customer_id: str) Dict[source]
Get account links for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
- Returns:
Dict containing customer account link information
- create_customer_account_link(bank_id: str, customer_id: str, data: Dict) Dict[source]
Create an account link for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
data – Account link data
- Returns:
Dict containing created account link information
- update_customer_account_link(bank_id: str, customer_id: str, link_id: str, data: Dict) Dict[source]
Update an account link for a customer.
- Parameters:
bank_id – Bank identifier
customer_id – Customer identifier
link_id – Account link identifier
data – Updated account link data
- Returns:
Dict containing updated account link information