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

POST
/internal/Clients

Request

Body Params application/json
CreateClientCommandBase
optional
type
enum<string> 
ClientType
required
Allowed values:
companyindividual
onboardingId
string <uuid>
required
>= 1 characters
editorUserId
string <uuid>
required
>= 1 characters
riskLevel
enum<string> 
RiskLevelEnum
required
Allowed values:
lowmediumhighprohibited
address
object 
AddressDto
required
phoneNumber
string 
required
>= 5 characters<= 17 characters
email
string  | null 
optional
isDefaultCompliant
boolean 
optional
industry
enum<string> 
Industry
optional
Allowed values:
accountingOrConsultingOrLegalServicescharityOrSimilarNonProfitActivitiescyberlockersOrRemoteDigitalFileStoringdatingdrugsOrPharmaceuticalemiOrPiforexOrCfdOrCrowdfundinggamblingOrBettingOrLotteryinsuranceOrLendingServicesmarketingAndAdvertisingonlineGamingrealEstateretailsocialNetworksitsubscriptionOnPhysicalGoodDeliverytelecommunicationAndNetworktelemarketingtobaccoProductstradeInPreciousMetalsAndJewellerytransportationOrLogisticstravelOrLeisurevirtualAssetServicesother
industryOther
string  | null 
optional
Industry if selected 'Other'.
Example:
Manufactoring
turnover
enum<string> 
Turnover
optional
Allowed values:
bellow100KEurbetween100KAnd500KEurbetween500KAnd1000KEurbetween1000KAnd5000KEurabove5000KEur
isRelevantActivity
boolean  | null 
optional
Is the previous activity and professional experience of at least one of the UBOs not related to
the planned economic activity?
Example:
false
isPubliclyListed
boolean  | null 
optional
Is Company publicly listed on a stock exchange or a part of a reputable companies group?
Example:
false
isEngagedGambling10K
boolean  | null 
optional
Is the Company engaged / will be engaged in gambling with the monthly turnover exceeding 10 000 EUR
(or its equivalent in other currency)?
Example:
false
isFoundation
boolean  | null 
optional
Is the Company an association, foundation, non-profit organization or charity?
Example:
false
legalName
string 
required
>= 1 characters<= 200 characters
Example:
Payler
registrationNumber
string  | null 
optional
Example:
121123412412
webSite
string  | null 
optional
Example:
test.com
countryOfRegistration
string 
required
>= 2 characters<= 5 characters
Example:
RU
companyRegistrationDate
string <date> | null 
optional
Example:
2022-01-01
taxResidencyCountry
string  | null 
optional
Example:
RU
payInsCountries
array[string] | null 
optional
Allowed values:
ukeeaother
Example:
[1,2]
payOutsCountries
array[string] | null 
optional
Allowed values:
ukeeaother
Example:
[1,2]
purposesAccountOpening
array[string] | null 
optional
Allowed values:
administrativeAndOperationalExpensespaymentsToAndFromContractorsdepositsAndSavingspaymentCardProcessingother
Example:
["depositsAndSavings"]
purposesAccountOpeningOther
string  | null 
optional
Purpose Account Opening if selected 'Other'.
Example:
Credits
taxNumber
string  | null 
optional
companyType
enum<string> 
CompanyType
optional
Allowed values:
soleTraderpartnershipprivatenonProfitcommunityInterestpublicinternationalNgo
businessPartners
array[object (BusinessPartnerDto) {7}]  | null 
optional
fundFlows
object 
FundFlowsDto
optional
complianceEvaluation
object 
ComplianceEvaluationDto
optional
customOptions
null 
optional
relatedIndividuals
array[object (RelatedIndividualInfoDto) {19}]  | null 
optional
Example
{
    "type": "company",
    "onboardingId": "f4fce315-9b7c-4302-989a-521be9ec9bca",
    "editorUserId": "c5c2f4a5-c36d-4d4d-9e5c-2659c938a266",
    "riskLevel": "low",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string"
    },
    "phoneNumber": "string",
    "email": "string",
    "isDefaultCompliant": true,
    "industry": "accountingOrConsultingOrLegalServices",
    "industryOther": "Manufactoring",
    "turnover": "bellow100KEur",
    "isRelevantActivity": false,
    "isPubliclyListed": false,
    "isEngagedGambling10K": false,
    "isFoundation": false,
    "legalName": "Payler",
    "registrationNumber": "121123412412",
    "webSite": "test.com",
    "countryOfRegistration": "RU",
    "companyRegistrationDate": "2022-01-01",
    "taxResidencyCountry": "RU",
    "payInsCountries": [
        1,
        2
    ],
    "payOutsCountries": [
        1,
        2
    ],
    "purposesAccountOpening": [
        "depositsAndSavings"
    ],
    "purposesAccountOpeningOther": "Credits",
    "taxNumber": "string",
    "companyType": "soleTrader",
    "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
        }
    ]
}

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 POST '/internal/Clients' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "company",
    "onboardingId": "f4fce315-9b7c-4302-989a-521be9ec9bca",
    "editorUserId": "c5c2f4a5-c36d-4d4d-9e5c-2659c938a266",
    "riskLevel": "low",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string"
    },
    "phoneNumber": "string",
    "email": "string",
    "isDefaultCompliant": true,
    "industry": "accountingOrConsultingOrLegalServices",
    "industryOther": "Manufactoring",
    "turnover": "bellow100KEur",
    "isRelevantActivity": false,
    "isPubliclyListed": false,
    "isEngagedGambling10K": false,
    "isFoundation": false,
    "legalName": "Payler",
    "registrationNumber": "121123412412",
    "webSite": "test.com",
    "countryOfRegistration": "RU",
    "companyRegistrationDate": "2022-01-01",
    "taxResidencyCountry": "RU",
    "payInsCountries": [
        1,
        2
    ],
    "payOutsCountries": [
        1,
        2
    ],
    "purposesAccountOpening": [
        "depositsAndSavings"
    ],
    "purposesAccountOpeningOther": "Credits",
    "taxNumber": "string",
    "companyType": "soleTrader",
    "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
        }
    ]
}'

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
object (IdDto) 
optional
id
string <uuid>
optional
value
object (IdDto) 
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": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "value": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
}
Modified at 2024-12-23 17:28:39
Previous
/Client/deletion-notifications
Next
/internal/Clients
Built with