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

# Criar Cliente

> Cadastra um cliente para reutilizar em cobranças futuras.
Apenas `email` é obrigatório; demais campos são opcionais mas
recomendados para facilitar identificação e cobrança via PIX.

`taxId` (CPF ou CNPJ) é validado contra duplicatas no mesmo merchant.


Cadastra um novo cliente vinculado ao seu merchant.

<Card title="Obrigatório" horizontal>
  Apenas `email` é obrigatório. Inclua `name`, `taxId` e `phone` sempre
  que tiver — facilita relatórios e melhora a experiência no PIX.
</Card>

**Exemplo:**

```json theme={null}
{
  "email": "joao@exemplo.com",
  "name": "João Silva",
  "taxId": "12345678900",
  "phone": "+5511999999999"
}
```

<Tip title="Reuse o customerId" horizontal>
  Guarde o `data.id` retornado e passe como `customerId` em
  [`POST /transparents/create`](/pages/transparents/create) — o cliente é
  vinculado automaticamente à cobrança.
</Tip>

<Note>
  **`taxId` é único por merchant.** Se já existir um customer com o mesmo
  `taxId`, a API responde `409 CONFLICT` em vez de criar duplicidade.
</Note>


## OpenAPI

````yaml POST /customers
openapi: 3.1.0
info:
  title: API Liquerapay
  description: |
    API pública da Liquerapay para criar cobranças PIX, processar saques,
    gerenciar clientes e receber eventos via webhooks.

    ## Versão Beta

    A v1 está em **beta**. Endpoints e payloads podem sofrer pequenas
    alterações antes da versão estável (1.0). Recomendamos travar a versão
    da sua integração no `package.json` / `requirements.txt` enquanto
    estivermos em beta.

    Não há ambiente de sandbox — todas as chamadas acontecem contra o
    ambiente de produção.

    ## Como começar

    1. Crie sua conta em [app.liquerapay.com](https://app.liquerapay.com)
    2. Gere uma chave de API no painel (`liq_...`)
    3. Faça sua primeira chamada em `https://api.liquerapay.com`
  version: 1.0.0-beta
  contact:
    name: Suporte Liquerapay
    url: https://liquerapay.com
  license:
    name: Proprietary
servers:
  - url: https://api.liquerapay.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Cadastre e gerencie os clientes da sua loja para reutilizar em cobranças.
  - name: Checkout Transparente
    description: >-
      Crie cobranças PIX (QR Code copia-e-cola) direto pela API e gerencie
      devoluções.
  - name: Withdrawals
    description: Solicite saques do saldo disponível para uma chave PIX.
  - name: Webhooks
    description: Cadastre URLs para receber eventos da Liquerapay em tempo real.
paths:
  /customers:
    post:
      tags:
        - Customers
      summary: Criar cliente
      description: |
        Cadastra um cliente para reutilizar em cobranças futuras.
        Apenas `email` é obrigatório; demais campos são opcionais mas
        recomendados para facilitar identificação e cobrança via PIX.

        `taxId` (CPF ou CNPJ) é validado contra duplicatas no mesmo merchant.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomerRequest'
      responses:
        '201':
          description: Cliente criado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
components:
  schemas:
    CreateCustomerRequest:
      type: object
      required:
        - email
      additionalProperties: false
      properties:
        email:
          type: string
          format: email
          example: joao@exemplo.com
        name:
          type: string
          minLength: 1
          maxLength: 120
          example: João Silva
        taxId:
          type: string
          description: >-
            CPF (11 dígitos) ou CNPJ (14 dígitos) — apenas números aceitos na
            validação, mas você pode enviar formatado.
          example: '12345678900'
        phone:
          type: string
          maxLength: 20
          example: '+5511999999999'
    CustomerResponse:
      type: object
      required:
        - data
        - error
        - success
      properties:
        data:
          $ref: '#/components/schemas/Customer'
        error:
          type: 'null'
          example: null
        success:
          type: boolean
          enum:
            - true
          example: true
    Customer:
      type: object
      required:
        - id
        - email
        - createdAt
      properties:
        id:
          type: string
          example: cust_018f3a2b7c4d7c40a1b2
        name:
          type: string
          nullable: true
          example: João Silva
        email:
          type: string
          example: joao@exemplo.com
        taxId:
          type: string
          nullable: true
          description: CPF ou CNPJ, apenas dígitos — devolvido **sem máscara**.
          example: '12345678900'
        phone:
          type: string
          nullable: true
          example: '+5511999999999'
        createdAt:
          type: string
          format: date-time
          example: '2026-04-19T18:32:11.420Z'
        updatedAt:
          type: string
          format: date-time
          description: Presente apenas em `GET /customers/{id}`.
          example: '2026-04-19T18:32:11.420Z'
    Error:
      type: object
      required:
        - error
        - message
        - success
      properties:
        error:
          type: string
          description: >-
            Código do erro (ex.: `VALIDATION_ERROR`, `UNAUTHORIZED`,
            `NOT_FOUND`).
          example: VALIDATION_ERROR
        message:
          type: string
          description: Mensagem amigável descrevendo o erro.
          example: 'amount: deve ser um número inteiro positivo'
        success:
          type: boolean
          enum:
            - false
          example: false
  responses:
    BadRequest:
      description: Requisição inválida (validação ou regra de negócio).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            validation:
              summary: Erro de validação
              value:
                error: VALIDATION_ERROR
                message: 'amount: deve ser um número inteiro positivo'
                success: false
            business:
              summary: Erro de regra de negócio
              value:
                error: BAD_REQUEST
                message: >-
                  Saldo insuficiente. Disponível 4500 centavos, necessário 5050
                  centavos
                success: false
    Unauthorized:
      description: Falha de autenticação (token inválido, ausente ou revogado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: UNAUTHORIZED
            message: Token inválido ou ausente
            success: false
    Forbidden:
      description: Acesso negado para esta operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: FORBIDDEN
            message: Saques estão temporariamente bloqueados para este merchant
            success: false
    Conflict:
      description: Conflito (recurso duplicado).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: CONFLICT
            message: Customer com este taxId já existe
            success: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key ou JWT
      description: |
        Autentique suas requisições enviando o token no header
        `Authorization: Bearer <token>`.

        O token pode ser:

        - Uma **API key** com prefixo `liq_`, gerada em
          [Dashboard Liquerapay → Configurações → API Keys](https://app.liquerapay.com).
        - Um **JWT** retornado pelo login do dashboard (uso interno).

        Não há distinção de ambiente — toda chave vale para o único
        ambiente disponível (produção).

````