kawaa-com · OAuth Scopes

kawaa-com OAuth Scopes

OAuth 2.0 derived

kawaa-com publishes 21 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the kawaa-com API on a user’s behalf.

Tokens are issued from https://api.kawaa.com/oauth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanyEmail VerificationSoftware-as-a-ServiceMarketing
Scopes: 21 Flows: authorizationCode Method: derived

OAuth endpoints

Authorization URL
https://api.kawaa.com/oauth/authorize
Token URL
https://api.kawaa.com/oauth/token
Flows
authorizationCode

Scopes (21)

ScopeDescriptionFlows
account:read Read the account profile, credit balance and notifications. authorizationCode
analytics:read Read usage, analytics and tracking figures. authorizationCode
analytics:write Create, change and permanently delete tracking pixels and links, and record usage-analytics events for this account. Deleting a pixel or link breaks the tracking already embedded in sent mail. Credit alert thresholds are fixed, so no scope changes them. authorizationCode
billing:read Read the subscription, invoices, payment methods and billing address. authorizationCode
compose:read Read AI composition history. authorizationCode
compose:write Generate and improve email copy with AI. Spends credits. authorizationCode
deliverability:read Read deliverability checks, blacklist and DMARC monitors, and inbox-placement and warmup state. Email warmup and inbox placement tests are not available yet. authorizationCode
deliverability:write Run deliverability checks and manage blacklist and DMARC monitors. Email warmup and inbox placement tests are not available yet; warmup campaigns and SMTP credentials already set up can still be removed. authorizationCode
exports:read Read exports, export schedules and data-sharing settings. Downloading an export also needs the scope that reads the data in it. Data sharing is not available yet. authorizationCode
exports:write Create and delete exports, manage export schedules and delivery destinations, and change export settings. Exported files contain customer addresses, so each kind of data also needs the scope that reads it: verification:read, account:read or security:read. Scheduled exports deliver by email, webhook or Amazon S3; Google Cloud Storage and Azure Blob Storage delivery is not available yet. authorizationCode
integrations:read Read connected integrations and their status. authorizationCode
integrations:write Connect and disconnect integrations, and push verification into them. The HubSpot, Salesforce and Mailchimp connections are not available yet. authorizationCode
lists:read Read auto-clean lists and their run history. authorizationCode
lists:write Create, change, pause and delete auto-clean lists, and start rechecks. Each rechecked address spends one credit. Creating, reactivating and starting rechecks require Professional or above and account execution availability. authorizationCode
security:read Read security settings, sessions, login history and the audit log. authorizationCode
team:read Read the team, its members and its invitations. authorizationCode
verification:read Read verification results and jobs this account has already paid for. Spends nothing. authorizationCode
verification:write Anything that spends verification credits: verifying an address, a batch or a file, finding a business email, and the domain and address-history lookups, which are charged too. authorizationCode
webhooks:read Read webhook endpoints and their delivery logs. authorizationCode
webhooks:write Create, change and delete webhook endpoints, and rotate their signing secrets. authorizationCode
white_label:read Read white-label configuration, sub-accounts and the custom API domain. authorizationCode

Source

OAuth Scopes

