openbankproject_client.consent module

Consent endpoints for the OpenBankProject API Client.

class openbankproject_client.consent.ConsentEndpoints(client)

Bases: object

Consent-related API endpoints.

__init__(client)

Initialize the endpoint group.

Parameters:

client – OpenBankProjectClient instance

create_consent(bank_id: str, data: Dict) → Dict

Create Consent.

Parameters:

• bank_id – Bank identifier

• data – Consent data

Returns:

Dict containing created consent information

get_consent_by_id(consent_id: str) → Dict

Get Consent By Id.

Parameters:

consent_id – Consent identifier

Returns:

Dict containing consent information

get_consents() → Dict

Get Consents.

Returns:

Dict containing consents information

revoke_consent(consent_id: str) → Dict

Revoke Consent.

Parameters:

consent_id – Consent identifier

Returns:

Dict containing revocation status

answer_consent_challenge(consent_id: str, data: Dict) → Dict

Answer Consent Challenge.

Parameters:

• consent_id – Consent identifier

• data – Challenge answer data

Returns:

Dict containing challenge response information

get_consent_status(consent_id: str) → Dict

Get Consent Status.

Parameters:

consent_id – Consent identifier

Returns:

Dict containing consent status information

get_consent_by_bank_id_and_consent_id(bank_id: str, consent_id: str) → Dict

Get Consent By Bank Id and Consent Id.

Parameters:

• bank_id – Bank identifier

• consent_id – Consent identifier

Returns:

Dict containing consent information

get_consents_by_bank_id(bank_id: str) → Dict

Get Consents By Bank Id.

Parameters:

bank_id – Bank identifier

Returns:

Dict containing consents information

update_consent_status(consent_id: str, data: Dict) → Dict

Update Consent Status.

Parameters:

• consent_id – Consent identifier

• data – Updated status data

Returns:

Dict containing updated consent information