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

# Criar cliente

> Crie e gerencie clientes para utilizar em cobranças, checkouts e pagamentos.

O identificador público do cliente é retornado em `data.id`.

Os campos `name` e `email` são obrigatórios. O e-mail deve ter um formato válido.


## OpenAPI

````yaml openapi.yaml POST /customers
openapi: 3.1.0
info:
  title: FortalPay API
  version: '1'
  description: >
    API para gerenciar clientes, produtos e cupons e para criar ou listar
    cobranças.

    A autenticação utiliza uma API key no cabeçalho `Authorization`.
servers:
  - url: https://api-sandbox.fortalpay.tech/v1
    description: Produção — API v1
security:
  - apiKeyAuth: []
tags:
  - name: Clientes
    description: Crie, filtre, consulte e remova clientes do lojista associado à API key.
  - name: Charges
    description: >-
      Create Pix charges and list charges owned by the merchant associated with
      the API key.
  - name: Checkouts
    description: Crie páginas de pagamento hospedadas pela FortalPay usando uma API key.
  - name: Produtos
    description: >-
      Crie, liste, consulte, atualize e remova produtos do lojista associado à
      API key.
  - name: Coupons
    description: >-
      Create, list, retrieve, update, and delete coupons owned by the merchant
      associated with the API key.
paths:
  /customers:
    post:
      tags:
        - Clientes
      summary: Criar cliente
      description: >-
        Cria um cliente para o lojista autenticado. Exige uma API key
        `FULL_ACCESS`.
      operationId: createCustomer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
            example:
              name: Maria Silva
              email: maria@example.com
              document: 529.982.247-25
              phone: (85) 99999-9999
      responses:
        '200':
          description: >-
            Cliente criado ou cliente existente com o mesmo documento retornado
            com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedCustomerEnvelope'
              example:
                data:
                  id: 6f84d2b5-a612-4e67-8af5-69f98de980f5
                  name: Maria Silva
                  email: maria@example.com
                  document: '***.***.***-25'
                  phone: '85999999999'
                  status: ACTIVE
                  createdAt: '2026-08-02T10:30:00-03:00'
                  updatedAt: '2026-08-02T10:30:00-03:00'
                success: true
                error: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    CreateCustomerRequest:
      type: object
      required:
        - name
        - email
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 150
        email:
          type: string
          format: email
          minLength: 1
          maxLength: 150
        document:
          type:
            - string
            - 'null'
          maxLength: 20
          description: >-
            CPF ou CNPJ. Os caracteres de formatação são removidos antes do
            armazenamento.
        phone:
          type:
            - string
            - 'null'
          maxLength: 20
          description: >-
            Telefone. Os caracteres de formatação são removidos antes do
            armazenamento.
    CreatedCustomerEnvelope:
      type: object
      required:
        - data
        - success
        - error
      properties:
        data:
          $ref: '#/components/schemas/CreatedCustomer'
        success:
          type: boolean
          const: true
        error:
          type: 'null'
    CreatedCustomer:
      type: object
      required:
        - id
        - name
        - status
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type:
            - string
            - 'null'
        document:
          type:
            - string
            - 'null'
          description: CPF ou CNPJ mascarado, preservando somente os dois últimos dígitos.
          example: '***.***.***-25'
        phone:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/CustomerStatus'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      required:
        - data
        - success
        - error
      properties:
        data:
          type: 'null'
        success:
          type: boolean
          const: false
        error:
          $ref: '#/components/schemas/ApiError'
    CustomerStatus:
      type: string
      enum:
        - ACTIVE
    ApiError:
      type: object
      required:
        - timestamp
        - status
        - message
        - path
      properties:
        timestamp:
          type: string
          format: date-time
        status:
          type: integer
        message:
          type: string
          description: Current backend messages are returned in Portuguese.
        path:
          type: string
        fields:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/FieldError'
    FieldError:
      type: object
      required:
        - field
        - message
      properties:
        field:
          type: string
        message:
          type: string
  responses:
    BadRequest:
      description: Uma regra de negócio rejeitou a requisição ou o estado atual do recurso.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: >-
        A API key está ausente, malformada, não existe, foi revogada, expirou ou
        é incompatível com o ambiente do lojista.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >-
        A API key foi autenticada, mas não possui permissão para acessar a rota
        solicitada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ValidationError:
      description: Um ou mais campos da requisição são inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Todas as requisições devem incluir sua API key no cabeçalho
        `Authorization`

        usando o formato `ApiKey <sua_api_key>`. Não use o esquema `Bearer`.

        Sem esse cabeçalho, a requisição será rejeitada.


        Use `fpay_sk_test_...` no ambiente de teste e `fpay_sk_live_...` em
        produção.

        [Saiba como criar e usar uma API key](/authentication).

````