1. Guides
Framnex for Developers
  • Introduction
    • Overview
    • Quick Start
    • Authentication
    • Environments
  • Guides
    • Create an outgoing transfer
    • Handle webhooks
    • Transfer documents
  • ClientIntegrationAccounts
    • Returns an account by its identifier
      GET
    • Returns the paged list of accounts
      GET
  • ClientIntegrationAuth
    • Obtain an access token using client credentials.
      POST
  • ClientIntegrationExchangeRates
    • Returns the exchange rate between the sell and buy accounts
      GET
  • ClientIntegrationTransfers
    • Creates a new outgoing transfer
      POST
    • Returns the paged list of transfers, filtered by the provided filter
      GET
    • Returns a transfer by its identifier
      GET
  • ClientIntegrationWebhooks
    • Registers (or replaces) the URL webhooks are delivered to for the integrator
      POST
    • Returns the currently registered webhook URL for the integrator
      GET
    • Returns the paged list of webhook deliveries, filtered by the provided filter
      GET
    • Returns a webhook delivery by its identifier
      GET
    • Re-queues a failed webhook delivery for another attempt
      POST
  • ClientIntegrationTransferDocuments
    • Downloads a document by its file name.
      GET
    • Gets all documents
      GET
    • Uploads multiple documents.
      POST
  • Schemas
    • BankClientAPI
      • Account
      • AccountCredentials
      • AccountState
      • AccountType
      • AchCredentials
      • Address
      • BankDetails
      • BusinessEntity
      • ClientIntegrationAuthRequest
      • ClientIntegrationAuthResponse
      • ClientIntegrationErrorResponse
      • CreateExchangeTransferRequest
      • CreateOutgoingTransferRequest
      • CreateTransferRequest
      • CreateTransferType
      • CreatedResponse
      • Credentials
      • CredentialsState
      • CryptoCredentials
      • CustomerTransferStateDto
      • CryptoTransferDetails
      • ExchangeRate
      • DocumentDto
      • FasterUkCredentials
      • ExchangeTransferCancelledWebhookPayload
      • ExchangeTransfer
      • FedWireCredentials
      • IndividualEntity
      • ExchangeTransferExecutedWebhookPayload
      • InternalCredentials
      • InternalServerError
      • IError
      • LegalEntity
      • GasPaymentWebhookPayload
      • IReason
      • LegalEntityType
      • ISuccess
      • LocalAEDCredentials
      • LocalXafCredentials
      • IncomingTransferReceivedWebhookPayload
      • IncomingTransfer
      • NeftCredentials
      • OperationTypeDto
      • PageInfoDto
      • Participant
      • PixCredentials
      • SepaCredentials
      • SortOrderDto
      • SwiftCredentials
      • OutgoingTransferCancelledWebhookPayload
      • OutgoingTransfer
      • TedPayCredentials
      • OutgoingTransferExecutedWebhookPayload
      • PagedFilterDto
      • TransferGas
      • TransferPagedDataDto
      • TransferState
      • TransferType
      • PaymentMethod
      • TransferTypeDto
      • PaymentSystem
      • UaeFtsCredentials
      • RegisterWebhookRequest
      • UaeIppCredentials
      • Result
      • ValidationProblemDetails
      • ProblemDetails
      • YeePayNgnLocalCredentials
      • Transfer
      • TransferDetails
      • TransferDetailsType
      • WebhookDelivery
      • WebhookDeliveryPagedDataDto
      • WebhookPayload
      • WebhookState
      • WebhookSubscription
      • WebhookType
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
GuidesBaaS API ReferenceBank Client API Reference
GuidesBaaS API ReferenceBank Client API Reference
  1. Guides

Transfer documents

Use the transfer document endpoints to upload, list, and download supporting files associated with Bank Client API transfer flows.

When to use transfer documents#

Use these endpoints when a transfer process requires supporting documentation. The exact business requirement depends on the transfer and the current API flow; use the transfer reference and your Framnex implementation guidance to determine when documents are required.

Upload documents#

Use the upload endpoint to attach multiple files:
Upload transfer documents
Current documented constraints are:
up to 5 MB per file;
up to 12 MB total across all files in one upload.
Validate file sizes before sending the request so oversized files can be rejected in your application before upload.

List documents#

Retrieve the documents available for the transfer flow:
List transfer documents
Use the returned document metadata to keep your application state aligned with Framnex.

Download a document#

Download a document by its file name:
Download a transfer document
Treat downloaded files according to your own access-control and data-retention requirements.
Modified at 2026-09-26 19:17:25
Previous
Handle webhooks
Next
Returns an account by its identifier
Built with