Estrutura
Um cliente é representado em nossa API pela seguinte estrutura:Atributos
string
Identificador único do cliente no formato CUID.
string
Nome completo do cliente.
string
Endereço de e-mail do cliente.
string
Telefone com DDD, somente números.
string
CPF ou CNPJ do cliente, somente números. Usado como identificador único por projeto.
string
Nome da rua ou logradouro.
string
Número do endereço.
string | null
Complemento do endereço (ex:
Apto 4). Opcional.string
Bairro do cliente.
string
CEP somente números.
string
Cidade do cliente.
string
Sigla do estado (UF).
string
Código do país no formato ISO 3166-1 alpha-2.
boolean
Indica se o cliente está bloqueado. Clientes bloqueados não podem gerar novas transações.
date-time | null
Data e hora em que o bloqueio foi aplicado.
string | null
Motivo registrado para o bloqueio do cliente.
date-time | null
Data de expiração do bloqueio.
null indica bloqueio permanente até desbloqueio manual.string | null
Tipo de bloqueio aplicado.
date-time
Data e hora de criação do registro.
date-time
Data e hora da última atualização.
Próximos passos
Buscar cliente por ID
Recupere um cliente específico do projeto.
Clientes
Entenda como a Bob vincula compradores e transações.