Raw ↑
generated: '2026-10-31'
method: derived
source: openapi/kawaa-com-openapi.json
schemes:
- name: OAuth2
  source: openapi/kawaa-com-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.kawaa.com/oauth/authorize
    tokenUrl: https://api.kawaa.com/oauth/token
  description: |-
    OAuth 2.1 sign-in, for an app or agent that acts for a person who approves it on a Kawaa consent screen, instead of being handed an API key. The access token is sent as `Authorization: Bearer <token>`, the same header as `BearerToken`, and is checked exactly like a scoped API key: scopes, rate limits and credits apply unchanged.

    - **Discovery.** Authorization server metadata (RFC 8414): `https://api.kawaa.com/.well-known/oauth-authorization-server`. Protected resource metadata (RFC 9728): `https://api.kawaa.com/.well-known/oauth-protected-resource` for this API and `https://api.kawaa.com/.well-known/oauth-protected-resource/mcp` for the MCP server.
    - **Client.** Use the https URL of a Client ID Metadata Document, on the default port, as `client_id` (public clients only), or register at `https://api.kawaa.com/oauth/register` (RFC 7591; no credential needed). Registration follows the RFC defaults when a field is omitted: `token_endpoint_auth_method` `client_secret_basic` (a secret is issued) and `grant_types` `authorization_code` alone. Send `none` for a public client, and include `refresh_token` in `grant_types` to be issued refresh tokens. A redirect URI is https, loopback http (any port), or an app's own scheme: a reversed domain name (RFC 8252 §7.1, `com.example.app:/callback`) or one of `cursor`, `vscode`, `vscode-insiders`, `claude` and `windsurf`. Browser and operating-system handler schemes are refused (`invalid_redirect_uri`).
    - **PKCE.** Required on every authorization request, with `code_challenge_method=S256`; no other method is accepted. The only grants are `authorization_code` and `refresh_token`.
    - **Resource.** Send `resource=https://api.kawaa.com` for this API (RFC 8707). Without it the token is issued for the MCP server, `https://api.kawaa.com/mcp`; any other value is refused with `invalid_target`.
    - **Scopes.** With no `scope` parameter the request is for `verification:write verification:read account:read analytics:read`. Scopes Kawaa does not define, and scopes a connected app can never hold, are dropped rather than refused; if none remain the request is refused with `invalid_scope`. An authorization request refused before the person answers it (`invalid_request`, `unsupported_response_type`, `invalid_target`, `invalid_scope`) is shown to them on a Kawaa error page carrying that code, and is not sent to the redirect URI (RFC 9700 §4.11.2); only their answer is, the code or `access_denied`, with `state` and `iss`. The person approving can untick any scope, and the token response's `scope` states what was granted. `account:write`, `account:delete`, `billing:write`, `team:write`, `security:write` and `white_label:write` are never granted, so the operations that need them do not list this scheme, and neither do those marked `x-kawaa-unscoped-only`. As for API keys, `<area>:write` also satisfies `<area>:read`.
    - **Tokens.** An access token is `evo_` followed by 40 alphanumeric characters and lasts one hour (`expires_in: 3600`); after that the API answers 401 `OAUTH_TOKEN_EXPIRED`. A refresh token is `evr_` followed by 48 alphanumeric characters and is never accepted as a bearer credential. Every refresh returns a new refresh token and retires the one presented. The one just used may be presented up to 5 more times within 60 seconds of its use (a lost response, or several refreshes sent at once) and gets a new one of its own each time; the first of those to be used retires the rest. Presenting it again after that, or presenting any older refresh token, is treated as theft and ends the connection: its refresh tokens and every live access token stop working. A refresh may ask for fewer scopes than the connection holds, never more. A connection that is not refreshed for 30 days ends. Revoke at `https://api.kawaa.com/oauth/revoke` (RFC 7009).
scopes:
- scope: account:read
  description: Read the account profile, credit balance and notifications.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: analytics:read
  description: Read usage, analytics and tracking figures.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: analytics:write
  description: Create, change and permanently delete tracking pixels and links, and record usage-analytics
    events for this account. Deleting a pixel or link breaks the tracking already embedded in
    sent mail. Credit alert thresholds are fixed, so no scope changes them.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: billing:read
  description: Read the subscription, invoices, payment methods and billing address.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: compose:read
  description: Read AI composition history.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: compose:write
  description: Generate and improve email copy with AI. Spends credits.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: deliverability:read
  description: Read deliverability checks, blacklist and DMARC monitors, and inbox-placement
    and warmup state. Email warmup and inbox placement tests are not available yet.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: deliverability:write
  description: Run deliverability checks and manage blacklist and DMARC monitors. Email warmup
    and inbox placement tests are not available yet; warmup campaigns and SMTP credentials already
    set up can still be removed.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: exports:read
  description: Read exports, export schedules and data-sharing settings. Downloading an export
    also needs the scope that reads the data in it. Data sharing is not available yet.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: exports:write
  description: 'Create and delete exports, manage export schedules and delivery destinations,
    and change export settings. Exported files contain customer addresses, so each kind of data
    also needs the scope that reads it: verification:read, account:read or security:read. Scheduled
    exports deliver by email, webhook or Amazon S3; Google Cloud Storage and Azure Blob Storage
    delivery is not available yet.'
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: integrations:read
  description: Read connected integrations and their status.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: integrations:write
  description: Connect and disconnect integrations, and push verification into them. The HubSpot,
    Salesforce and Mailchimp connections are not available yet.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: lists:read
  description: Read auto-clean lists and their run history.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: lists:write
  description: Create, change, pause and delete auto-clean lists, and start rechecks. Each rechecked
    address spends one credit. Creating, reactivating and starting rechecks require Professional
    or above and account execution availability.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: security:read
  description: Read security settings, sessions, login history and the audit log.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: team:read
  description: Read the team, its members and its invitations.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: verification:read
  description: Read verification results and jobs this account has already paid for. Spends
    nothing.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: verification:write
  description: 'Anything that spends verification credits: verifying an address, a batch or
    a file, finding a business email, and the domain and address-history lookups, which are
    charged too.'
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: webhooks:read
  description: Read webhook endpoints and their delivery logs.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: webhooks:write
  description: Create, change and delete webhook endpoints, and rotate their signing secrets.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json
- scope: white_label:read
  description: Read white-label configuration, sub-accounts and the custom API domain.
  flows:
  - authorizationCode
  sources:
  - openapi/kawaa-com-openapi.json

Work with this as data

Every scope set here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for oauth scopes

4 MCP tools reach this
  • find_scopesBrowse and filter every scope set in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This scope set
curl "https://apis.io/api/v1/scopes/kawaa-com-scopes"
All oauth scopes
curl "https://apis.io/api/v1/scopes?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.