> ## 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.

# Quick Start

> From empty account to verified user, subscribed plan, and first message — without opening the dashboard.

<Tip>
  This guide takes you from **empty account to first send**. All via API: register, OTP, card, plan, and message.
</Tip>

## In short

1. **Register** with onboarding survey (fixed enum fields)
2. **Verify** phone with OTP → receive `apiKey` (save it now)
3. **Optional:** add card and subscribe to a plan
4. **Send** a message with the API key on a channel

Onboarding enums: [Registration and verification](/en/platform-api/como-funciona/registro-e-verificacao#survey-de-onboarding).

## 1. Register account

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@company.com",
    "password": "SecurePass123!",
    "name": "Maria Dev",
    "phone": "5511999999999",
    "onboardingSurvey": {
      "rolePersona": "developer",
      "primaryGoal": "api",
      "plannedChannels": ["whatsapp", "email", "sms"]
    }
  }'
```

Response: `verificationToken`, `deliveryChannel` (whatsapp or sms), `expiresAt`, `retryAfter`.

## 2. Verify phone

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/verify \
  -H "Content-Type: application/json" \
  -d '{
    "verificationToken": "<token from step 1>",
    "code": "123456"
  }'
```

Response: `apiKey`, `workspaceId`, `user`. **Save the `apiKey`** — it is not shown again.

## 3. (Optional) Add card and subscribe

```bash theme={null}
curl https://api.notifique.dev/v1/platform/workspaces/WORKSPACE_ID/subscription \
  -H "Authorization: Bearer sk_live_..."

curl -X POST https://api.notifique.dev/v1/platform/workspaces/WORKSPACE_ID/subscription \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "tierIndex": 1,
    "billingType": "CREDIT_CARD",
    "cpfCnpj": "12345678901",
    "mobilePhone": "5511999999999",
    "paymentMethodId": "pm_xxx"
  }'
```

Card, PIX, and recharge details: [Billing](/en/platform-api/como-funciona/billing).

## 4. Send first message

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/email/messages \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "to": ["client@email.com"], "subject": "Hello", "text": "Platform API test" }'
```

## Login to existing account

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@company.com",
    "password": "SecurePass123!",
    "createApiKey": true
  }'
```

With **2FA**: first login returns `requiresSecondFactor` + `verificationToken`; call **login again** with that token + `totpCode` (not `verify`). See [Registration and verification](/en/platform-api/como-funciona/registro-e-verificacao).

## Second workspace

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/workspaces \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Staging", "color": "#3B82F6"}'
```

Then login with that workspace's `workspaceId` to get an API key for it.

## Next steps

* [Webhooks](/en/platform-api/como-funciona/webhooks): receive events on your server
* [Workspaces](/en/platform-api/como-funciona/workspaces): organize instances and team
* [Scopes](/en/platform-api/como-funciona/escopos-api-key): restrict the key for production