Skip to main content
POST
Criar um Cliente
string
required
Token de autenticação do tipo Bearer obtido através do endpoint de login.
string
required
Nome completo do cliente (segurado).
string
CPF do cliente, com ou sem formatação (ex: 123.456.789-00 ou 12345678900). Obrigatório quando o campo passport não for informado.
string
Número do passaporte para clientes estrangeiros sem CPF. Obrigatório quando document não for informado.
string
required
Telefone com DDD, com ou sem formatação (ex: (47) 99999-9999 ou 47999999999).
string
required
Endereço de e-mail do cliente.
string
Data de nascimento no formato YYYY-MM-DD (ex: 1990-05-15). Deve ser anterior à data atual.
string
Nome social do cliente, caso aplicável.
string
Senha para acesso do cliente à área do segurado ClubFix. Se não informada, o CPF é usado como senha padrão.
object
Endereço do cliente. Objeto opcional, mas recomendado para emissão da apólice.
string
Logradouro (rua, avenida, etc.). Obrigatório quando o objeto address for informado.
string
Número do imóvel (aceita letras e números). Obrigatório quando address for informado.
string
Complemento (apto, bloco, sala, etc.). Opcional.
string
Bairro. Opcional.
string
Cidade. Obrigatório quando address for informado.
string
Sigla da UF com 2 letras (ex: SC, SP, RJ). Obrigatório quando address for informado.
string
CEP somente com dígitos, 8 caracteres (ex: 89000000). Obrigatório quando address for informado.

Resposta

Retorna o recurso do cliente criado. O campo id deve ser utilizado como customer_id nos endpoints de contratação.
Se o cliente já existir com o CPF informado, a API retorna erro. Use o endpoint GET /customers/{document} para verificar se o cliente já está cadastrado antes de tentar criá-lo.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
string
required

Body

application/json
name
string
document
string
phone
string
email
string
password
string
address
object

Response

Customer stored example

id
integer
name
string
document
string
phone
string
email
string
address
object