1. Clients
Framnex for Developers
  • Introduction
    • Overview
    • Quick Start
  • Accounts
    • Opens a new account for a client
      POST
    • Returns the paged list of accounts, optionally filtered by client
      GET
    • Returns an account by its identifier
      GET
  • Auth
    • Exchanges integrator client credentials for an access token.
      POST
  • Clients
    • Onboards a client using the JSON fields returned by the client creation fields endpoint.
      POST
    • Returns the paged list of clients, optionally filtered
      GET
    • Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.
      GET
    • Returns a client by its identifier
      GET
    • Returns the current client onboarding or profile state
      GET
  • ExchangeRates
    • Returns the exchange rate between the sell and buy accounts
      GET
  • Transfers
    • 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
  • Webhooks
    • 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
  • IncomingTransfers
    • Creates (simulates) an incoming transfer
      POST
  • TransferDocuments
    • Downloads a document by its file name.
    • Gets all documents
    • Uploads multiple documents.
  • Schemas
    • BaaS API
      • Account
      • AccountCredentials
      • AccountOpenedWebhookPayload
      • AccountOpeningFailedWebhookPayload
      • AccountPagedDataDto
      • AccountState
      • AccountType
      • AchCredentials
      • Address
      • AuthTokenRequest
      • AuthTokenResponse
      • BankDetails
      • BusinessClient
      • BusinessEntity
      • Client
      • CreateBusinessClientRequest
      • ClientCreateType
      • CreateClientRequest
      • ClientCreatedResponse
      • ClientPagedDataDto
      • CreateIndividualClientRequest
      • ClientState
      • ClientStateResponse
      • ClientType
      • ClientsFilter
      • CreateAccountRequest
      • CreateExchangeTransferRequest
      • CreateIncomingTransferRequest
      • CreateOutgoingTransferRequest
      • CredentialsState
      • CreateTransferRequest
      • ErrorDetailsDto
      • ExchangeRate
      • CreateTransferType
      • CreatedResponse
      • Credentials
      • CredentialsIssueFailedWebhookPayload
      • CredentialsIssuedWebhookPayload
      • ExchangeTransferProcessingWebhookPayload
      • CryptoCredentials
      • IError
      • CryptoTransferDetails
      • IReason
      • DocumentDto
      • ISuccess
      • IdentificationDocument
      • ExchangeTransfer
      • IdentificationDocumentType
      • ExchangeTransferCancelledWebhookPayload
      • ExchangeTransferExecutedWebhookPayload
      • FasterUkCredentials
      • FedWireCredentials
      • ForeignTransferParty
      • GasPaymentWebhookPayload
      • IncomingTransfer
      • IncomingTransferReceivedWebhookPayload
      • OutgoingTransferProcessingWebhookPayload
      • IndividualClient
      • IndividualEntity
      • PageInfoDto
      • InternalCredentials
      • Participant
      • LegalEntity
      • LegalEntityType
      • LocalAEDCredentials
      • ProblemDetails
      • LocalXafCredentials
      • NeftCredentials
      • Result
      • OnboardingCompletedWebhookPayload
      • RiskLevel
      • OnboardingFailedWebhookPayload
      • OutgoingTransfer
      • SortOrderDto
      • OutgoingTransferCancelledWebhookPayload
      • OutgoingTransferExecutedWebhookPayload
      • TransferPagedDataDto
      • PagedFilterDto
      • PaymentMethod
      • TransfersFilter
      • PixCredentials
      • RegisterWebhookRequest
      • ValidationProblemDetails
      • WebhookDelivery
      • WebhookDeliveryPagedDataDto
      • SepaCredentials
      • SortDto
      • WebhookSubscription
      • SwiftCredentials
      • TedPayCredentials
      • WebhooksFilter
      • Transfer
      • TransferDetails
      • TransferDetailsType
      • TransferGas
      • TransferState
      • TransferType
      • UaeFtsCredentials
      • UaeIppCredentials
      • WebhookPayload
      • WebhookState
      • WebhookType
      • YeePayKesLocalCredentials
      • YeePayMxnLocalCredentials
      • YeePayNgnLocalCredentials
GuidesBaaS API Reference
Bank Client API Reference
GuidesBaaS API Reference
Bank Client API Reference
  1. Clients

Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.

GET
/baas/Clients/fields

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://my.test-1.account.finlego.com/api/child-brand-integration/baas/Clients/fields?type=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
OK
Bodyapplication/json

Example
null
🟠400
🟠404
🟠422
🔴500
Modified at 2026-09-21 17:52:32
Previous
Returns the paged list of clients, optionally filtered
Next
Returns a client by its identifier
Built with