Consent Scopes

Here we provide a breakdown on the configurable scopes for your very own customisable consent policy. You can see the name and description, the API endpoints where it returns the data, as well as what specific data points are fetched with each one.

Consent Scope	Entity	Description	Attributes
Name and occupation	Basiq API `/connections`CDR Scope `common:customer.basic:read`	The scope allows access to personally identifiable information about the customer. Includes name and occupation of the individual.	Name Occupation
Name, occupation, contact details	Basiq API `/connections`CDR Scope `common:customer.detail:read`	The scope allows access to more detailed information about the customer. Includes the data available with the Basic Customer Data scope plus contact details. Includes basic data plus phone, email and address information.	Name Occupation Phone Email address Mail address Residential address
Organisation profile	Basiq API `/identities`CDR Scope `common:customer.basic:read`	The scope allows access to identifiable information about the customer. Includes business numbers and industry code for organisations	Agent name and role Organisation name Organisation numbers (ABN or ACN) Charity status Establishment date Industry Organisation type Country of registration
Organisation profile and contact details	Basiq API `/identities`CDR Scope `common:customer.detail:read`	The scope allows access to more detailed information about the customer. Includes the data available with the Basic Customer Data scope plus contact details. Includes basic data plus phone, email and address information.	Agent name and role Organisation name Organisation numbers (ABN or ACN) Charity status Establishment date Industry Organisation type Country of registration Organisation address Mail address Phone number
Account name, type and balance	Basiq API `/accounts`CDR Scope `bank:accounts.basic:read`	This scope allows access to basic information of the customer's accounts.Includes simple account information including balance. This scope does not include account numbers, product information or transaction data.Account number in this scope is maskedAccount name, type and balance are required.	Name of account Account number Type of account Account balance
Account numbers and featuresrequires Account name, type and balance scope	Basiq API `/accounts`CDR Scope `bank:accounts.detail:read`	This scope allows access to detailed information of the customer's accounts. Includes basic account information plus account identifiers and product information. Does not include transaction data.	Account number Interest rates Fees Discounts Account terms Account mail address
Transaction details	Basiq API `/transactions`CDR Scope `bank:transactions:read`	This scope allows access to transaction data for accounts. Includes all account transaction data.	Incoming and outgoing transactions Amounts Dates Descriptions of transactions Who you have sent money to and received money from
Bank Payee Data	Basiq API `/payees` CDR Scope `bank:payees:read`	This scope allows access to payee information stored by the customer.	Billers international beneficiaries domestic payees.