Skip to main content
POST
Criar cliente

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
companyId
string
required

ID da empresa vinculada ao cliente.

Minimum string length: 1
name
string
required

Nome do cliente. Nao aceita numeros ou caracteres especiais.

Minimum string length: 1
doc
string
required

CPF ou CNPJ valido do cliente.

Minimum string length: 1
type
enum<string> | null

Tipo do cliente, conforme enum aceito pela API.

Available options:
INDIVIDUAL,
COMPANY
referenceId
string | null

Identificador externo da sua aplicacao para conciliacao.

birth
string | null

Data de nascimento do cliente, quando disponivel.

email
string<email> | null

E-mail do cliente.

phone
string[] | null

Lista de telefones do cliente.

note
string | null

Observacao interna sobre o cliente.

address
object | null

Endereco do cliente.

device
object | null

Dados do dispositivo do cliente, quando coletados no fluxo de compra.

ipAddress
string | null

IP do cliente, quando disponivel.

Response

Cliente criado.

_id
string

ID do cliente.

companyId
string

ID da empresa vinculada ao cliente.

name
string

Nome do cliente.

doc
string

Documento do cliente.

cpf
string

CPF do cliente, quando presente no payload legado.

email
string<email>

E-mail do cliente.

phone
string[]

Telefones do cliente.

status
enum<string>

Status do cliente.

Available options:
ACTIVE,
ERROR_PAYMENT,
PENDING_PAYMENT,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA
type
enum<string>

Tipo do cliente.

Available options:
INDIVIDUAL,
COMPANY
active
boolean

Indica se o cliente esta ativo.

deleted
boolean

Indica exclusao logica do cliente, quando preenchido.

referenceId
string

Referencia externa da sua aplicacao.

createdAt
string<date-time>

Data de criacao do cliente.

lastUpdate
string<date-time>

Data da ultima atualizacao do cliente.