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

# Cadastrar usuário

> Cria um usuário do gateway. A senha é armazenada com hash bcrypt.



## OpenAPI

````yaml /openapi.yaml post /auth/register
openapi: 3.1.0
info:
  title: V4Pay API
  version: 2.0.0
  description: >
    API do gateway de pagamentos V4Pay: autenticação, clientes, cobranças,
    cupons e emissão de Pix — cada lojista tem uma conta de recebimento no CNPJ
    dele, e a cobrança leva um split com a taxa do V4 Pay. Todas as rotas
    protegidas usam token JWT — o usuário é identificado pelo token, nunca por
    `user_id` no corpo da requisição.
servers:
  - url: https://v4pay-api.vercel.app
    description: Produção.
  - url: http://localhost:3000
    description: Ambiente local de desenvolvimento.
security: []
tags:
  - name: Pix
    description: Emitir e consultar cobranças Pix — o coração da API.
  - name: Cobranças
    description: Registro direto de cobranças e a listagem do histórico da loja.
  - name: Clientes
    description: Cadastro de pagadores para reutilizar nas cobranças.
  - name: Links de pagamento
    description: URLs públicas reutilizáveis que abrem o checkout com o valor definido.
  - name: Checkout (público)
    description: >-
      As rotas que a página de pagamento usa — sem autenticação, o pagador não
      tem conta.
  - name: Produtos
    description: Catálogo da loja; um produto pode virar cobrança ou link.
  - name: Cupons
    description: Descontos aplicados no checkout e na emissão por produto.
  - name: Assinaturas
    description: Cobrança recorrente, gerada por um cron diário.
  - name: Webhooks (endpoints)
    description: >-
      As URLs do seu servidor que recebem os eventos da loja, com assinatura
      HMAC.
  - name: Chaves de API
    description: Credenciais de integração (v4pay_test_ / v4pay_live_), revogáveis.
  - name: Conta de recebimento
    description: Cadastro da empresa e a conta que recebe — vale no modo subconta.
  - name: Aprovação de produção
    description: >-
      O fluxo para liberar a operação em produção — dados da empresa, documentos
      e análise da equipe.
  - name: Saques
    description: >-
      Pedidos de saque do saldo — suspensos no modo conta única
      (REPASSE_MANUAL).
  - name: Membros da loja
    description: Convites e papéis de quem opera a loja junto com o dono.
  - name: Conta (auth)
    description: Cadastro, login, perfil e a troca de ambiente da sessão.
  - name: Auditoria
    description: Trilha das ações feitas na loja, com quem fez e de onde.
  - name: Sistema
    description: Saúde da API.
  - name: Interno
    description: >-
      USO INTERNO DO PAINEL — documentado por transparência, não para
      integração: pode mudar sem aviso (Roadmap, aprovações da equipe, cron,
      login com Google, onboarding).
paths:
  /auth/register:
    post:
      tags:
        - Conta (auth)
      summary: Cadastrar usuário
      description: Cria um usuário do gateway. A senha é armazenada com hash bcrypt.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - email
                - password
              properties:
                name:
                  type: string
                  example: Maria Oliveira
                email:
                  type: string
                  format: email
                  example: maria@empresa.com.br
                password:
                  type: string
                  format: password
                  minLength: 8
                  example: senhaForte123
                cnpj:
                  type: string
                  description: CNPJ da loja (opcional; somente números ou formatado).
                  example: '12345678000195'
      responses:
        '201':
          description: Usuário criado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          description: E-mail já cadastrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AuthResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            user:
              $ref: '#/components/schemas/User'
            accessToken:
              type: string
              description: Token JWT com validade de 1 hora.
              example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Descrição da mensagem de erro.
    User:
      type: object
      properties:
        is_admin:
          type: boolean
          description: >-
            true para a equipe do V4 Pay (lista no servidor) — libera a edição
            do Roadmap no painel. Derivado a cada resposta, não gravado.
        production_status:
          type:
            - string
            - 'null'
          enum:
            - sandbox
            - pending
            - approved
            - rejected
            - null
          description: >
            Situação da aprovação interna de produção. `sandbox` = só opera em
            teste (estado de todo lojista novo); `pending` = cadastro em
            análise; `approved` = produção liberada; `rejected` = recusado (ver
            `production_reject_reason`). `null`/ausente vale como `sandbox`.
        production_requested_at:
          type:
            - string
            - 'null'
          format: date-time
        production_reviewed_at:
          type:
            - string
            - 'null'
          format: date-time
        production_reject_reason:
          type:
            - string
            - 'null'
          description: Motivo da recusa, escrito pela equipe. Só preenchido em `rejected`.
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Nome pessoal do usuário.
          example: Maria Oliveira
        email:
          type: string
          format: email
          example: maria@empresa.com.br
        cnpj:
          type:
            - string
            - 'null'
          description: CNPJ da loja (somente números).
          example: '12345678000195'
        company:
          type:
            - string
            - 'null'
          description: Nome da loja exibido no painel.
          example: Enriquece AI
        cpf:
          type:
            - string
            - 'null'
          description: CPF do usuário (somente números).
          example: '52998224725'
        phone:
          type:
            - string
            - 'null'
          description: Telefone com DDD (somente números).
          example: '11954958486'
        notify_payment_email:
          type: boolean
          description: Receber e-mail a cada pagamento recebido.
        receipt_email:
          type: boolean
          description: Enviar comprovante por e-mail ao cliente após a compra.
        created_at:
          type: string
          format: date-time
  responses:
    BadRequest:
      description: Erro de validação nos dados enviados.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'

````