FileLink

Este objeto representa um link de arquivo.

id string
Identificador exclusivo para o objeto.
Example: link_63eb84cc5ebbf96915062ecb
expires number

Tempo em segundos em que o link expira.

url uri
A URL acessível publicamente para baixar ou enviar o arquivo.
Example: https://files.base39.io/links/497f6eca-6276-4993-bfeb-53cbbbba6f08
method string
Possible values: [download, upload]
Default value: download

methodData

object

anyOf

download

file stringrequired

Example: file_631f61201fc21101870d22a9

upload

file string

Identificador do objeto File que será criado quando gerar um link de upload

Example: file_5f92f01728e009f403d8502e

purpose stringrequired

Propósito do arquivo

Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, installment, insurance_signature, insurance_signed]

title string

Um título amigável para o documento. Por padrão, o title é salvo normalizado sem acentos. Por exemplo, "Contrato de Prestação de Serviços" é normalizado para "Contrato de Prestacao de Servicos".

metadata object

publicRead boolean

Define se o seu arquivo é público ou privado, caso seja público não sera necessário criar um link para download.

expired boolean

Se este link já expirou.

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 date-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice