FinLego for developers
  1. Clients
FinLego for developers
  • FinLego Core Banking
    • Services REST API
      • ClientProfile - FrontOffice
        • Client
          • /Client
          • /Client/deletion-notifications
      • ClientProfile - System
        • Clients
          • /internal/Clients
            POST
          • /internal/Clients
            GET
          • /internal/Clients/{clientId}/block
            PUT
          • /internal/Clients/{clientId}/unblock
            PUT
          • /internal/Clients/{clientId}
            PUT
          • /internal/Clients/{clientId}
            GET
        • 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. Clients

/internal/Clients

GET
/internal/Clients
Clients

Request

Query Params
ClientId
string <uuid>
deprecated
OnboardingId
string <uuid>
optional
Type
enum<string> 
optional
Allowed values:
companyindividual
Status
enum<string> 
optional
Allowed values:
inactiveactiveblocked
Email
string 
optional
FirstName
string 
deprecated
LastName
string 
deprecated
LegalName
string 
deprecated
Name
string 
optional
ClientIds
array[string <uuid>]
optional
PageNumber
integer <int32>
optional
>= 1
PageSize
integer <int32>
optional
>= 1

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 '/internal/Clients'

Responses

🟢200OK
application/json
Body
isFailed
boolean 
read-onlyoptional
isSuccess
boolean 
read-onlyoptional
reasons
array[object (IReason) {2}]  | null 
read-onlyoptional
message
string  | null 
read-onlyoptional
metadata
object  | null 
read-onlyoptional
errors
array[object (IError) {3}]  | null 
read-onlyoptional
message
string  | null 
read-onlyoptional
metadata
object  | null 
read-onlyoptional
reasons
array[object (IError) {3}]  | null 
read-onlyoptional
successes
array[object (ISuccess) {2}]  | null 
read-onlyoptional
message
string  | null 
read-onlyoptional
metadata
object  | null 
read-onlyoptional
valueOrDefault
ClientDtoPagedDataDto
optional
data
array[null (ClientCompanyDto) {2}] 
optional
page
object 
PageInfoDto
optional
value
ClientDtoPagedDataDto
optional
One of
data
array[null (ClientCompanyDto) {2}] 
optional
page
object 
PageInfoDto
optional
Example
{
    "isFailed": true,
    "isSuccess": true,
    "reasons": [
        {
            "message": "string",
            "metadata": {
                "property1": null,
                "property2": null
            }
        }
    ],
    "errors": [
        {
            "message": "string",
            "metadata": {
                "property1": null,
                "property2": null
            },
            "reasons": [
                {}
            ]
        }
    ],
    "successes": [
        {
            "message": "string",
            "metadata": {
                "property1": null,
                "property2": null
            }
        }
    ],
    "valueOrDefault": {
        "data": [
            {
                "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,
                "legalName": "string",
                "companyRegistrationDate": "2019-08-24",
                "countryOfRegistration": "string",
                "taxResidencyCountry": "string",
                "registrationNumber": "string",
                "industry": "accountingOrConsultingOrLegalServices",
                "industryOther": "string",
                "turnover": "bellow100KEur",
                "webSite": "string",
                "taxNumber": "string",
                "payInsCountries": [
                    "uk"
                ],
                "payOutsCountries": [
                    "uk"
                ],
                "isEngagedGambling10K": true,
                "isFoundation": true,
                "isPubliclyListed": true,
                "isRelevantActivity": true,
                "purposesAccountOpening": [
                    "administrativeAndOperationalExpenses"
                ],
                "purposesAccountOpeningOther": "string",
                "businessPartners": [
                    {
                        "name": "string",
                        "incorporationCountryCode": "string",
                        "plannedTransfersQuantityMonth": 0,
                        "plannedTransfersEurVolumeMonth": 0,
                        "additionalInfo": "string",
                        "basisPartnership": "string",
                        "website": "string"
                    }
                ],
                "fundFlows": {
                    "plannedIncomingTransfersQuantity": 0,
                    "plannedIncomingTransfersEurVolume": 0,
                    "plannedOutboundTransfersQuantity": 0,
                    "plannedOutboundTransfersEurVolume": 0
                },
                "complianceEvaluation": {
                    "reviewPeriodicity": "string",
                    "appliedLimits": "string",
                    "additionalInfo": "string"
                },
                "customOptions": null,
                "relatedIndividuals": [
                    {
                        "firstName": "Ivan",
                        "lastName": "Ivanov",
                        "email": "test@local.com",
                        "isUbo": true,
                        "isShareholder": false,
                        "isDirector": false,
                        "isRepresentative": false,
                        "isPep": false,
                        "residenceCountry": "RU",
                        "citizenshipCountry": "RU",
                        "birthDate": "2019-08-24",
                        "ownership": 0,
                        "document": {
                            "issuedBy": "string",
                            "expirationDate": "2019-08-24",
                            "type": "passport",
                            "number": "string",
                            "issuedCountryCode": "string",
                            "issuedDate": "2019-08-24"
                        },
                        "beneficialOwnerPepDetails": "string",
                        "usaTaxResidency": true,
                        "giinNumber": "string",
                        "residentialAddress": {
                            "streetLine1": "string",
                            "streetLine2": "string",
                            "city": "string",
                            "state": "string",
                            "zip": "string",
                            "country": "string"
                        },
                        "applicantId": "fc65ce03-c5e6-455c-b628-f1607e292785",
                        "percentageOwnership": 0
                    }
                ],
                "companyType": "soleTrader"
            }
        ],
        "page": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalRecords": 0,
            "totalPages": 0
        }
    },
    "value": {
        "data": [
            {
                "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,
                "legalName": "string",
                "companyRegistrationDate": "2019-08-24",
                "countryOfRegistration": "string",
                "taxResidencyCountry": "string",
                "registrationNumber": "string",
                "industry": "accountingOrConsultingOrLegalServices",
                "industryOther": "string",
                "turnover": "bellow100KEur",
                "webSite": "string",
                "taxNumber": "string",
                "payInsCountries": [
                    "uk"
                ],
                "payOutsCountries": [
                    "uk"
                ],
                "isEngagedGambling10K": true,
                "isFoundation": true,
                "isPubliclyListed": true,
                "isRelevantActivity": true,
                "purposesAccountOpening": [
                    "administrativeAndOperationalExpenses"
                ],
                "purposesAccountOpeningOther": "string",
                "businessPartners": [
                    {
                        "name": "string",
                        "incorporationCountryCode": "string",
                        "plannedTransfersQuantityMonth": 0,
                        "plannedTransfersEurVolumeMonth": 0,
                        "additionalInfo": "string",
                        "basisPartnership": "string",
                        "website": "string"
                    }
                ],
                "fundFlows": {
                    "plannedIncomingTransfersQuantity": 0,
                    "plannedIncomingTransfersEurVolume": 0,
                    "plannedOutboundTransfersQuantity": 0,
                    "plannedOutboundTransfersEurVolume": 0
                },
                "complianceEvaluation": {
                    "reviewPeriodicity": "string",
                    "appliedLimits": "string",
                    "additionalInfo": "string"
                },
                "customOptions": null,
                "relatedIndividuals": [
                    {
                        "firstName": "Ivan",
                        "lastName": "Ivanov",
                        "email": "test@local.com",
                        "isUbo": true,
                        "isShareholder": false,
                        "isDirector": false,
                        "isRepresentative": false,
                        "isPep": false,
                        "residenceCountry": "RU",
                        "citizenshipCountry": "RU",
                        "birthDate": "2019-08-24",
                        "ownership": 0,
                        "document": {
                            "issuedBy": "string",
                            "expirationDate": "2019-08-24",
                            "type": "passport",
                            "number": "string",
                            "issuedCountryCode": "string",
                            "issuedDate": "2019-08-24"
                        },
                        "beneficialOwnerPepDetails": "string",
                        "usaTaxResidency": true,
                        "giinNumber": "string",
                        "residentialAddress": {
                            "streetLine1": "string",
                            "streetLine2": "string",
                            "city": "string",
                            "state": "string",
                            "zip": "string",
                            "country": "string"
                        },
                        "applicantId": "fc65ce03-c5e6-455c-b628-f1607e292785",
                        "percentageOwnership": 0
                    }
                ],
                "companyType": "soleTrader"
            }
        ],
        "page": {
            "pageNumber": 0,
            "pageSize": 0,
            "totalRecords": 0,
            "totalPages": 0
        }
    }
}
Previous
/internal/Clients
Next
/internal/Clients/{clientId}/block
Built with