Skip to main content

Documents

Documents represent compliance and regulatory files associated with a node. The API supports uploading, downloading, listing, and deleting documents. Each document has a type that categorizes it for compliance purposes.

Document Model

FieldTypeDescription
idstring (UUID)Unique document identifier
node_idstring (UUID)Node this document belongs to
typestringDocument type (see below)
urlstringInternal storage URL
sizeintegerFile size in bytes
content_typestringMIME type (e.g., application/pdf)
hashstringSHA-256 hash of the file content
created_atstring (ISO 8601)Creation timestamp
updated_atstring (ISO 8601)Last update timestamp
deleted_atstring (ISO 8601) | nullSoft deletion timestamp

Document Types

ValueCategoryDescription
crypto_asset_custody_policyPolicyCrypto asset custody policy
private_key_management_policyPolicyPrivate key management policy
wallet_usage_and_segmentation_policyPolicyWallet usage and segmentation policy
transfer_and_approval_processes_policyPolicyTransfer and approval processes policy
hardware_security_policyPolicyHardware security policy
wallet_opening_and_closing_procedureProcedureWallet opening and closing procedure
key_generation_backup_and_recovery_procedureProcedureKey generation, backup, and recovery procedure
transfer_operations_procedureProcedureTransfer operations procedure
end_of_day_reconciliation_and_control_procedureProcedureEnd-of-day reconciliation and control procedure
incident_management_procedureProcedureIncident management procedure
hardware_management_and_inventory_procedureProcedureHardware management and inventory procedure
custody_platform_system_architecture_documentArchitectureCustody platform system architecture document
network_topology_and_security_controls_documentArchitectureNetwork topology and security controls document
logging_and_monitoring_documentArchitectureLogging and monitoring document
testing_and_security_validation_documentsArchitectureTesting and security validation documents
organization_chart_and_role_definitionsComplianceOrganization chart and role definitions
risk_assessment_and_control_matrixComplianceRisk assessment and control matrix
customer_agreements_and_terms_of_serviceComplianceCustomer agreements and terms of service
customer_disclosure_and_risk_notification_documentsComplianceCustomer disclosure and risk notification documents

Key Behaviors

  • Upsert pattern: Uploading a document with the same type as an existing one replaces the previous version.
  • Max file size: 100 MB.
  • Node hierarchy: You can only access documents from your node or child nodes.
  • Soft delete: Deleted documents are marked as deleted but the S3 file is retained for audit purposes.

Endpoints

MethodPathDescription
POST/v1/documentsUpload a document
GET/v1/documentsList documents
GET/v1/documents/{document_id}Get document metadata
GET/v1/documents/{document_id}/downloadDownload document file
DELETE/v1/documents/{document_id}Delete a document