Scopes
The permissions you can grant an integration.
Grant each integration only the scopes it needs. Request them when you get a token, as a space-separated list. Each endpoint in the API reference names the scope it needs.
| Scope | Allows |
|---|---|
account:read | Read the account and its owner. |
kyc:read | Read identifications, brands and bank accounts. |
kyc:write | Create, update and delete identifications, brands and bank accounts. |
instances:read | Read payment instances. |
instances:write | Request activation of, update and delete payment instances. |
links:read | Read payment links. |
links:write | Create, update, publish, pause, resume and archive payment links. |
plans:read | Read payment plans. |
plans:write | Create, cancel and send reminders for payment plans, and preview schedules. |
forms:read | Read forms. |
forms:write | Create, update, publish and delete forms. |
webhooks:read | Read webhooks and their deliveries. |
webhooks:write | Create, update and delete webhooks, rotate their secrets, redeliver events. |
A write scope doesn't include its read scope. A program that creates and then reads links needs both
links:write and links:read.
Postman collection