FinLego for developers
  1. Client
FinLego for developers
  • FinLego Core Banking
    • Services REST API
      • ClientProfile - FrontOffice
        • Client
          • /Client
            GET
          • /Client/deletion-notifications
            POST
      • ClientProfile - System
        • Clients
          • /internal/Clients
          • /internal/Clients
          • /internal/Clients/{clientId}/block
          • /internal/Clients/{clientId}/unblock
          • /internal/Clients/{clientId}
          • /internal/Clients/{clientId}
        • Documents
          • /internal/Clients/{clientId}/Documents/upload
          • /internal/Clients/{clientId}/Documents/{documentId}/download
          • /internal/Clients/{clientId}/Documents
          • /internal/Clients/{clientId}/Documents/{documentId}
      • GeneralLedger - System (1)
        • Accounts
          • /Accounts
          • /v2/internal/Accounts
          • /Accounts
          • /v2/internal/Accounts/recalculate
          • /Accounts/{id}
          • /internal/Accounts/calculateBalances
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/{accountId}
          • /Accounts/{id}
          • /v2/ledger/internal/Accounts/search
          • /Accounts/send-otp
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
          • /Accounts/otp-verification
          • /Accounts/{accountNumber}
          • /Accounts/reorder-accounts
        • Transactions
          • Transactions by filter
          • /internal/Transactions/{id}
          • /internal/Transactions
          • /internal/Transactions/query
          • /internal/Transactions/report
        • BaasProvider
          • /BaasProvider/available-currencies
        • BackgroundJob
          • /internal/BackgroundJob/AccountBalanceCheckJob
        • DailyAccountBalance
          • /internal/DailyAccountBalance
          • /internal/DailyAccountBalance/recalculate
        • DailyCheck
          • /internal/DailyCheck
          • /internal/DailyCheck/details
        • Reports
          • /internal/Reports/ReconciliationReport
        • TreasuryManagement
          • /internal/TreasuryManagement/summary
        • Payments
          • Creates payment with single transaction and transfers money between accounts
          • Creates payment in Draft state without any money transfers
          • Pends payment and holds funds in case of withdrawals
          • Posts payment, withdraws held funds and deposits it to corresponding account
          • Cancels payment and performs payback in case of held
      • GeneralLedger - System (2)
        • Accounts
          • /v2/internal/Accounts
          • /v2/internal/Accounts/recalculate
          • /internal/Accounts/calculateBalances
          • /v2/ledger/internal/Accounts/{accountId}
          • /v2/ledger/internal/Accounts
          • /v2/ledger/internal/Accounts/getAggregatedAmounts
        • Payments
          • Creates payment with single transaction and transfers money between accounts
          • Creates payment in Draft state without any money transfers
          • Pends payment and holds funds in case of withdrawals
          • Posts payment, withdraws held funds and deposits it to corresponding account
          • Cancels payment and performs payback in case of held
      • TransferOrchestrator - FrontOffice
        • Confirmations
          • Generate a new confirmation code for the specified transfer.
        • Documents
          • Downloads a document by its file name.
        • Recipients
          • Fetch recipients based on the specified filters.
          • Fetch recipients based on the specified filters.
          • Add a recipient.
          • Fetch recipient details by the specified recipient identifier.
          • Fetch recipient details by the specified recipient identifier.
          • Update the visibility details of a recipient.
        • Transfers
          • Fetch transfers based on the specified filters.
          • Fetch transfers based on the specified filters.
          • Fetch transfer details by the specified transfer identifier.
          • Fetch transfer details by the specified transfer identifier.
          • Create an outgoing transfer.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Confirm an outgoing transfer.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Create a foreign exchange transfer.
          • Confirm an outgoing transfer.
          • Cancel an outgoing transfer by the transfer identifier.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Fetch a transfer type by recipient account and currency.
      • TransferOrchestrator - System (1)
        • Documents
          • Downloads a document by its file name and client identifier.
        • IncomingRequests
          • Fetch internal requests based on the specified filters.
          • process a transfer manually.
        • Recipients
          • Add a recipient.
        • Transfers
          • Fetch internal transfers based on the specified filters.
          • Fetch outgoing transfer details by the specified transfer identifier.
          • Fetch incoming transfer details by the specified transfer identifier.
          • Assign an unrecognized incoming transfer.
          • Fetch foreign exchange transfer details by the specified transfer identifier.
          • Execute a transfer manually.
          • Continue processing of an outgoing transfer.
          • Fetch outgoing transfers based on the specified filters.
          • Fetch incoming transfers based on the specified filters.
          • Fetch foreign exchange transfers based on the specified filters.
      • TransferOrchestrator - System (2)
        • Recipients
          • Add a system recipient.
        • Transfers
          • /internal/integration/Transfers/outgoing
          • /internal/integration/Transfers/outgoing/payment-request
  • Onboarding Integration
    • ClientsImport
      • Imports a new individual client from an integrated WL customer's onboarding system
      • Imports a new company client from an integrated WL customer's onboarding system
    • SumsubWebhooks
      • /integration/sumsub-webhooks/update-state
      • Simulates a verification response.
  1. Client

/Client

GET
/Client

Request

None

Request 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 --request GET '/Client'

Responses

🟢200OK
application/json
Body
id
string <uuid>
optional
type
enum<string> 
optional
Allowed values:
companyindividual
editorUserId
string <uuid>
optional
onboardingId
string <uuid>
optional
status
enum<string> 
optional
Allowed values:
inactiveactiveblocked
address
object (AddressDto) 
optional
streetLine1
string 
required
>= 1 characters<= 255 characters
streetLine2
string  | null 
optional
city
string 
required
>= 1 characters<= 255 characters
state
string  | null 
optional
<= 255 characters
zip
string 
required
>= 1 characters<= 255 characters
country
string  | null 
optional
phoneNumber
string 
optional
email
string  | null 
optional
created
string <date-time>
optional
riskLevel
integer <int32>
optional
isDefaultCompliant
boolean 
optional
firstName
string 
optional
lastName
string 
optional
citizenshipCountry
string 
optional
passportNumber
string 
optional
residenceCountry
string 
optional
dateOfBirth
string <date>
optional
document
object (IdentificationDocumentDto) 
optional
issuedBy
string  | null 
optional
expirationDate
string <date> | null 
optional
type
enum<string> 
optional
Allowed values:
passportdriverLicenseidCardother
number
string  | null 
optional
issuedCountryCode
string  | null 
optional
issuedDate
string <date> | null 
optional
Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "company",
    "editorUserId": "c5c2f4a5-c36d-4d4d-9e5c-2659c938a266",
    "onboardingId": "f4fce315-9b7c-4302-989a-521be9ec9bca",
    "status": "inactive",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string"
    },
    "phoneNumber": "string",
    "email": "string",
    "created": "2019-08-24T14:15:22Z",
    "riskLevel": 0,
    "isDefaultCompliant": true,
    "firstName": "string",
    "lastName": "string",
    "citizenshipCountry": "string",
    "passportNumber": "string",
    "residenceCountry": "string",
    "dateOfBirth": "2019-08-24",
    "document": {
        "issuedBy": "string",
        "expirationDate": "2019-08-24",
        "type": "passport",
        "number": "string",
        "issuedCountryCode": "string",
        "issuedDate": "2019-08-24"
    }
}
Modified at 2024-12-24 08:19:23
Next
/Client/deletion-notifications
Built with