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

# Registrar conta

> Cria usuário e envia OTP por WhatsApp ou SMS. Retorna `verificationToken` (JWT ~15 min, purpose `onboarding`) para `POST /v1/platform/verify`. O **primeiro workspace** é criado na verificação, não neste passo.



## OpenAPI

````yaml /es/platform-api/api-reference/openapi-platform.json post /v1/platform/register
openapi: 3.0.3
info:
  title: Notifique API Platform
  description: >-
    Conta, billing, API keys, equipe e tudo que o painel faz — via API. Rotas
    públicas: `register`, `verify`, `login`. Autentique o restante com
    `Authorization: Bearer sk_live_...` ou `x-api-key`. Escopos: `api_keys:*`,
    `billing:*`, `workspace:members:*` conforme a rota.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfPlatformBearerAuth: []
  - ntfPlatformApiKeyHeader: []
tags:
  - name: 'Platform: Conta'
    description: Registro, verificação de telefone e login.
  - name: 'Platform: Billing'
    description: >-
      Assinatura, saldo, recarga e histórico de uso de créditos (`billing:read`
      / `billing:manage`).
  - name: 'Platform: API Keys'
    description: Gestão de chaves do workspace (`api_keys:read` / `api_keys:manage`).
  - name: 'Platform: Workspace'
    description: Listagem de workspaces (sessão) e recursos por workspace.
  - name: 'Platform: Equipe'
    description: >-
      Membros e convites (`workspace:members:read` /
      `workspace:members:manage`).
  - name: Sandbox
    description: Mensajes de prueba interceptados en el entorno sandbox.
paths:
  /v1/platform/register:
    post:
      tags:
        - 'Platform: Conta'
      summary: Registrar conta
      description: >-
        Cria usuário e envia OTP por WhatsApp ou SMS. Retorna
        `verificationToken` (JWT ~15 min, purpose `onboarding`) para `POST
        /v1/platform/verify`. O **primeiro workspace** é criado na verificação,
        não neste passo.
      operationId: ntfPlatform_postRegister
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfPlatform_RegisterBody'
            examples:
              developer:
                summary: Dev integrando API
                value:
                  email: dev@empresa.com
                  password: SenhaSegura123!
                  name: Maria Dev
                  phone: '5511999999999'
                  onboardingSurvey:
                    rolePersona: developer
                    primaryGoal: api
                    plannedChannels:
                      - whatsapp
                      - email
                      - sms
      responses:
        '200':
          description: OTP enviado; use `verificationToken` em verify.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPlatform_RegisterResponse'
              example:
                success: true
                data:
                  verificationToken: eyJhbGciOiJIUzI1NiIs...
                  message: Código enviado por WhatsApp
                  deliveryChannel: whatsapp
                  expiresAt: '2026-08-14T23:45:00.000Z'
                  retryAfter: 0
        '400':
          $ref: '#/components/responses/NtfPlatform_BadRequest'
        '409':
          description: E-mail ou telefone já cadastrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPlatform_Error'
              example:
                success: false
                error: E-mail já em uso
                code: EMAIL_ALREADY_EXISTS
        '429':
          $ref: '#/components/responses/NtfPlatform_RateLimit'
      security: []
components:
  schemas:
    NtfPlatform_RegisterBody:
      type: object
      required:
        - email
        - password
        - phone
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          minLength: 10
        name:
          type: string
        phone:
          type: string
          example: '5511999999999'
        onboardingSurvey:
          type: object
          properties:
            rolePersona:
              type: string
              enum:
                - developer
                - company
                - store
                - marketing
                - autonomous
                - other
            primaryGoal:
              type: string
            plannedChannels:
              type: array
              items:
                type: string
              minItems: 1
              maxItems: 11
        referralCode:
          type: string
      example:
        email: cliente@example.com
        password: string
        phone: '5511999999999'
        name: Exemplo
        onboardingSurvey:
          rolePersona: developer
          primaryGoal: string
          plannedChannels:
            - string
        referralCode: string
    NtfPlatform_RegisterResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            verificationToken:
              type: string
            message:
              type: string
            retryAfter:
              type: integer
            deliveryChannel:
              type: string
              example: whatsapp
            expiresAt:
              type: string
              example: '2026-08-14T23:45:00.000Z'
      example:
        success: true
        data:
          verificationToken: string
          message: string
          retryAfter: 1
    NtfPlatform_Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        code:
          type: string
        message:
          type: string
          example: Campo inválido ou ausente.
        retryAfter:
          type: integer
          example: 60
      example:
        success: false
        error: string
        code: string
  responses:
    NtfPlatform_BadRequest:
      description: Corpo inválido, enum incorreto ou campo inesperado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          examples:
            invalid_enum:
              value:
                success: false
                error: plannedChannels[0] inválido
                code: VALIDATION_ERROR
            unexpected_fields:
              value:
                success: false
                code: UNEXPECTED_FIELDS
    NtfPlatform_RateLimit:
      description: Limite de tentativas ou cooldown de OTP.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          example:
            success: false
            code: OTP_RATE_LIMIT
            retryAfter: 60
  securitySchemes:
    ntfPlatformBearerAuth:
      type: http
      scheme: bearer
      description: API key (`sk_live_...`) ou `sessionToken` de login.
    ntfPlatformApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternativa ao Bearer.

````