Desanexar arquivo do cliente
DELETE/v1/customers/:id/files/:file
Remove do cliente o vínculo de um arquivo.
Request
Path Parameters
- O ID do object
ID do arquivo
Query Parameters
- inclusao
- exclusao
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
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.
Retorna apenas os campos `id` e `createdAt`.
Example: id,createdAt
Retorna todos os campos, exceto `id`.
Example: -id
Header Parameters
Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.
Responses
- 200
Retorna o objeto Customer
.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Identificador exclusivo para o objeto.
cust_5f92f01728e009f403d8502e
Documento de identificação do cliente. Deve ser o CPF.
Possible values: >= 11 characters
and <= 11 characters
O nome completo do cliente ou o nome da empresa.
O endereço de e-mail do cliente.
O número de telefone do cliente.
Nome de usuário para login. Pode ser qualquer valor único.
address
object
A especificação de um endereço
Cidade ou distrito.
São Paulo
Estado, município, província ou região.
SP
Código de país de duas letras (ISO 3166-1 alpha-2).
BR
Linha de endereço 1 (por exemplo, rua, caixa postal).
Av Paulista
Linha de endereço 2 (por exemplo, apartamento, suíte, unidade ou prédio).
Sala 404
Número do endereço.
123
CEP ou Código postal.
12123123
Bairro.
Bela Vista
Data de nascimento do cliente.
Local de nascimento do cliente.
Nacionalidade do cliente.
Possible values: [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
]
Gênero do cliente.
Possible values: [female
, male
, other
, prefer_not_to_answer
]
Indentificador se o cliente é uma pessoa politicamente exposta.
Estado civil do cliente.
Possible values: [single
, married
, widowed
, divorced
, separated
]
Nome da mãe do cliente.
additionalDocuments
object[]
Documentos adicionais.
Estado
Possible values: [AC
, AL
, AP
, AM
, BA
, CE
, DF
, ES
, GO
, MA
, MT
, MS
, MG
, PA
, PB
, PR
, PE
, PI
, RJ
, RN
, RS
, RO
, RR
, SC
, SP
, SE
, TO
]
attachments
object[]
file_6307b6c39f5d3d917009b631
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.
Data de criação do objeto
2023-08-25T22:38:41.134Z
Data de alteração do objeto
2023-08-25T22:38:41.134Z
Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.
false
false
createdBy
object
Identificador do cliente que criou a assinatura.
client_identifier
Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id
.
Nome da aplicação que criou a assinatura.
backoffice
updatedBy
object
Identificador do cliente que criou a assinatura.
client_identifier
Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id
.
Nome da aplicação que criou a assinatura.
backoffice
{
"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": "2024-07-29",
"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": "2024-07-29T15:51:28.071Z"
}
],
"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"
}
}