# Framnex for Developers ## Docs - [Home](https://developer.framnex.com/2436216m0.md): - Introduction [Overview](https://developer.framnex.com/2436223m0.md): - Introduction [Quick Start](https://developer.framnex.com/2436299m0.md): - Introduction [Authentication](https://developer.framnex.com/2437454m0.md): - Introduction [Overview](https://developer.framnex.com/2436225m0.md): - Introduction [Quick Start](https://developer.framnex.com/2436301m0.md): - Introduction [Authentication](https://developer.framnex.com/2437457m0.md): ## API Docs - Accounts [Opens a new account for a client](https://developer.framnex.com/37243417e0.md): - Accounts [Returns the paged list of accounts, optionally filtered by client](https://developer.framnex.com/37243418e0.md): - Accounts [Returns an account by its identifier](https://developer.framnex.com/37243419e0.md): - Auth [Exchanges integrator client credentials for an access token.](https://developer.framnex.com/37243420e0.md): - Clients [Onboards a client using the JSON fields returned by the client creation fields endpoint.](https://developer.framnex.com/37243421e0.md): - Clients [Returns the paged list of clients, optionally filtered](https://developer.framnex.com/43960500e0.md): - Clients [Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.](https://developer.framnex.com/43960501e0.md): - Clients [Returns a client by its identifier](https://developer.framnex.com/43960502e0.md): - Clients [Returns the current client onboarding or profile state](https://developer.framnex.com/43960503e0.md): - ExchangeRates [Returns the exchange rate between the sell and buy accounts](https://developer.framnex.com/37243422e0.md): - Transfers [Creates a new outgoing transfer](https://developer.framnex.com/37243423e0.md): - Transfers [Returns the paged list of transfers, filtered by the provided filter](https://developer.framnex.com/37243424e0.md): - Transfers [Returns a transfer by its identifier](https://developer.framnex.com/37243425e0.md): - Webhooks [Registers (or replaces) the URL webhooks are delivered to for the integrator](https://developer.framnex.com/37243426e0.md): - Webhooks [Returns the currently registered webhook URL for the integrator](https://developer.framnex.com/37243427e0.md): - Webhooks [Returns the paged list of webhook deliveries, filtered by the provided filter](https://developer.framnex.com/37243428e0.md): - Webhooks [Returns a webhook delivery by its identifier](https://developer.framnex.com/37243429e0.md): - Webhooks [Re-queues a failed webhook delivery for another attempt](https://developer.framnex.com/37243430e0.md): - IncomingTransfers [Creates (simulates) an incoming transfer](https://developer.framnex.com/43960504e0.md): - TransferDocuments [Downloads a document by its file name.](https://developer.framnex.com/43960505e0.md): - TransferDocuments [Gets all documents](https://developer.framnex.com/43960506e0.md): - TransferDocuments [Uploads multiple documents.](https://developer.framnex.com/43960507e0.md): Constraints: up to 5 MB per file, up to 12 MB in total for all files; - ClientIntegrationAccounts [Returns an account by its identifier](https://developer.framnex.com/39566165e0.md): - ClientIntegrationAccounts [Returns the paged list of accounts](https://developer.framnex.com/39566166e0.md): - ClientIntegrationAuth [Obtain an access token using client credentials.](https://developer.framnex.com/39566167e0.md): This endpoint authenticates the client using their credentials and returns a bearer token. - ClientIntegrationExchangeRates [Returns the exchange rate between the sell and buy accounts](https://developer.framnex.com/39566168e0.md): - ClientIntegrationTransfers [Creates a new outgoing transfer](https://developer.framnex.com/39566169e0.md): - ClientIntegrationTransfers [Returns the paged list of transfers, filtered by the provided filter](https://developer.framnex.com/39566170e0.md): - ClientIntegrationTransfers [Returns a transfer by its identifier](https://developer.framnex.com/39566171e0.md): - ClientIntegrationWebhooks [Registers (or replaces) the URL webhooks are delivered to for the integrator](https://developer.framnex.com/40620056e0.md): - ClientIntegrationWebhooks [Returns the currently registered webhook URL for the integrator](https://developer.framnex.com/40620057e0.md): - ClientIntegrationWebhooks [Returns the paged list of webhook deliveries, filtered by the provided filter](https://developer.framnex.com/40620058e0.md): - ClientIntegrationWebhooks [Returns a webhook delivery by its identifier](https://developer.framnex.com/40620059e0.md): - ClientIntegrationWebhooks [Re-queues a failed webhook delivery for another attempt](https://developer.framnex.com/40620060e0.md): - ClientIntegrationTransferDocuments [Downloads a document by its file name.](https://developer.framnex.com/42021416e0.md): - ClientIntegrationTransferDocuments [Gets all documents](https://developer.framnex.com/42021417e0.md): - ClientIntegrationTransferDocuments [Uploads multiple documents.](https://developer.framnex.com/42021418e0.md): Constraints: up to 5 MB per file, up to 12 MB in total for all files; ## Schemas - BaaS API [Account](https://developer.framnex.com/15522980d0.md): - BaaS API [AccountCredentials](https://developer.framnex.com/15522981d0.md): - BaaS API [AccountOpenedWebhookPayload](https://developer.framnex.com/15522982d0.md): - BaaS API [AccountOpeningFailedWebhookPayload](https://developer.framnex.com/15522983d0.md): - BaaS API [AccountPagedDataDto](https://developer.framnex.com/15522984d0.md): - BaaS API [AccountState](https://developer.framnex.com/15522985d0.md): - BaaS API [AccountType](https://developer.framnex.com/15522986d0.md): - BaaS API [AchCredentials](https://developer.framnex.com/15522987d0.md): - BaaS API [Address](https://developer.framnex.com/15522988d0.md): - BaaS API [AuthTokenRequest](https://developer.framnex.com/15522989d0.md): - BaaS API [AuthTokenResponse](https://developer.framnex.com/15522990d0.md): - BaaS API [BankDetails](https://developer.framnex.com/15522991d0.md): - BaaS API [BusinessClient](https://developer.framnex.com/17806893d0.md): - BaaS API [BusinessEntity](https://developer.framnex.com/15522992d0.md): - BaaS API [Client](https://developer.framnex.com/17806894d0.md): - BaaS API [CreateBusinessClientRequest](https://developer.framnex.com/15522994d0.md): - BaaS API [ClientCreateType](https://developer.framnex.com/17806895d0.md): - BaaS API [CreateClientRequest](https://developer.framnex.com/15522995d0.md): - BaaS API [ClientCreatedResponse](https://developer.framnex.com/17806896d0.md): - BaaS API [ClientPagedDataDto](https://developer.framnex.com/17806897d0.md): - BaaS API [CreateIndividualClientRequest](https://developer.framnex.com/15522997d0.md): - BaaS API [ClientState](https://developer.framnex.com/17806898d0.md): - BaaS API [ClientStateResponse](https://developer.framnex.com/17806899d0.md): - BaaS API [ClientType](https://developer.framnex.com/17806900d0.md): - BaaS API [ClientsFilter](https://developer.framnex.com/17806901d0.md): - BaaS API [CreateAccountRequest](https://developer.framnex.com/15522993d0.md): - BaaS API [CreateExchangeTransferRequest](https://developer.framnex.com/15522996d0.md): - BaaS API [CreateIncomingTransferRequest](https://developer.framnex.com/17806902d0.md): - BaaS API [CreateOutgoingTransferRequest](https://developer.framnex.com/15522998d0.md): - BaaS API [CredentialsState](https://developer.framnex.com/15523004d0.md): - BaaS API [CreateTransferRequest](https://developer.framnex.com/15522999d0.md): - BaaS API [ErrorDetailsDto](https://developer.framnex.com/15523005d0.md): - BaaS API [ExchangeRate](https://developer.framnex.com/15523006d0.md): - BaaS API [CreateTransferType](https://developer.framnex.com/17806903d0.md): - BaaS API [CreatedResponse](https://developer.framnex.com/15523000d0.md): - BaaS API [Credentials](https://developer.framnex.com/15523001d0.md): - BaaS API [CredentialsIssueFailedWebhookPayload](https://developer.framnex.com/15523002d0.md): - BaaS API [CredentialsIssuedWebhookPayload](https://developer.framnex.com/15523003d0.md): - BaaS API [ExchangeTransferProcessingWebhookPayload](https://developer.framnex.com/15523010d0.md): - BaaS API [CryptoCredentials](https://developer.framnex.com/17806904d0.md): - BaaS API [IError](https://developer.framnex.com/15523013d0.md): - BaaS API [CryptoTransferDetails](https://developer.framnex.com/17806905d0.md): - BaaS API [IReason](https://developer.framnex.com/15523014d0.md): - BaaS API [DocumentDto](https://developer.framnex.com/17806906d0.md): - BaaS API [ISuccess](https://developer.framnex.com/15523015d0.md): - BaaS API [IdentificationDocument](https://developer.framnex.com/15523016d0.md): - BaaS API [ExchangeTransfer](https://developer.framnex.com/15523007d0.md): - BaaS API [IdentificationDocumentType](https://developer.framnex.com/15523017d0.md): - BaaS API [ExchangeTransferCancelledWebhookPayload](https://developer.framnex.com/15523008d0.md): - BaaS API [ExchangeTransferExecutedWebhookPayload](https://developer.framnex.com/15523009d0.md): - BaaS API [FasterUkCredentials](https://developer.framnex.com/15523011d0.md): - BaaS API [FedWireCredentials](https://developer.framnex.com/15523012d0.md): - BaaS API [ForeignTransferParty](https://developer.framnex.com/17806907d0.md): - BaaS API [GasPaymentWebhookPayload](https://developer.framnex.com/17806908d0.md): - BaaS API [IncomingTransfer](https://developer.framnex.com/15523018d0.md): - BaaS API [IncomingTransferReceivedWebhookPayload](https://developer.framnex.com/15523019d0.md): - BaaS API [OutgoingTransferProcessingWebhookPayload](https://developer.framnex.com/15523031d0.md): - BaaS API [IndividualClient](https://developer.framnex.com/17806909d0.md): - BaaS API [IndividualEntity](https://developer.framnex.com/15523020d0.md): - BaaS API [PageInfoDto](https://developer.framnex.com/15523032d0.md): - BaaS API [InternalCredentials](https://developer.framnex.com/15523021d0.md): - BaaS API [Participant](https://developer.framnex.com/15523033d0.md): - BaaS API [LegalEntity](https://developer.framnex.com/15523022d0.md): - BaaS API [LegalEntityType](https://developer.framnex.com/17806910d0.md): - BaaS API [LocalAEDCredentials](https://developer.framnex.com/15523023d0.md): - BaaS API [ProblemDetails](https://developer.framnex.com/15523036d0.md): - BaaS API [LocalXafCredentials](https://developer.framnex.com/15523024d0.md): - BaaS API [NeftCredentials](https://developer.framnex.com/15523025d0.md): - BaaS API [Result](https://developer.framnex.com/15523038d0.md): - BaaS API [OnboardingCompletedWebhookPayload](https://developer.framnex.com/15523026d0.md): - BaaS API [RiskLevel](https://developer.framnex.com/15523039d0.md): - BaaS API [OnboardingFailedWebhookPayload](https://developer.framnex.com/15523027d0.md): - BaaS API [OutgoingTransfer](https://developer.framnex.com/15523028d0.md): - BaaS API [SortOrderDto](https://developer.framnex.com/15523041d0.md): - BaaS API [OutgoingTransferCancelledWebhookPayload](https://developer.framnex.com/15523029d0.md): - BaaS API [OutgoingTransferExecutedWebhookPayload](https://developer.framnex.com/15523030d0.md): - BaaS API [TransferPagedDataDto](https://developer.framnex.com/15523045d0.md): - BaaS API [PagedFilterDto](https://developer.framnex.com/17806911d0.md): - BaaS API [PaymentMethod](https://developer.framnex.com/15523034d0.md): - BaaS API [TransfersFilter](https://developer.framnex.com/15523047d0.md): - BaaS API [PixCredentials](https://developer.framnex.com/15523035d0.md): - BaaS API [RegisterWebhookRequest](https://developer.framnex.com/15523037d0.md): - BaaS API [ValidationProblemDetails](https://developer.framnex.com/15523050d0.md): - BaaS API [WebhookDelivery](https://developer.framnex.com/15523051d0.md): - BaaS API [WebhookDeliveryPagedDataDto](https://developer.framnex.com/15523052d0.md): - BaaS API [SepaCredentials](https://developer.framnex.com/15523040d0.md): - BaaS API [SortDto](https://developer.framnex.com/17806912d0.md): - BaaS API [WebhookSubscription](https://developer.framnex.com/15523055d0.md): - BaaS API [SwiftCredentials](https://developer.framnex.com/15523042d0.md): - BaaS API [TedPayCredentials](https://developer.framnex.com/15523043d0.md): - BaaS API [WebhooksFilter](https://developer.framnex.com/15523057d0.md): - BaaS API [Transfer](https://developer.framnex.com/15523044d0.md): - BaaS API [TransferDetails](https://developer.framnex.com/17806913d0.md): - BaaS API [TransferDetailsType](https://developer.framnex.com/17806914d0.md): - BaaS API [TransferGas](https://developer.framnex.com/17806915d0.md): - BaaS API [TransferState](https://developer.framnex.com/15523046d0.md): - BaaS API [TransferType](https://developer.framnex.com/17806916d0.md): - BaaS API [UaeFtsCredentials](https://developer.framnex.com/15523048d0.md): - BaaS API [UaeIppCredentials](https://developer.framnex.com/15523049d0.md): - BaaS API [WebhookPayload](https://developer.framnex.com/15523053d0.md): - BaaS API [WebhookState](https://developer.framnex.com/15523054d0.md): - BaaS API [WebhookType](https://developer.framnex.com/15523056d0.md): - BaaS API [YeePayKesLocalCredentials](https://developer.framnex.com/17806917d0.md): - BaaS API [YeePayMxnLocalCredentials](https://developer.framnex.com/17806918d0.md): - BaaS API [YeePayNgnLocalCredentials](https://developer.framnex.com/17806919d0.md): - BankClientAPI [Account](https://developer.framnex.com/16268491d0.md): - BankClientAPI [AccountCredentials](https://developer.framnex.com/16268492d0.md): - BankClientAPI [AccountState](https://developer.framnex.com/16268493d0.md): - BankClientAPI [AccountType](https://developer.framnex.com/16300056d0.md): - BankClientAPI [AchCredentials](https://developer.framnex.com/16300057d0.md): - BankClientAPI [Address](https://developer.framnex.com/16300058d0.md): - BankClientAPI [BankDetails](https://developer.framnex.com/16268494d0.md): - BankClientAPI [BusinessEntity](https://developer.framnex.com/16300059d0.md): - BankClientAPI [ClientIntegrationAuthRequest](https://developer.framnex.com/16268495d0.md): - BankClientAPI [ClientIntegrationAuthResponse](https://developer.framnex.com/16268496d0.md): - BankClientAPI [ClientIntegrationErrorResponse](https://developer.framnex.com/16268497d0.md): - BankClientAPI [CreateExchangeTransferRequest](https://developer.framnex.com/16300060d0.md): - BankClientAPI [CreateOutgoingTransferRequest](https://developer.framnex.com/16300061d0.md): - BankClientAPI [CreateTransferRequest](https://developer.framnex.com/16268498d0.md): - BankClientAPI [CreateTransferType](https://developer.framnex.com/16268499d0.md): - BankClientAPI [CreatedResponse](https://developer.framnex.com/16268500d0.md): - BankClientAPI [Credentials](https://developer.framnex.com/16268501d0.md): - BankClientAPI [CredentialsState](https://developer.framnex.com/16268502d0.md): - BankClientAPI [CryptoCredentials](https://developer.framnex.com/16667357d0.md): - BankClientAPI [CustomerTransferStateDto](https://developer.framnex.com/16268503d0.md): - BankClientAPI [CryptoTransferDetails](https://developer.framnex.com/17133079d0.md): - BankClientAPI [ExchangeRate](https://developer.framnex.com/16268504d0.md): - BankClientAPI [DocumentDto](https://developer.framnex.com/17133080d0.md): - BankClientAPI [FasterUkCredentials](https://developer.framnex.com/16300063d0.md): - BankClientAPI [ExchangeTransferCancelledWebhookPayload](https://developer.framnex.com/16667358d0.md): - BankClientAPI [ExchangeTransfer](https://developer.framnex.com/16300062d0.md): - BankClientAPI [FedWireCredentials](https://developer.framnex.com/16300064d0.md): - BankClientAPI [IndividualEntity](https://developer.framnex.com/16300066d0.md): - BankClientAPI [ExchangeTransferExecutedWebhookPayload](https://developer.framnex.com/16667359d0.md): - BankClientAPI [InternalCredentials](https://developer.framnex.com/16300067d0.md): - BankClientAPI [InternalServerError](https://developer.framnex.com/16268505d0.md): - BankClientAPI [IError](https://developer.framnex.com/16667361d0.md): - BankClientAPI [LegalEntity](https://developer.framnex.com/16300068d0.md): - BankClientAPI [GasPaymentWebhookPayload](https://developer.framnex.com/16667360d0.md): - BankClientAPI [IReason](https://developer.framnex.com/16667362d0.md): - BankClientAPI [LegalEntityType](https://developer.framnex.com/16300069d0.md): - BankClientAPI [ISuccess](https://developer.framnex.com/16667363d0.md): - BankClientAPI [LocalAEDCredentials](https://developer.framnex.com/16300070d0.md): - BankClientAPI [LocalXafCredentials](https://developer.framnex.com/16300071d0.md): - BankClientAPI [IncomingTransferReceivedWebhookPayload](https://developer.framnex.com/16667364d0.md): - BankClientAPI [IncomingTransfer](https://developer.framnex.com/16300065d0.md): - BankClientAPI [NeftCredentials](https://developer.framnex.com/16300072d0.md): - BankClientAPI [OperationTypeDto](https://developer.framnex.com/16268506d0.md): - BankClientAPI [PageInfoDto](https://developer.framnex.com/16268507d0.md): - BankClientAPI [Participant](https://developer.framnex.com/16300074d0.md): - BankClientAPI [PixCredentials](https://developer.framnex.com/16300075d0.md): - BankClientAPI [SepaCredentials](https://developer.framnex.com/16300076d0.md): - BankClientAPI [SortOrderDto](https://developer.framnex.com/16268510d0.md): - BankClientAPI [SwiftCredentials](https://developer.framnex.com/16300077d0.md): - BankClientAPI [OutgoingTransferCancelledWebhookPayload](https://developer.framnex.com/16667365d0.md): - BankClientAPI [OutgoingTransfer](https://developer.framnex.com/16300073d0.md): - BankClientAPI [TedPayCredentials](https://developer.framnex.com/16300078d0.md): - BankClientAPI [OutgoingTransferExecutedWebhookPayload](https://developer.framnex.com/16667366d0.md): - BankClientAPI [PagedFilterDto](https://developer.framnex.com/16667367d0.md): - BankClientAPI [TransferGas](https://developer.framnex.com/16667370d0.md): - BankClientAPI [TransferPagedDataDto](https://developer.framnex.com/16268512d0.md): - BankClientAPI [TransferState](https://developer.framnex.com/16300079d0.md): - BankClientAPI [TransferType](https://developer.framnex.com/16268513d0.md): - BankClientAPI [PaymentMethod](https://developer.framnex.com/16268508d0.md): - BankClientAPI [TransferTypeDto](https://developer.framnex.com/16268514d0.md): - BankClientAPI [PaymentSystem](https://developer.framnex.com/16268509d0.md): - BankClientAPI [UaeFtsCredentials](https://developer.framnex.com/16300080d0.md): - BankClientAPI [RegisterWebhookRequest](https://developer.framnex.com/16667368d0.md): - BankClientAPI [UaeIppCredentials](https://developer.framnex.com/16300081d0.md): - BankClientAPI [Result](https://developer.framnex.com/16667369d0.md): - BankClientAPI [ValidationProblemDetails](https://developer.framnex.com/16268515d0.md): - BankClientAPI [ProblemDetails](https://developer.framnex.com/17133081d0.md): - BankClientAPI [YeePayNgnLocalCredentials](https://developer.framnex.com/16667377d0.md): - BankClientAPI [Transfer](https://developer.framnex.com/16268511d0.md): - BankClientAPI [TransferDetails](https://developer.framnex.com/17133082d0.md): - BankClientAPI [TransferDetailsType](https://developer.framnex.com/17133083d0.md): - BankClientAPI [WebhookDelivery](https://developer.framnex.com/16667371d0.md): - BankClientAPI [WebhookDeliveryPagedDataDto](https://developer.framnex.com/16667372d0.md): - BankClientAPI [WebhookPayload](https://developer.framnex.com/16667373d0.md): - BankClientAPI [WebhookState](https://developer.framnex.com/16667374d0.md): - BankClientAPI [WebhookSubscription](https://developer.framnex.com/16667375d0.md): - BankClientAPI [WebhookType](https://developer.framnex.com/16667376d0.md): - BankClientAPI [YeePayKesLocalCredentials](https://developer.framnex.com/17133084d0.md): - BankClientAPI [YeePayMxnLocalCredentials](https://developer.framnex.com/17133085d0.md):