file representa um arquivo que você enviou para a Chargefy e que fica hospedado para ser referenciado por outros recursos — uma foto usada em product.image_url, o avatar exibido em listas e recibos, ou um documento anexado como evidência de disputa. Cada file guarda os metadados do arquivo (nome, tipo MIME, tamanho) e expõe uma url que aponta para o conteúdo hospedado.
Ele surge quando você faz upload pela API e a purpose define como o arquivo é armazenado: arquivos públicos devolvem uma url permanente em storage.chargefy.io, enquanto arquivos privados devolvem uma URL assinada de curta validade, regenerada a cada leitura. O upload em si não vincula o arquivo a nenhum recurso — guardar a url no campo de destino é responsabilidade do recurso que vai referenciá-lo. Um kyc_document enviado pela API espera 30 dias por esse vínculo (expires_at); depois disso ele não pode mais ser apontado no cadastro e é preciso enviar o arquivo de novo.
Data Object
Este é o formato completo retornado emcreate, get e itens de list.
string
Identificador do arquivo. Usa o prefixo
file_*.string
Sempre
"file".string
Data de criação em ISO 8601.
string | null
Validade de um
kyc_document enviado pela API enquanto nenhum cadastro o
aponta: 30 dias depois do upload, em ISO 8601. Apontar o arquivo no bloco
verification de POST /v1/organizations/{id}
zera a validade; um arquivo vencido é recusado ali com 400 file_expired e
precisa ser enviado de novo. null para os demais purposes, para arquivos
já apontados e para uploads feitos pelo Dashboard ou pela ativação
hospedada. Nenhum arquivo é apagado pela validade.string
Nome do binário armazenado. Quando não foi informado no upload, parte do nome
enviado; imagens preparadas pela Chargefy terminam em
.webp.boolean
true em produção; false em ambiente de teste.object
Objeto livre para correlacionar o arquivo com o seu sistema. Quando vazio,
retorna
{}. O conteúdo é sempre seu: a Chargefy nunca grava chaves aqui.string
Tipo MIME do binário armazenado, como
image/webp ou application/pdf.
Imagens aceitas pela política retornam image/webp, mesmo quando a entrada
era JPG, PNG, GIF, BMP, HEIC ou HEIF.string
Define como o arquivo foi validado e armazenado.
integer
Tamanho do binário armazenado em bytes, depois da normalização quando for
imagem.
string | null
Data da última atualização em ISO 8601. Vem
null enquanto o arquivo nunca
foi atualizado.string | null
URL para acessar o binário hospedado. Permanente para arquivos públicos
(
organization_avatar, user_avatar, product_image, order_bump_image, checkout_cover_image, platform_avatar,
branding_logo, branding_footer_logo); assinada e de curta validade (1
hora) para arquivos privados (dispute_evidence, kyc_document), regenerada
a cada get. Vem null quando a URL não pôde ser resolvida.