POST
/
v1
/
files
/
{file}
/
mark-denied
curl --request POST \
  --url https://api.base39.io/v1/files/{file}/mark-denied \
  --header 'Authorization: Bearer <token>'
{
  "id": "file_63eb84cc5ebbf96915062ecb",
  "status": "verified",
  "purpose": "account_requirement",
  "title": "<string>",
  "type": "csv",
  "size": 123,
  "publicRead": true,
  "hash": {
    "version": "_K9S8UjcthBwQI74hGAF.4WxP56k7JPB",
    "etag": "c166ebe753806fea4130b6bef70a1229",
    "sha1": "88368d01f14466bc9065a1ad34252675901ce5a2",
    "sha512": "d261cba960dfe226af30e9f67a34977cee1da52507f90921628436d3bde789679fa7c5498d7ea4d5d1bbb9481b4e03a7eab0d436080bdb781ffb87ba865d216b",
    "sha256": "a56804908e8541628c6b0d781c28760cd45e011975df0f115cbc2aa85f11ff1b"
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
base39-external-client-id
string

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

Path Parameters

​
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

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.

Response

200 - application/json
Retorna o objeto `File` se a mudança de estado for bem-sucedida; retorna erro se os parâmetros forem inválidos.

Este objeto representa um arquivo.

​
id
string

Identificador exclusivo para o objeto.

Example:

"file_63eb84cc5ebbf96915062ecb"

​
status
string
default:not_verified

Status do arquivo

Example:

"verified"

​
purpose
enum<string>

Propósito do arquivo

Available options:
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.

​
type
enum<string>

O tipo do arquivo retornado (csv, pdf, jpg ou png).

Available options:
csv,
pdf,
jpg,
png
​
size
integer

O tamanho em bytes do objeto de arquivo.

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

​
hash
object

Informações para legitimar a integridade do arquivo.

​
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

Example:

"2023-08-25T22:38:41.134Z"

Marcar arquivo como verificadoObter um tema.