Skip to main content

​
Estrutura

Um cliente é representado em nossa API pela seguinte estrutura: 
{
  "id": "clx1a2b3c4d5e6f7g8h9",
  "name": "João Silva",
  "email": "[email protected]",
  "phone": "11987654321",
  "document": "12345678900",
  "street": "Rua Exemplo",
  "streetNumber": "123",
  "complement": null,
  "neighborhood": "Centro",
  "zipCode": "01234567",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "isBlocked": false,
  "blockedAt": null,
  "blockedReason": null,
  "blockExpiresAt": null,
  "blockType": null,
  "createdAt": "2026-02-28T09:00:00.000Z",
  "updatedAt": "2026-02-28T09:00:00.000Z"
}

​
Atributos:

{ "id": "clx1a2b3c4d5e6f7g8h9" }
id : string.
Identificador único do cliente no formato CUID.
{ "name": "João Silva" }
name : string.
Nome completo do cliente.
{ "email": "[email protected]" }
email : string.
Endereço de e-mail do cliente.
{ "phone": "11987654321" }
phone : string.
Telefone com DDD, somente números.
{ "document": "12345678900" }
document : string.
CPF ou CNPJ do cliente, somente números. Usado como identificador único por projeto.
{ "street": "Rua Exemplo" }
street : string.
Nome da rua ou logradouro.
{ "streetNumber": "123" }
streetNumber : string.
Número do endereço.
{ "complement": null }
complement : string | null.
Complemento do endereço (ex: Apto 4). Opcional.
{ "neighborhood": "Centro" }
neighborhood : string.
Bairro do cliente.
{ "zipCode": "01234567" }
zipCode : string.
CEP somente números.
{ "city": "São Paulo" }
city : string.
Cidade do cliente.
{ "state": "SP" }
state : string.
Sigla do estado (UF).
{ "country": "BR" }
country : string.
Código do país no formato ISO 3166-1 alpha-2.
{ "isBlocked": false }
isBlocked : boolean.
Indica se o cliente está bloqueado. Clientes bloqueados não podem gerar novas transações.
{ "blockedAt": "2026-02-28T10:00:00.000Z" }
blockedAt : date-time | null.
Data e hora em que o bloqueio foi aplicado.
{ "blockedReason": "Suspeita de fraude" }
blockedReason : string | null.
Motivo registrado para o bloqueio do cliente.
{ "blockExpiresAt": null }
blockExpiresAt : date-time | null.
Data de expiração do bloqueio. null indica bloqueio permanente até desbloqueio manual.
{ "blockType": null }
blockType : string | null.
Tipo de bloqueio aplicado.
{ "createdAt": "2026-02-28T09:00:00.000Z" }
createdAt : date-time.
Data e hora de criação do registro.
{ "updatedAt": "2026-02-28T09:00:00.000Z" }
updatedAt : date-time.
Data e hora da última atualização.