API scopes

API scopes control the actions that applications integrating with Vitesse can perform. Each scope grants permission to access and perform specific API operations.

Scopes enforce separation of duties and help protect access to your data. For example, an application can have read-only access to payment data without permission to create or modify payments.

💡
When authenticating with the API, request only the scopes required by your integration.
For more information, see Authentication: Vitesse API and Authentication: Transaction API.

API scope	Description
Create Account Movements	Create and approve account movements.
View Account Movements	View account movements.
View Accounts	View account details and balances.
Create Cheque Voids	Create and approve cheque void requests.
View Cheque Voids	View cheque void requests and statuses.
Create Deferred Transaction Groups	Create and approve deferred transaction groups.
View Deferred Transaction Groups	View deferred transaction groups and statuses.
Create Deferred Transaction Requests	Create and approve deferred transaction requests.
View Deferred Transaction Requests	View deferred transaction requests and statuses.
Create Forex Transactions	Create and approve foreign exchange transactions.
View Forex Transactions	View foreign exchange transactions and rates.
Create Payee Payment Requests	Create and approve payee payment requests.
View Payee Payment Requests	View payee payment requests and statuses.
Create Recipients	Create recipient records for payments and transactions.
Delete Recipients	Delete recipient records.
View Recipients	View recipient records and details.
Update Recipients	Edit and manage recipient records.
View Rules	View configured business and transaction rules.
Create Transaction Requests	Create and approve transaction requests.
View Transaction Requests	View transaction requests and statuses.
View Transactions	View transaction history and transaction details.

📘
All API requests require an identity token with the appropriate scopes. For information about configuring identity clients, see Manage identity clients.