Sign in

v1

latestOpenAPI 3.1.02026-07-261420929.5 KB

Criar Cliente

Essa chamada cria um objeto cliente. A propriedade zip_code realiza uma pré-consulta e valida se existe um endereço valido para o cliente, porém caso não seja retornado os dados do endereço completo do cliente, será apresentado um erro ao tentar criar o cliente informando que falta alguma informação, pois não conseguimos obter nessa pré consulta.

post/customers

Request body

emailstring required

Email do cliente

namestring required

Nome do cliente

notesstring

Notas

phoneinteger

Número do Telefone - 9 dígitos

phone_prefixinteger

Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone")

cpf_cnpjstring

CPF ou CNPJ do cliente. Obrigatório para emissão de boletos registrados. <br> Aceito o campo alfanumérico apenas para CNPJ.

cc_emailsstring

Endereços de E-mail para cópia separados por vírgula

zip_codestring

CEP. Obrigatório para emissão de boletos registrados

numberstring

Número do endereço (obrigatório caso "zip_code" seja enviado).

streetstring

Rua. Obrigatório caso CEP seja incompleto.

citystring

Cidade

statestring

Estado

districtstring

Bairro. Obrigatório caso CEP seja incompleto.

complementstring

Complemento de endereço. Ponto de referência.

Response

200

idstring
emailstring
namestring
notesstring
created_atstring
updated_atstring
{"stackTrail":"paths:/customers:post:responses:200:content:application/json:schema:properties:cc_emails","oasType":"schema","type":"unknown"}
cpf_cnpjstring
zip_codestring
numberstring
{"stackTrail":"paths:/customers:post:responses:200:content:application/json:schema:properties:complement","oasType":"schema","type":"unknown"}
phonestring
phone_prefixstring
payment_methodsobject[]
{"stackTrail":"paths:/customers:post:responses:200:content:application/json:schema:properties:default_payment_method_id","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/customers:post:responses:200:content:application/json:schema:properties:proxy_payments_from_customer_id","oasType":"schema","type":"unknown"}
citystring
statestring
districtstring
streetstring

Example response

{
  "id": "6A7BE09792BA40CFB13AA504367E5E12",
  "email": "email@iugu.com",
  "name": "Nome do Cliente",
  "notes": "Nota  sobre este cliente",
  "created_at": "2025-04-03T12:04:38-03:00",
  "updated_at": "2025-04-03T12:04:38-03:00",
  "cpf_cnpj": "11343675030",
  "zip_code": "13056-344",
  "number": "60",
  "phone": "972312345",
  "phone_prefix": "11",
  "custom_variables": [
    {
      "name": "My-var",
      "value": "var"
    }
  ],
  "city": "Campinas",
  "state": "SP",
  "district": "Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)",
  "street": "Rua Antônio Nunes"
}