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 role | Role identifier | Description |
|---|---|---|
| View Accounts | Accounts.Lookup | Retrieve account details, balances and account entries. |
| Create Account Movements | AccountMovements.Create | Create, validate, approve and cancel account movements. |
| View Account Movements | AccountMovements.Lookup | List and retrieve account movements. |
| Approvals Manager | approvals.manager | Manage approval workflow tasks. |
| Create Cheque Voids | ChequeVoid.Create | Create requests to void cheques. |
| View Cheque Voids | ChequeVoid.Lookup | Retrieve cheque void requests and their statuses. |
| Create Deferred Transaction Groups | DeferredTransactionGroups.Create | Deprecated, do not use for new integrations. Create deferred transaction groups. |
| View Deferred Transaction Groups | DeferredTransactionGroups.Lookup | Deprecated, do not use for new integrations. Retrieve deferred transaction groups. |
| Create Deferred Transaction Requests | DeferredTransactionRequests.Create | Deprecated, do not use for new integrations. Create and validate deferred transaction request. |
| View Deferred Transaction Requests | DeferredTransactionRequests.Lookup | Deprecated, do not use for new integrations. Retrieve deferred transaction requests. |
| Create Forex Transactions | Forex.Create | Create foreign exchange rate groups. |
| View Forex Transactions | Forex.Lookup | Retrieve foreign exchange rate groups and indicative rates. |
| Payment Requests Approver | payment-requests.approver | Approve payments that require approval. |
| Payment Requests Manager | payment-requests.manager | Create and manage payments. |
| Payment Requests Viewer | payment-requests.viewer | View payments and their statuses. |
| Programmes Manager | programmes.manager | Create and manage programmes. |
| Programmes Viewer | programmes.viewer | View programme details. |
| View Rules | Rules.Lookup | Retrieve validation rules for a destination country, currency and payment route. |
| Stored Recipients Manager | stored-recipients.manager | Create, update and delete stored recipients through endpoints that require the stored-recipients scope. |
| Stored Recipients Viewer | stored-recipients.viewer | List and retrieve stored recipients through endpoints that require the stored-recipients scope. |
| Create Stored Recipients | Recipients.Create | Create stored recipient records through endpoints that require the API scope. |
| View Stored Recipients | Recipients.Lookup | List and retrieve stored recipient records through endpoints that require the API scope. |
| Update Stored Recipients | Recipients.Update | Update stored recipient records through endpoints that require the API scope. |
| Delete Stored Recipients | Recipients.Delete | Delete stored recipient records through endpoints that require the API scope. |
| Create Transaction Requests | TransactionRequests.Create | Create and validate transaction requests. |
| View Transaction Requests | TransactionRequests.Lookup | Retrieve transaction requests and their statuses. |
| View Transactions | Transactions.Lookup | Retrieve and search transactions. |
| Vendor Management Approver | vendor-management.approver | Approve changes to vendors. |
| Vendor Management Manager | vendor-management.manager | Create and manage vendors. |
| Vendor Management Viewer | vendor-management.viewer | View vendor details. |
| Webhooks Manager | webhooks.manager | Create and manage webhook subscriptions and view subscription events. |
| Webhooks Viewer | webhooks.viewer | View 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.
Updated about 2 months ago