openbankproject_client.kyc module

KYC endpoints for the OpenBankProject API Client.

class openbankproject_client.kyc.KycEndpoints(client)[source]

Bases: object

KYC-related API endpoints.

__init__(client)[source]

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

add_kyc_check(bank_id: str, customer_id: str, data: Dict) Dict[source]

Add KYC Check.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

  • data – KYC check data

Returns:

Dict containing created KYC check information

add_kyc_document(bank_id: str, customer_id: str, data: Dict) Dict[source]

Add KYC Document.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

  • data – KYC document data

Returns:

Dict containing created KYC document information

add_kyc_media(bank_id: str, customer_id: str, data: Dict) Dict[source]

Add KYC Media.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

  • data – KYC media data

Returns:

Dict containing created KYC media information

add_kyc_status(bank_id: str, customer_id: str, data: Dict) Dict[source]

Add KYC Status.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

  • data – KYC status data

Returns:

Dict containing created KYC status information

get_customer_kyc_checks(bank_id: str, customer_id: str) Dict[source]

Get Customer KYC Checks.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

Returns:

Dict containing KYC checks information

get_customer_kyc_documents(bank_id: str, customer_id: str) Dict[source]

Get Customer KYC Documents.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

Returns:

Dict containing KYC documents information

get_customer_kyc_statuses(bank_id: str, customer_id: str) Dict[source]

Get Customer KYC statuses.

Parameters:
  • bank_id – Bank identifier

  • customer_id – Customer identifier

Returns:

Dict containing KYC statuses information

get_kyc_media_for_customer(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 KYC media information