MY PROP JOURNAL

Documentos

Sube y gestiona documentos relacionados con el trading

Descripción General

La API de Documentos te permite subir, organizar y gestionar documentos importantes de trading como confirmaciones de pagos, certificados de evaluación y recibos.

URL Base: /api/v1/documents

Formatos soportados: JPEG, PNG, WebP, PDF
Tamaño máximo de archivo: 25MB

Listar Documentos

Recupera tus documentos subidos con filtros opcionales.

GET /api/v1/documents

Parámetros de Consulta

ParámetroTipoDescripción
limitintegerNúmero de resultados (1-100, predeterminado: 20)
offsetintegerDesplazamiento de paginación (predeterminado: 0)
account_idstringFiltrar por ID de cuenta
categorystringFiltrar por categoría de documento
searchstringBuscar nombre de documento o número de cuenta
start_datestringFiltrar por fecha de subida (AAAA-MM-DD)
end_datestringFiltrar por fecha de subida (AAAA-MM-DD)

Obtener Documento Individual

Recupera detalles de un documento específico.

GET /api/v1/documents/{id}

Subir Documento

Sube un nuevo documento o reemplaza uno existente.

POST /api/v1/documents
Content-Type: multipart/form-data

file: <binary>
document_name: "Pago Enero 2024"
category: "payout-confirmation"
account_number: "CTA-12345"
replace: false
document_id: (requerido si replace=true)

Categorías de Documentos

  • payout-confirmation - Comprobante de recibo de pago
  • evaluation-pass-certificate - Certificado de completación de fase de evaluación
  • account-scale-certificate - Certificado de hito de escalamiento de cuenta
  • receipt - Recibos de compra (tarifas, suscripciones, etc.)

Actualizar Metadatos del Documento

Actualiza el nombre o categoría del documento (no reemplaza el archivo).

PUT /api/v1/documents/{id}
Content-Type: application/json

{
  "document_name": "Pago Enero 2024 - Actualizado",
  "category": "payout-confirmation"
}

Eliminar Documento

Elimina un documento y su archivo del almacenamiento.

DELETE /api/v1/documents/{id}

Eliminación de Archivo

Eliminar un documento eliminará permanentemente el archivo del almacenamiento. Esta acción no se puede deshacer. La respuesta de la API confirmará si el archivo se eliminó correctamente del almacenamiento.

Mejores Prácticas

  1. Usa nombres descriptivos - Incluye fecha y descripción en los nombres de documentos
  2. Organiza por categoría - La categorización consistente facilita encontrar documentos
  3. PDF para documentos importantes - Usa formato PDF para certificados oficiales
  4. Respaldos regulares - Aunque los documentos se almacenan de forma segura, mantén tus propios respaldos
  5. Limpia documentos no utilizados - Elimina documentos que ya no necesites