Pular para o conteúdo principal
O objeto Cliente representa um comprador ou pagador em sua aplicacao. Clientes podem ser associados a transacoes para facilitar o acompanhamento de pagamentos e historico de compras.

​
Estrutura

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "cliente_123",
  "name": "Maria Silva",
  "email": "[email protected]",
  "document": "12345678901",
  "documentType": "CPF",
  "phone": "+5511999999999",
  "status": "Active",
  "metadata": "{\"plano\": \"premium\"}",
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 45",
    "neighborhood": "Centro",
    "city": "Sao Paulo",
    "state": "SP",
    "postalCode": "01234567",
    "country": "BR"
  },
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Atributos

​
id
string
obrigatório
Identificador unico do cliente no formato UUID v4. Gerado automaticamente pela API.
​
externalId
string
Identificador externo do cliente no seu sistema. Util para vincular o cliente da Safefy com registros do seu banco de dados.
​
name
string
obrigatório
Nome completo do cliente.
​
email
string
obrigatório
Endereco de email do cliente. Deve ser um email valido.
​
document
string
Numero do documento do cliente (CPF ou CNPJ) sem formatacao, apenas numeros.
​
documentType
string
Tipo do documento do cliente. Valores possiveis:
  • CPF - Cadastro de Pessoa Fisica
  • CNPJ - Cadastro Nacional de Pessoa Juridica
​
phone
string
Numero de telefone do cliente no formato internacional (ex: +5511999999999).
​
status
string
obrigatório
Status atual do cliente. Valores possiveis:
  • Active - Cliente ativo e pode realizar transacoes
  • Inactive - Cliente inativo
​
metadata
string
Campo livre para armazenar informacoes adicionais em formato JSON string. Maximo de 1000 caracteres.
​
address
object
Objeto contendo o endereco do cliente.
​
createdAt
string
obrigatório
Data e hora de criacao do cliente no formato ISO 8601.

​
Endpoints

MetodoEndpointDescricao
POST/v1/customersCriar cliente
GET/v1/customersListar clientes
GET/v1/customers/{id}Buscar cliente
PATCH/v1/customers/{id}Atualizar cliente