Excluir um arquivo

curl -X DELETE "https://api.chargefy.io/v1/files/file_o3RqRstTxyMgvkXQ" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "file_o3RqRstTxyMgvkXQ",
  "object": "file",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "File not found.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "file_in_use",
    "message": "This file is referenced by the organization's identity verification. Replace the verification document first, then delete the file.",
    "type": "invalid_request_error"
  }
}

Remove um file da organização atuante. A remoção marca o arquivo como excluído, apaga o arquivo do Storage e limpa referências públicas conhecidas, como product.image_url e avatar da organização. Um kyc_document referenciado pela verificação de identidade da organização não pode ser excluído: a resposta é 409 file_in_use. Substitua primeiro o bloco verification.document (ou verification.selfie) no update da organização e exclua o arquivo antigo depois.

Autenticação

A API key da sua organização atua diretamente nela. Não envie o header Organization nesse caso.

Com Chargefy for Platforms, envie também Organization: org_... para excluir um arquivo de uma organização filha ativa da plataforma.

Parâmetros de caminho

string

required

ID do arquivo (file_*).

curl -X DELETE "https://api.chargefy.io/v1/files/file_o3RqRstTxyMgvkXQ" \
  -H "Authorization: Bearer {{API_KEY}}"

Resposta

200 OK com confirmação de remoção.

{
  "id": "file_o3RqRstTxyMgvkXQ",
  "object": "file",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "File not found.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "file_in_use",
    "message": "This file is referenced by the organization's identity verification. Replace the verification document first, then delete the file.",
    "type": "invalid_request_error"
  }
}

Erros comuns

Status	`code`	Quando ocorre
`401`	`authentication_failed`	API key ausente, inválida ou revogada
`404`	`resource_missing`	Arquivo não existe nesta organização (ou foi removido)
`409`	`file_in_use`	Arquivo de verificação ainda referenciado pelo cadastro de identidade

curl -X DELETE "https://api.chargefy.io/v1/files/file_o3RqRstTxyMgvkXQ" \
  -H "Authorization: Bearer {{API_KEY}}"

{
  "id": "file_o3RqRstTxyMgvkXQ",
  "object": "file",
  "deleted": true
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid API key provided.",
    "type": "authentication_error"
  }
}

{
  "error": {
    "code": "resource_missing",
    "message": "File not found.",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "code": "file_in_use",
    "message": "This file is referenced by the organization's identity verification. Replace the verification document first, then delete the file.",
    "type": "invalid_request_error"
  }
}

Fundamentos da API

Objetos de sistema

Webhooks e eventos

SDKs

MCP

Excluir um arquivo

Autenticação

Parâmetros de caminho

Resposta

Erros comuns

​Autenticação

​Parâmetros de caminho

​Resposta

​Erros comuns

Autenticação

Parâmetros de caminho

Resposta

Erros comuns