POST
/
v1
/
customers
/
{id}
curl --request POST \
  --url https://api.base39.io/v1/customers/{id} \
  --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": "SP",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "birthDate": "2023-12-25",
  "birthPlace": "<string>",
  "nationality": "AF",
  "gender": "female",
  "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": "SP",
    "country": "BR",
    "line1": "Av Paulista",
    "line2": "Sala 404",
    "number": "123",
    "postalCode": "12123123",
    "neighborhood": "Bela Vista"
  },
  "birthDate": "2023-12-25",
  "birthPlace": "<string>",
  "nationality": "AF",
  "gender": "female",
  "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,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "<string>",
    "app": "backoffice"
  }
}

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.

​
base39-external-client-id
string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

Path Parameters

​
id
string
required
  • O ID do object

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

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Body

application/json

Este objeto representa um cliente.

​
document
string

Documento de identificação do cliente. Deve ser o CPF.

Required string length: 11
​
name
string

O nome completo do cliente ou o nome da empresa.

​
email
string

O endereço de e-mail do cliente.

​
phone
string

O número de telefone do cliente.

​
username
string

Nome de usuário para login. Pode ser qualquer valor único.

​
address
object

A especificação de um endereço

​
birthDate
string

Data de nascimento do cliente.

​
birthPlace
string

Local de nascimento do cliente.

​
nationality
enum<string>

Nacionalidade do cliente.

Available options:
AF,
ZA,
AL,
DE,
AD,
AO,
AI,
AQ,
AG,
SA,
DZ,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BO,
BA,
BW,
BR,
BN,
BG,
BF,
BI,
BT,
CV,
CM,
KH,
CA,
IC,
KZ,
EA,
TD,
CL,
CN,
CY,
SG,
CO,
KM,
CG,
KP,
KR,
CI,
CR,
HR,
CU,
CW,
DG,
DK,
DJ,
DM,
EG,
SV,
AE,
EC,
ER,
SK,
SI,
ES,
US,
EE,
ET,
FJ,
PH,
FI,
FR,
GA,
GM,
GH,
GE,
GI,
GB,
GD,
GR,
GL,
GP,
GU,
GT,
GG,
GY,
GF,
GN,
GQ,
GW,
HT,
NL,
HN,
HK,
HU,
YE,
BV,
AC,
CP,
IM,
CX,
PN,
RE,
AX,
KY,
CC,
CK,
FO,
GS,
HM,
FK,
MP,
MH,
UM,
NF,
SB,
SC,
TK,
TC,
VI,
VG,
IN,
ID,
IR,
IQ,
IE,
IS,
IL,
IT,
JM,
JE,
JO,
KI,
XK,
KW,
LA,
LS,
LV,
LB,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MY,
MW,
MV,
ML,
MT,
MA,
MQ,
MU,
MR,
YT,
MX,
FM,
MZ,
MD,
MC,
MN,
ME,
MS,
MM,
NA,
NR,
NP,
NI,
NE,
NG,
NU,
NO,
NC,
NZ,
OM,
BQ,
PW,
PS,
PA,
PG,
PK,
PY,
PE,
PF,
PL,
PR,
PT,
QA,
KE,
KG,
CF,
CD,
DO,
CZ,
RO,
RW,
RU,
EH,
PM,
AS,
WS,
SM,
SH,
LC,
BL,
KN,
MF,
SX,
ST,
VC,
SN,
SL,
RS,
SY,
SO,
LK,
SZ,
SD,
SS,
SE,
CH,
SR,
SJ,
TJ,
TH,
TW,
TZ,
IO,
TF,
TL,
TG,
TO,
TT,
TA,
TN,
TM,
TR,
TV,
UA,
UG,
UY,
UZ,
VU,
VA,
VE,
VN,
WF,
ZM,
ZW
​
gender
enum<string>

Gênero do cliente.

Available options:
female,
male,
other,
prefer_not_to_answer
​
publicPerson
boolean

Indentificador se o cliente é uma pessoa politicamente exposta.

​
maritalStatus
enum<string>

Estado civil do cliente.

Available options:
single,
married,
widowed,
divorced,
separated
​
motherName
string

Nome da mãe do cliente.

​
additionalDocuments
object[]

Documentos adicionais.

​
attachments
object[]
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

Response

200 - application/json
Retorna o objeto `Customer` se a atualização for bem-sucedida; retorna erro se os parâmetros forem inválidos, como um documento incorreto.

Este objeto representa um cliente.

​
id
string

Identificador exclusivo para o objeto.

Example:

"cust_5f92f01728e009f403d8502e"

​
document
string

Documento de identificação do cliente. Deve ser o CPF.

Required string length: 11
​
name
string

O nome completo do cliente ou o nome da empresa.

​
email
string

O endereço de e-mail do cliente.

​
phone
string

O número de telefone do cliente.

​
username
string

Nome de usuário para login. Pode ser qualquer valor único.

​
address
object

A especificação de um endereço

​
birthDate
string

Data de nascimento do cliente.

​
birthPlace
string

Local de nascimento do cliente.

​
nationality
enum<string>

Nacionalidade do cliente.

Available options:
AF,
ZA,
AL,
DE,
AD,
AO,
AI,
AQ,
AG,
SA,
DZ,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BO,
BA,
BW,
BR,
BN,
BG,
BF,
BI,
BT,
CV,
CM,
KH,
CA,
IC,
KZ,
EA,
TD,
CL,
CN,
CY,
SG,
CO,
KM,
CG,
KP,
KR,
CI,
CR,
HR,
CU,
CW,
DG,
DK,
DJ,
DM,
EG,
SV,
AE,
EC,
ER,
SK,
SI,
ES,
US,
EE,
ET,
FJ,
PH,
FI,
FR,
GA,
GM,
GH,
GE,
GI,
GB,
GD,
GR,
GL,
GP,
GU,
GT,
GG,
GY,
GF,
GN,
GQ,
GW,
HT,
NL,
HN,
HK,
HU,
YE,
BV,
AC,
CP,
IM,
CX,
PN,
RE,
AX,
KY,
CC,
CK,
FO,
GS,
HM,
FK,
MP,
MH,
UM,
NF,
SB,
SC,
TK,
TC,
VI,
VG,
IN,
ID,
IR,
IQ,
IE,
IS,
IL,
IT,
JM,
JE,
JO,
KI,
XK,
KW,
LA,
LS,
LV,
LB,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MY,
MW,
MV,
ML,
MT,
MA,
MQ,
MU,
MR,
YT,
MX,
FM,
MZ,
MD,
MC,
MN,
ME,
MS,
MM,
NA,
NR,
NP,
NI,
NE,
NG,
NU,
NO,
NC,
NZ,
OM,
BQ,
PW,
PS,
PA,
PG,
PK,
PY,
PE,
PF,
PL,
PR,
PT,
QA,
KE,
KG,
CF,
CD,
DO,
CZ,
RO,
RW,
RU,
EH,
PM,
AS,
WS,
SM,
SH,
LC,
BL,
KN,
MF,
SX,
ST,
VC,
SN,
SL,
RS,
SY,
SO,
LK,
SZ,
SD,
SS,
SE,
CH,
SR,
SJ,
TJ,
TH,
TW,
TZ,
IO,
TF,
TL,
TG,
TO,
TT,
TA,
TN,
TM,
TR,
TV,
UA,
UG,
UY,
UZ,
VU,
VA,
VE,
VN,
WF,
ZM,
ZW
​
gender
enum<string>

Gênero do cliente.

Available options:
female,
male,
other,
prefer_not_to_answer
​
publicPerson
boolean

Indentificador se o cliente é uma pessoa politicamente exposta.

​
maritalStatus
enum<string>

Estado civil do cliente.

Available options:
single,
married,
widowed,
divorced,
separated
​
motherName
string

Nome da mãe do cliente.

​
additionalDocuments
object[]

Documentos adicionais.

​
attachments
object[]
​
metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

​
createdAt
string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object
​
updatedBy
object