Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Documents | Documentos

Upload a document for a proposal | Fazer upload de documento para uma proposta

Uploads a file associated with a specific proposal and document type. | Faz upload de um arquivo associado a uma proposta específica e tipo de documento.

post/documents/{proposal_id}/documents

Path parameters

proposal_idstring uuid required

Proposal ID | ID da proposta

Request body

content_type'image/png' | 'application/pdf' required
document_type'SELFIE' | 'ID' | 'PROOF_OF_ADDRESS' | 'PROOF_OF_INCOME' | 'PROOF_OF_OWNERSHIP' | 'CCB' required
filestring required
file_name'SELFIE.png' | 'ID.png' | 'PROOF_OF_ADDRESS.png' | 'PROOF_OF_INCOME.png' | 'PROOF_OF_OWNERSHIP.png' | 'CCB.pdf' required

Example request

{
  "content_type": "image/png",
  "document_type": "SELFIE",
  "file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==",
  "file_name": "SELFIE.png"
}

Response

Document uploaded successfully | Documento enviado com sucesso

content_type'image/png' | 'application/pdf' required
created_atstring
customer_idstring
document_type'SELFIE' | 'ID' | 'PROOF_OF_ADDRESS' | 'PROOF_OF_INCOME' | 'PROOF_OF_OWNERSHIP' | 'CCB' required
file_name'SELFIE.png' | 'ID.png' | 'PROOF_OF_ADDRESS.png' | 'PROOF_OF_INCOME.png' | 'PROOF_OF_OWNERSHIP.png' | 'CCB.pdf' required
file_sizeinteger
idstring
proposal_idstring
updated_atstring
upload_timestampstring

Example response

{
  "created_at": "2025-07-15T15:54:24.614086-03:00",
  "customer_id": "d9ece0d8-ffdb-45d7-abd1-48047a6c192d",
  "file_size": 1919,
  "id": "a39d0058-2073-4d6b-9044-7d0e2b030eb8",
  "proposal_id": "0d304256-730f-4540-93bf-89115ff1f4fd",
  "updated_at": "2025-07-15T15:54:24.632027-03:00",
  "upload_timestamp": "2025-07-15T15:54:24.566034-03:00"
}