---
title: "Cadastra um novo cliente."
method: POST
path: "/v1/customers"
tags: ["customers"]
---

# Cadastra um novo cliente.

`POST /v1/customers`

Utilize esta função para criar novos clientes na plataforma. Cliente é uma das entidades básicas do sistema. Ele representa a pessoa física ou jurídica que possui uma ou mais assinaturas.

#### Código da API

Quando utilizado, o campo `code` deve ser único em todo escopo da empresa. Recomendamos o uso de um código auto-incrementável do seu próprio banco de dados. Desaconselhamos a utilização de qualquer dado que seja informado pelo cliente, como e-mail ou número do documento.

## Request body

- PostV1Customers — Cadastra um novo cliente.
  - `body` string — JSON com atributos do novo cliente.
  - `name` string, required — Nome do cliente
  - `email` string — E-mail do cliente
  - `registry_code` string — CPF ou CNPJ do cliente
  - `code` string — Código opcional para referência via API
  - `notes` string — Observações adicionais internas sobre o cliente
  - `metadata` 'array' — Metadados do cliente
  - `address` AddressParameters
    - `street` string, required — Endereço (rua, avenida etc)
    - `number` string, required — Número do endereço
    - `additional_details` string — Complemento do endereço
    - `zipcode` string, required — CEP
    - `neighborhood` string, required — Bairro
    - `city` string, required — Cidade
    - `state` string, required — Estado
    - `country` string, required — Código do país no formato ISO 3166-1 alpha-2. Exemplo: BR
  - `phones` PhoneParametersCreate[] — Lista de números de telefone do cliente
    - `phone_type` 'mobile' | 'landline', required — Tipo
    - `number` string, required — Número de telefone no formato E.164 incluindo código do país e código de área. Exemplo: 5511975416666
    - `extension` string — Ramal com até 6 dígitos

## Response `201`

Cliente cadastrado com sucesso.

- Customer — Utilize este método para listar os clientes associados à sua conta na Vindi. Leia a documentação sobre [paginação](http://atendimento.vindi.com.br/hc/pt-br/articles/203020644#pagination) e [filtros de busca](http://atendimento.vindi.com.br/hc/pt-br/articles/204163150). #### Atributos para busca <code>id</code>, <code>name</code>, <code>status</code>, <code>code</code>, <code>email</code>, <code>registry_code</code>, <code>created_at</code> e <code>updated_at</code>.
  - `id` integer, required — ID do cliente
  - `name` string, required — Nome do cliente
  - `email` string — E-mail do cliente
  - `registry_code` string — CPF ou CNPJ do cliente
  - `code` string — Código opcional para referência via API
  - `notes` string — Observações adicionais internas sobre o cliente
  - `status` 'active' | 'inactive' | 'archived', required — Status do cliente
  - `created_at` string, required — Data e hora do cadastro do cliente
  - `updated_at` string, required — Data e hora da última atualização do cliente
  - `metadata` object — Metadados do cliente
  - `address` Address
    - `street` string, required — Endereço (rua, avenida etc)
    - `number` string, required — Número do endereço
    - `additional_details` string — Complemento do endereço
    - `zipcode` string, required — CEP
    - `neighborhood` string, required — Bairro
    - `city` string, required — Cidade
    - `state` string, required — Estado
    - `country` string, required — Código do país no formato ISO 3166-1 alpha-2. Exemplo: BR
  - `phones` Phone[] — Lista de números de telefone do cliente
    - `id` integer, required — ID do número de telefone
    - `phone_type` 'mobile' | 'landline', required — Tipo
    - `number` string, required — Número de telefone no formato E.164 incluindo código do país e código de área. Exemplo: 5511975416666
    - `extension` string — Ramal com até 6 dígitos

## Other responses

- `400` — Erro de sintaxe JSON no corpo do request.
- `422` — Parâmetros inválidos. Verificar erro na resposta.

---

[API](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost.md) · [All operations](https://skmtc.net/vindi/apis/001-vindi-pagamentos-agost/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vindi/001-vindi-pagamentos-agost/revisions/9d11e5de9308/schema)