Identity client roles

An identity client represents a system, such as an application or service, that authenticates with the Vitesse API. It provides the client credentials the system uses to request short-lived access tokens. You assign roles to the identity client to control which API operations the system can perform with those tokens. For example, you can allow the system to view payment data without allowing it to create or modify payments.

Unlike a user role, an identity client represents the calling system rather than an individual person.

Identity client roles and OAuth scopes

Each access token issued for an identity client contains its assigned roles and requested OAuth scopes. The API uses both to control access to API operations and rejects a request if either required value is missing.

Each operation’s documentation specifies its access requirements, including the required OAuth scope and identity client role. For a complete list of scopes and information about requesting them, see Authentication.

💡

When configuring an identity client, assign only the roles required by your integration.

Identity client roleRole identifierDescription
View AccountsAccounts.LookupRetrieve account details, balances and account entries.
Create Account MovementsAccountMovements.CreateCreate, validate, approve and cancel account movements.
View Account MovementsAccountMovements.LookupList and retrieve account movements.
Approvals Managerapprovals.managerManage approval workflow tasks.
Create Cheque VoidsChequeVoid.CreateCreate requests to void cheques.
View Cheque VoidsChequeVoid.LookupRetrieve cheque void requests and their statuses.
Create Deferred Transaction GroupsDeferredTransactionGroups.CreateDeprecated, do not use for new integrations. Create deferred transaction groups.
View Deferred Transaction GroupsDeferredTransactionGroups.LookupDeprecated, do not use for new integrations. Retrieve deferred transaction groups.
Create Deferred Transaction RequestsDeferredTransactionRequests.CreateDeprecated, do not use for new integrations. Create and validate deferred transaction request.
View Deferred Transaction RequestsDeferredTransactionRequests.LookupDeprecated, do not use for new integrations. Retrieve deferred transaction requests.
Create Forex TransactionsForex.CreateCreate foreign exchange rate groups.
View Forex TransactionsForex.LookupRetrieve foreign exchange rate groups and indicative rates.
Payment Requests Approverpayment-requests.approverApprove payments that require approval.
Payment Requests Managerpayment-requests.managerCreate and manage payments.
Payment Requests Viewerpayment-requests.viewerView payments and their statuses.
Programmes Managerprogrammes.managerCreate and manage programmes.
Programmes Viewerprogrammes.viewerView programme details.
View RulesRules.LookupRetrieve validation rules for a destination country, currency and payment route.
Stored Recipients Managerstored-recipients.managerCreate, update and delete stored recipients through endpoints that require the stored-recipients scope.
Stored Recipients Viewerstored-recipients.viewerList and retrieve stored recipients through endpoints that require the stored-recipients scope.
Create Stored RecipientsRecipients.CreateCreate stored recipient records through endpoints that require the API scope.
View Stored RecipientsRecipients.LookupList and retrieve stored recipient records through endpoints that require the API scope.
Update Stored RecipientsRecipients.UpdateUpdate stored recipient records through endpoints that require the API scope.
Delete Stored RecipientsRecipients.DeleteDelete stored recipient records through endpoints that require the API scope.
Create Transaction RequestsTransactionRequests.CreateCreate and validate transaction requests.
View Transaction RequestsTransactionRequests.LookupRetrieve transaction requests and their statuses.
View TransactionsTransactions.LookupRetrieve and search transactions.
Vendor Management Approvervendor-management.approverApprove changes to vendors.
Vendor Management Managervendor-management.managerCreate and manage vendors.
Vendor Management Viewervendor-management.viewerView vendor details.
Webhooks Managerwebhooks.managerCreate and manage webhook subscriptions and view subscription events.
Webhooks Viewerwebhooks.viewerView webhook subscriptions and subscription events.
📘

All API requests require an access token containing the appropriate roles and OAuth scopes. For information about configuring identity clients, see Manage identity clients.