Create a Data Recipient
Use the /api/v1/recipients endpoint to add a new Data Recipient to the Open Banking API.
/api/v1/recipients endpoint to add a new Data Recipient to the Open Banking API.
To successfully call this endpoint, you must first call the /Token endpoint to obtain a valid access_token using the following settings:
- grant_type:
client_credentials - client_id:
{partner client_id} - client_secret:
{partner client_secret} - scope:
client:admin
Body
The scope of data that the Data Recipient collects from the customer, and is populated on the consent screen. To work with this Data Recipient, the customer must provide consent to share the scope of data they require. Possible values include the following:
ACCOUNT_BASIC = Basic account information (required) ACCOUNT_DETAILED = Detailed account information ACCOUNT_PAYMENTS = Payment information linked to the account INVESTMENTS = Investment information linked to the account TRANSACTIONS = Payment information linked to the account STATEMENTS = PDF statements for the account CUSTOMER_CONTACT = Contact information for the account CUSTOMER_PERSONAL = Information about the customer who owns the account The scopes needs to be delimited by a space and they must include ACCOUNT_BASIC at a minimum