> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Create an account, subscribe, add cards, and manage the workspace via API — everything the dashboard does, without opening it.

<Tip>
  Platform API is the **remote control for the dashboard**: account, billing, workspace, webhooks, and logs — ideal for AI agents and automated provisioning.
</Tip>

## What is Platform at Notifique?

It's the API to **operate the account and workspace** without a UI. An AI agent or script can:

* **Create an account** and confirm phone via OTP
* **Log in** and get an API key or session
* **Subscribe**, **cancel**, **upgrade**, and **recharge balance**
* **Add and list credit cards**
* **Create API keys** with restricted scopes
* **Manage workspaces** (name, defaults, inbound)
* **Configure webhooks** and inspect deliveries
* **Audit calls** via API logs
* **Connect third-party apps** with OAuth 2.1

Think of the web dashboard as the bank app on your phone; Platform API is the **same bank**, over HTTP.

<Note>
  Sending messages (WhatsApp, SMS, email…) uses **channel APIs** with the `apiKey` you get here. Platform handles the **account**; channels handle **messaging**.
</Note>

## Credentials in the flow

| Step                           | Credential                                                  | Use                                    |
| ------------------------------ | ----------------------------------------------------------- | -------------------------------------- |
| After `register`               | `verificationToken` (onboarding)                            | `POST /v1/platform/verify` + phone OTP |
| After `login` with pending 2FA | `verificationToken` (login\_2fa)                            | `POST /v1/platform/login` + `totpCode` |
| After `verify` (registration)  | `apiKey` + `workspaceId`                                    | Full API v1                            |
| Login without 2FA              | `sessionToken` (+ optional new `apiKey` with `workspaceId`) | Billing, `GET /v1/platform/me`         |

Details: [Registration and verification](/en/platform-api/como-funciona/registro-e-verificacao).

```http theme={null}
Authorization: Bearer sk_live_xxxxx
```

Alternative: `x-api-key: sk_live_xxxxx`.

## What you can do (quick map)

| Area       | Main routes                                                                | Guide                                                                                  |
| ---------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| Account    | `/v1/platform/register`, `/verify`, `/login`                               | [Registration and verification](/en/platform-api/como-funciona/registro-e-verificacao) |
| Billing    | `/v1/platform/workspaces/:id/subscription`, `/balance`, `/payment-methods` | [Billing](/en/platform-api/como-funciona/billing)                                      |
| API keys   | `/v1/platform/api-keys`                                                    | [Scopes](/en/platform-api/como-funciona/escopos-api-key)                               |
| Workspaces | `/v1/workspaces`                                                           | [Workspaces](/en/platform-api/como-funciona/workspaces)                                |
| Webhooks   | `/v1/webhooks`, `/v1/webhooks/deliveries`                                  | [Webhooks](/en/platform-api/como-funciona/webhooks)                                    |
| Logs       | `/v1/logs`                                                                 | [Logs](/en/platform-api/como-funciona/logs)                                            |
| OAuth      | `/oauth/*`, `/.well-known/*`                                               | [OAuth](/en/platform-api/como-funciona/oauth)                                          |

## Typical flow (AI agent)

1. `POST /v1/platform/register` — data + onboarding survey (validated enums)
2. `POST /v1/platform/verify` — OTP code → `apiKey` + `workspaceId`
3. `POST /v1/platform/workspaces/:id/payment-methods` — tokenize card
4. `POST /v1/platform/workspaces/:id/subscription` — subscribe to Basic/Pro/Business
5. `POST /v1/whatsapp/messages` (or another channel) with the API key

## Next steps

* [Quick Start](/en/platform-api/como-funciona/quick-start): from zero to first message
* [Registration and verification](/en/platform-api/como-funciona/registro-e-verificacao): onboarding enums and OTP errors
* [Billing](/en/platform-api/como-funciona/billing): plan, balance, and cards
* [API Key scopes](/en/platform-api/como-funciona/escopos-api-key): permissions for integration