Obter link de arquivo

GET 
/v1/file-links/:file_link

Retorna um objeto FileLink

Request

Path Parameters

file_link stringrequired
ID do link de arquivo
Example: link_5f92f01728e009f403d8502e

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

Responses

200

Retorna o objeto FileLink para um ID válido.

application/json

Schema

Schema

idstring
Identificador exclusivo para o objeto.
Example: link_63eb84cc5ebbf96915062ecb
expiresnumber

Tempo em segundos em que o link expira.

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

methodData

object

anyOf

download

filestringrequired

Example: file_631f61201fc21101870d22a9

upload

filestring

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

Example: file_5f92f01728e009f403d8502e

purposestringrequired

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]

titlestring

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".

metadataobject

publicReadboolean

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

expiredboolean

Se este link já expirou.

metadataobject

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.

createdAtdate-time
Data de criação do objeto
Example: 2023-08-25T22:38:41.134Z

createdBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

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.

appstring

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"
  }
}