POST
/
v1
/
files
/
{file}
/
mark-denied

Authorizations

Authorization
string
headerrequired

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

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[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Response

200 - application/json

Este objeto representa um arquivo.

id
string

Identificador exclusivo para o objeto.

status
string
default: not_verified

Status do arquivo

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

Marcar arquivo como verificadoListar faturas