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

# Criar cliente

> API SDK Documentação - Customers

Crie clientes para vincular em suas cobranças.

### Método

<Tabs>
  <Tab title="Node.js">
    ```typescript theme={null}
    import { Malga } from 'malga'

    const malga = new Malga({
      apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
      clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
    })

    await malga.customers.create({
      name: 'João da Silva',
      email: 'joao.silva@test.com',
      phoneNumber: '99999999999',
      document: {
    		number: '99999999999',
    		type: 'cpf',
    		country: 'BR'
    	},
    	address: {
    		city: 'Rio de Janeiro',
    		complement: 'Sala 214',
    		country: 'BR',
    		district: 'São Conrado',
    		state: 'RJ',
    		street: 'Estrada da Gávea',
    		streetNumber: '696',
    		zipCode: '22610002'
    	}
    })
    ```
  </Tab>
</Tabs>

<Tabs>
  <Tab title="Response">
    ```typescript theme={null}
    {
    	id: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
    	name: 'João da Silva',
    	email: 'joao.silva@test.com',
    	clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
    	phoneNumber: '99999999999',
    	createdAt: '2023-12-31T19:36:30.741Z',
    	document: {
    		number: '99999999999',
    		type: 'cpf',
    		country: 'BR'
    	},
    	address: {
    		city: 'Rio de Janeiro',
    		complement: 'Sala 214',
    		country: 'BR',
    		district: 'São Conrado',
    		state: 'RJ',
    		street: 'Estrada da Gávea',
    		streetNumber: '696',
    		zipCode: '22610002'
    	}
    }
    ```
  </Tab>
</Tabs>

### Parâmetros

Lista de todos os parâmetros suportados pelo método.

<ParamField path="name" type="string" required>
  Nome do cliente
</ParamField>

<ParamField path="email" type="string" required>
  E-mail do cliente
</ParamField>

<ParamField path="phoneNumber" type="string" required>
  Telefone do cliente
</ParamField>

<ParamField path="document" type="object">
  Dados do documento do cliente

  <Expandable title="Parâmetros do document">
    <ParamField path="type" type="string" required>
      Tipo do documento
    </ParamField>

    <ParamField path="number" type="string" required>
      Número do documento
    </ParamField>

    <ParamField path="country" type="string">
      País do documento
    </ParamField>
  </Expandable>
</ParamField>

<ParamField path="address" type="object">
  Dados de endereço do cliente

  <Expandable title="Parâmetros do address">
    <ParamField path="city" type="string" required>
      Cidade
    </ParamField>

    <ParamField path="country" type="string" required>
      País
    </ParamField>

    <ParamField path="district" type="string" required>
      Bairro
    </ParamField>

    <ParamField path="state" type="string" required>
      Estado
    </ParamField>

    <ParamField path="street" type="string" required>
      Nome da rua, avenida ou travessa
    </ParamField>

    <ParamField path="streetNumber" type="string" required>
      Número da rua
    </ParamField>

    <ParamField path="zipCode" type="string" required>
      Código postal
    </ParamField>

    <ParamField path="complement" type="string">
      Complemento onde se localiza o endereço, caso exista
    </ParamField>
  </Expandable>
</ParamField>

Também é possível passar um segundo parâmetro no método para ignorar as validações de duplicação de e-mail e documento

<ParamField path="force" type="boolean">
  Parâmetro para ignorar a duplicidade de clientes, o padrão é <code>false</code>
</ParamField>
