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/{clientId}

GET
/internal/Clients/{clientId}

Request

Path Params
clientId
string <uuid>
required

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
ClientDto
optional
id
string <uuid>
optional
type
enum<string> 
ClientType
optional
Allowed values:
companyindividual
editorUserId
string <uuid>
optional
onboardingId
string <uuid>
optional
status
enum<string> 
ClientStatus
optional
Allowed values:
inactiveactiveblocked
address
object 
AddressDto
optional
phoneNumber
string 
optional
email
string  | null 
optional
created
string <date-time>
optional
riskLevel
integer <int32>
optional
isDefaultCompliant
boolean 
optional
legalName
string 
optional
companyRegistrationDate
string <date> | null 
optional
countryOfRegistration
string 
optional
taxResidencyCountry
string  | null 
optional
registrationNumber
string  | null 
optional
industry
enum<string> 
Industry
optional
Allowed values:
accountingOrConsultingOrLegalServicescharityOrSimilarNonProfitActivitiescyberlockersOrRemoteDigitalFileStoringdatingdrugsOrPharmaceuticalemiOrPiforexOrCfdOrCrowdfundinggamblingOrBettingOrLotteryinsuranceOrLendingServicesmarketingAndAdvertisingonlineGamingrealEstateretailsocialNetworksitsubscriptionOnPhysicalGoodDeliverytelecommunicationAndNetworktelemarketingtobaccoProductstradeInPreciousMetalsAndJewellerytransportationOrLogisticstravelOrLeisurevirtualAssetServicesother
industryOther
string  | null 
optional
turnover
enum<string> 
Turnover
optional
Allowed values:
bellow100KEurbetween100KAnd500KEurbetween500KAnd1000KEurbetween1000KAnd5000KEurabove5000KEur
webSite
string  | null 
optional
taxNumber
string  | null 
optional
payInsCountries
array[string] | null 
read-onlyoptional
Allowed values:
ukeeaother
payOutsCountries
array[string] | null 
read-onlyoptional
Allowed values:
ukeeaother
isEngagedGambling10K
boolean  | null 
read-onlyoptional
isFoundation
boolean  | null 
read-onlyoptional
isPubliclyListed
boolean  | null 
read-onlyoptional
isRelevantActivity
boolean  | null 
read-onlyoptional
purposesAccountOpening
array[string] | null 
read-onlyoptional
Allowed values:
administrativeAndOperationalExpensespaymentsToAndFromContractorsdepositsAndSavingspaymentCardProcessingother
purposesAccountOpeningOther
string  | null 
read-onlyoptional
businessPartners
array[object (BusinessPartnerDto) {7}]  | null 
optional
fundFlows
object 
FundFlowsDto
optional
complianceEvaluation
object 
ComplianceEvaluationDto
optional
customOptions
null 
optional
relatedIndividuals
array[object (RelatedIndividualInfoDto) {19}] 
optional
companyType
enum<string> 
CompanyType
optional
Allowed values:
soleTraderpartnershipprivatenonProfitcommunityInterestpublicinternationalNgo
value
ClientDto
optional
One of
id
string <uuid>
optional
type
enum<string> 
ClientType
optional
Allowed values:
companyindividual
editorUserId
string <uuid>
optional
onboardingId
string <uuid>
optional
status
enum<string> 
ClientStatus
optional
Allowed values:
inactiveactiveblocked
address
object 
AddressDto
optional
phoneNumber
string 
optional
email
string  | null 
optional
created
string <date-time>
optional
riskLevel
integer <int32>
optional
isDefaultCompliant
boolean 
optional
legalName
string 
optional
companyRegistrationDate
string <date> | null 
optional
countryOfRegistration
string 
optional
taxResidencyCountry
string  | null 
optional
registrationNumber
string  | null 
optional
industry
enum<string> 
Industry
optional
Allowed values:
accountingOrConsultingOrLegalServicescharityOrSimilarNonProfitActivitiescyberlockersOrRemoteDigitalFileStoringdatingdrugsOrPharmaceuticalemiOrPiforexOrCfdOrCrowdfundinggamblingOrBettingOrLotteryinsuranceOrLendingServicesmarketingAndAdvertisingonlineGamingrealEstateretailsocialNetworksitsubscriptionOnPhysicalGoodDeliverytelecommunicationAndNetworktelemarketingtobaccoProductstradeInPreciousMetalsAndJewellerytransportationOrLogisticstravelOrLeisurevirtualAssetServicesother
industryOther
string  | null 
optional
turnover
enum<string> 
Turnover
optional
Allowed values:
bellow100KEurbetween100KAnd500KEurbetween500KAnd1000KEurbetween1000KAnd5000KEurabove5000KEur
webSite
string  | null 
optional
taxNumber
string  | null 
optional
payInsCountries
array[string] | null 
read-onlyoptional
Allowed values:
ukeeaother
payOutsCountries
array[string] | null 
read-onlyoptional
Allowed values:
ukeeaother
isEngagedGambling10K
boolean  | null 
read-onlyoptional
isFoundation
boolean  | null 
read-onlyoptional
isPubliclyListed
boolean  | null 
read-onlyoptional
isRelevantActivity
boolean  | null 
read-onlyoptional
purposesAccountOpening
array[string] | null 
read-onlyoptional
Allowed values:
administrativeAndOperationalExpensespaymentsToAndFromContractorsdepositsAndSavingspaymentCardProcessingother
purposesAccountOpeningOther
string  | null 
read-onlyoptional
businessPartners
array[object (BusinessPartnerDto) {7}]  | null 
optional
fundFlows
object 
FundFlowsDto
optional
complianceEvaluation
object 
ComplianceEvaluationDto
optional
customOptions
null 
optional
relatedIndividuals
array[object (RelatedIndividualInfoDto) {19}] 
optional
companyType
enum<string> 
CompanyType
optional
Allowed values:
soleTraderpartnershipprivatenonProfitcommunityInterestpublicinternationalNgo
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": {
        "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"
    },
    "value": {
        "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"
    }
}
Modified at 2024-12-23 17:28:39
Previous
/internal/Clients/{clientId}
Next
/internal/Clients/{clientId}/Documents/upload
Built with