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

# Verificar telefone

> Confirma o **OTP de telefone** enviado após `POST /register`. Envie o `verificationToken` retornado no register e o `code` de 6 dígitos (WhatsApp/SMS). Cria o **primeiro workspace** e devolve `apiKey` (**uma vez**), `workspaceId` e `user`. **Não** use esta rota para 2FA — TOTP do autenticador vai em `POST /login`.



## OpenAPI

````yaml /es/platform-api/api-reference/openapi-platform.json post /v1/platform/verify
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/verify:
    post:
      tags:
        - 'Platform: Conta'
      summary: Verificar telefone
      description: >-
        Confirma o **OTP de telefone** enviado após `POST /register`. Envie o
        `verificationToken` retornado no register e o `code` de 6 dígitos
        (WhatsApp/SMS). Cria o **primeiro workspace** e devolve `apiKey` (**uma
        vez**), `workspaceId` e `user`. **Não** use esta rota para 2FA — TOTP do
        autenticador vai em `POST /login`.
      operationId: ntfPlatform_postVerify
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NtfPlatform_VerifyBody'
            example:
              verificationToken: eyJhbGciOiJIUzI1NiIs...
              code: '123456'
      responses:
        '200':
          description: Verificação bem-sucedida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPlatform_VerifyResponse'
              example:
                success: true
                data:
                  apiKey: sk_live_abc123...
                  workspaceId: clws_01HXYZ...
                  user:
                    id: clus_01HABC...
                    email: dev@empresa.com
                    name: Maria Dev
                    phone: '5511999999999'
                    phoneVerified: true
                    onboardingCompleted: true
        '400':
          description: OTP incorreto ou expirado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPlatform_OtpError'
              examples:
                invalid:
                  value:
                    success: false
                    error: Código incorreto
                    code: OTP_INVALID
                    attemptsRemaining: 2
                expired:
                  value:
                    success: false
                    error: Código expirado
                    code: OTP_INVALID_OR_EXPIRED
        '401':
          $ref: '#/components/responses/NtfPlatform_Unauthorized'
        '429':
          $ref: '#/components/responses/NtfPlatform_RateLimit'
      security: []
components:
  schemas:
    NtfPlatform_VerifyBody:
      type: object
      required:
        - verificationToken
        - code
      properties:
        verificationToken:
          type: string
        code:
          type: string
          example: '123456'
      example:
        verificationToken: string
        code: '123456'
    NtfPlatform_VerifyResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            apiKey:
              type: string
            workspaceId:
              type: string
            user:
              $ref: '#/components/schemas/NtfPlatform_User'
      example:
        success: true
        data:
          apiKey: string
          workspaceId: clxx...
          user:
            id: clxx...
            email: string
            name: Exemplo
            phone: string
            phoneVerified: true
            onboardingCompleted: true
    NtfPlatform_OtpError:
      allOf:
        - $ref: '#/components/schemas/NtfPlatform_Error'
        - type: object
          properties:
            attemptsRemaining:
              type: integer
    NtfPlatform_User:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        phoneVerified:
          type: boolean
        onboardingCompleted:
          type: boolean
        workspaces:
          type: array
          items:
            type: string
          example:
            - role: OWNER
              id: clws_01HProducao...
              name: Produção BR
              slug: producao-br
            - role: OWNER
              id: clws_02HHomolog...
              name: Homologação
              slug: homologacao
      example:
        id: clxx...
        email: string
        name: Exemplo
        phone: string
        phoneVerified: true
        onboardingCompleted: true
    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_Unauthorized:
      description: Credenciais ou token inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          example:
            success: false
            code: VERIFICATION_TOKEN_INVALID
    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.

````