> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payments.bob.company/llms.txt
> Use this file to discover all available pages before exploring further.

# Estrutura do cliente

> Gerencie os compradores do seu projeto com histórico de transações

## Estrutura

Um cliente é representado em nossa API pela seguinte estrutura:

```json theme={"system"}
{
  "id": "clx1a2b3c4d5e6f7g8h9",
  "name": "João Silva",
  "email": "joao@email.com",
  "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

<ResponseField name="id" type="string">
  Identificador único do cliente no formato CUID.
</ResponseField>

<ResponseField name="name" type="string">
  Nome completo do cliente.
</ResponseField>

<ResponseField name="email" type="string">
  Endereço de e-mail do cliente.
</ResponseField>

<ResponseField name="phone" type="string">
  Telefone com DDD, somente números.
</ResponseField>

<ResponseField name="document" type="string">
  CPF ou CNPJ do cliente, somente números. Usado como identificador único por projeto.
</ResponseField>

<ResponseField name="street" type="string">
  Nome da rua ou logradouro.
</ResponseField>

<ResponseField name="streetNumber" type="string">
  Número do endereço.
</ResponseField>

<ResponseField name="complement" type="string | null">
  Complemento do endereço (ex: `Apto 4`). Opcional.
</ResponseField>

<ResponseField name="neighborhood" type="string">
  Bairro do cliente.
</ResponseField>

<ResponseField name="zipCode" type="string">
  CEP somente números.
</ResponseField>

<ResponseField name="city" type="string">
  Cidade do cliente.
</ResponseField>

<ResponseField name="state" type="string">
  Sigla do estado (UF).
</ResponseField>

<ResponseField name="country" type="string">
  Código do país no formato ISO 3166-1 alpha-2.
</ResponseField>

<ResponseField name="isBlocked" type="boolean">
  Indica se o cliente está bloqueado. Clientes bloqueados não podem gerar novas transações.
</ResponseField>

<ResponseField name="blockedAt" type="date-time | null">
  Data e hora em que o bloqueio foi aplicado.
</ResponseField>

<ResponseField name="blockedReason" type="string | null">
  Motivo registrado para o bloqueio do cliente.
</ResponseField>

<ResponseField name="blockExpiresAt" type="date-time | null">
  Data de expiração do bloqueio. `null` indica bloqueio permanente até desbloqueio manual.
</ResponseField>

<ResponseField name="blockType" type="string | null">
  Tipo de bloqueio aplicado.
</ResponseField>

<ResponseField name="createdAt" type="date-time">
  Data e hora de criação do registro.
</ResponseField>

<ResponseField name="updatedAt" type="date-time">
  Data e hora da última atualização.
</ResponseField>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Buscar cliente por ID" icon="magnifying-glass" href="/pages/customers/get">
    Recupere um cliente específico do projeto.
  </Card>

  <Card title="Clientes" icon="users" href="/pages/concepts/customers">
    Entenda como a Bob vincula compradores e transações.
  </Card>
</CardGroup>