POST
/
v1
/
customers
Criar cliente
curl --request POST \
  --url https://api.base39.io/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "username": "<string>",
  "address": {
    "city": "São Paulo",
    "state": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "birthDate": "2023-12-25",
  "birthPlace": "<string>",
  "nationality": "AF",
  "gender": "<string>",
  "publicPerson": true,
  "maritalStatus": "single",
  "motherName": "<string>",
  "additionalDocuments": [
    {
      "type": "<string>",
      "number": "<string>",
      "issuer": "<string>",
      "state": "AC"
    }
  ],
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631"
    }
  ],
  "metadata": {}
}'
{
  "id": "cust_5f92f01728e009f403d8502e",
  "document": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "username": "<string>",
  "address": {
    "city": "São Paulo",
    "state": "São Paulo",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "birthDate": "2023-12-25",
  "birthPlace": "<string>",
  "nationality": "AF",
  "gender": "<string>",
  "publicPerson": true,
  "maritalStatus": "single",
  "motherName": "<string>",
  "additionalDocuments": [
    {
      "type": "<string>",
      "number": "<string>",
      "issuer": "<string>",
      "state": "AC"
    }
  ],
  "attachments": [
    {
      "file": "file_6307b6c39f5d3d917009b631",
      "linkedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Chave única de idempotência para evitar duplicação de requisições.

Query Parameters

​
expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

​
fields
string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar um cliente

Response

201 - application/json

Retorna o objeto Customer se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa um cliente.