Criar link de arquivo

POST 
/v1/file-links

Cria um novo link de arquivo.

Request

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.
Example: data.loan
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.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

x-content-md5 string
Para link de Upload, enviar o resumo MD5 de 128 bits codificados em base64 do arquivo de acordo com a RFC 1864
Example: 1B2M2Y8AsgTpgAmY7PhCfg==
Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e
base39-external-client-id string

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

application/json

Body

expires numberrequired

Tempo em segundos em que o link expira.

method stringrequired
Possible values: [download, upload]
Default value: download

methodData

object

required

anyOf

download

file stringrequired

Example: file_631f61201fc21101870d22a9

upload

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.

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.

Responses

201

Retorna o objeto FileLink se a criação for bem-sucedida; retorna erro se os parâmetros forem inválidos.

application/json

Schema

Schema

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

Example (from schema)

{
  "id": "link_63eb84cc5ebbf96915062ecb",
  "expires": 0,
  "url": "https://files.base39.io/links/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "method": "download",
  "expired": true,
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}

Loading...