DELETE
/
v1
/
customers
/
{id}
/
files
/
{file}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required
  • O ID do object
file
string
required

ID do arquivo

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.

Response

200 - application/json

Este objeto representa um cliente.

id
string

Identificador exclusivo para o objeto.

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
string

Gênero do cliente.

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

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

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