- Introduction
- Accounts
- Auth
- Clients
- Onboards a client using the JSON fields returned by the client creation fields endpoint.POST
- Returns the paged list of clients, optionally filteredGET
- Returns the OpenAPI 3.0 creation schema for the authenticated brand and requested type.GET
- Returns a client by its identifierGET
- Returns the current client onboarding or profile stateGET
- Onboards a client using the JSON fields returned by the client creation fields endpoint.
- ExchangeRates
- Transfers
- Webhooks
- Registers (or replaces) the URL webhooks are delivered to for the integratorPOST
- Returns the currently registered webhook URL for the integratorGET
- Returns the paged list of webhook deliveries, filtered by the provided filterGET
- Returns a webhook delivery by its identifierGET
- Re-queues a failed webhook delivery for another attemptPOST
- Registers (or replaces) the URL webhooks are delivered to for the integrator
- IncomingTransfers
- TransferDocuments
- 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
- BaaS API
Returns the current client onboarding or profile state
GET
/baas/Clients/{id}/state
Request
Authorization
JWT Bearer
Add the parameter
Authorization
to HeadersExample:
Authorization: ********************or
Path 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//state' \
--header 'Authorization: Bearer <token>'Responses
🟢200
application/json
Bodyapplication/json
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"state": "pending"
}🟠400
🟠404
🟠422
🔴500
Modified at 2026-09-21 17:52:32