Pular para o conteúdo principal

File

Este objeto representa um arquivo.

idstring

Identificador exclusivo para o objeto.

Example: file_63eb84cc5ebbf96915062ecb
statusstring[]

Status do arquivo

Possible values: [verified, not_verified, denied]

Default value: not_verified
Example: verified
purposestring

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.

typestring

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

Possible values: [csv, pdf, jpg, png]

sizeinteger

O tamanho em bytes do objeto de arquivo.

publicReadboolean

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.

versionstring

Versão do arquivo para uma chave do objeto.

Example: _K9S8UjcthBwQI74hGAF.4WxP56k7JPB
etagstring

Resultado é um hash MD5 do objeto armazenado.

Example: c166ebe753806fea4130b6bef70a1229
sha1string

Criptografia do arquivo utilizando o metodo SHA1

Example: 88368d01f14466bc9065a1ad34252675901ce5a2
sha512string

Criptografia do arquivo utilizando o metodo SHA512

Example: d261cba960dfe226af30e9f67a34977cee1da52507f90921628436d3bde789679fa7c5498d7ea4d5d1bbb9481b4e03a7eab0d436080bdb781ffb87ba865d216b
sha256string

Criptografia do arquivo utilizando o metodo SHA256

Example: a56804908e8541628c6b0d781c28760cd45e011975df0f115cbc2aa85f11ff1b
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
File
{
"id": "file_63eb84cc5ebbf96915062ecb",
"status": "verified",
"purpose": "account_requirement",
"title": "string",
"type": "csv",
"size": 0,
"publicRead": true,
"hash": {
"version": "_K9S8UjcthBwQI74hGAF.4WxP56k7JPB",
"etag": "c166ebe753806fea4130b6bef70a1229",
"sha1": "88368d01f14466bc9065a1ad34252675901ce5a2",
"sha512": "d261cba960dfe226af30e9f67a34977cee1da52507f90921628436d3bde789679fa7c5498d7ea4d5d1bbb9481b4e03a7eab0d436080bdb781ffb87ba865d216b",
"sha256": "a56804908e8541628c6b0d781c28760cd45e011975df0f115cbc2aa85f11ff1b"
},
"metadata": {},
"createdAt": "2023-08-25T22:38:41.134Z"
}