FinLego for developers
  1. ClientsImport
FinLego for developers
  • FinLego Core Banking
    • Services REST API
      • ClientProfile - FrontOffice
        • Client
          • /Client
          • /Client/deletion-notifications
      • 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
        POST
      • Imports a new company client from an integrated WL customer's onboarding system
        POST
    • SumsubWebhooks
      • /integration/sumsub-webhooks/update-state
      • Simulates a verification response.
  1. ClientsImport

Imports a new company client from an integrated WL customer's onboarding system

POST
/integration/clients/companies
ClientsImport

Request

Body Params application/json
externalId
string 
required
External client Id for identification on the Preyus side
>= 1 characters<= 100 characters
riskLevel
enum<string> 
required
Allowed values:
lowmediumhighprohibited
address
object (AddressDto) 
required
streetLine1
string 
required
>= 1 characters<= 255 characters
Match pattern:
^[A-Za-z0-9\.\/\,\(\)\-# ]+$
streetLine2
string  | null 
optional
city
string 
required
>= 1 characters<= 255 characters
Match pattern:
^[A-Za-z0-9\.\/\,\(\)\-# ]+$
state
string  | null 
optional
<= 255 characters
zip
string 
required
>= 1 characters<= 255 characters
country
string 
required
>= 2 characters<= 2 characters
phoneNumber
string 
required
Phone number
>= 5 characters<= 17 characters
email
string <email>
required
E-mail address
>= 5 characters<= 64 characters
legalName
string 
required
Legal company name
>= 1 characters<= 100 characters
Match pattern:
^[A-Za-z0-9\-\.\(\)\,' ]+$
countryOfRegistration
string 
required
Country of the company registration, according to ISO 3166-1 alpha-2 (strictly two CAPITAL letters)
>= 2 characters<= 2 characters
industry
enum<string> 
required
Allowed values:
accountingOrConsultingOrLegalServicescharityOrSimilarNonProfitActivitiescyberlockersOrRemoteDigitalFileStoringdatingdrugsOrPharmaceuticalemiOrPiforexOrCfdOrCrowdfundinggamblingOrBettingOrLotteryinsuranceOrLendingServicesmarketingAndAdvertisingonlineGamingrealEstateretailsocialNetworksitsubscriptionOnPhysicalGoodDeliverytelecommunicationAndNetworktelemarketingtobaccoProductstradeInPreciousMetalsAndJewellerytransportationOrLogisticstravelOrLeisurevirtualAssetServicesother
industryOther
string  | null 
optional
Industry text description, mandatory if Industry is "Other".
Example:
Holding company
turnover
enum<string> 
required
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?
isPubliclyListed
boolean  | null 
optional
Is Company publicly listed on a stock exchange or a part of a reputable companies group?
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)?
isFoundation
boolean  | null 
optional
Is the Company an association, foundation, non-profit organization or charity?
registrationNumber
string 
required
Company registration number
>= 1 characters<= 100 characters
webSite
string 
required
Company website address (must be correct absolute URL starting with "http://" or "https://")
>= 1 characters<= 100 characters
companyRegistrationDate
string <date>
required
Company registration date
taxResidencyCountry
string 
required
ISO 2-letter country code for the tax residency country, two CAPITAL letters
>= 2 characters<= 2 characters
payInsCountries
array[string] | null 
optional
Country groups the company expects to receive money from
Allowed values:
ukeeaother
payOutsCountries
array[string] | null 
optional
Country groups the company expects to send money from
Allowed values:
ukeeaother
purposesAccountOpening
array[string] | null 
optional
Purpose(s) the company plans to use their accounts for
Allowed values:
administrativeAndOperationalExpensespaymentsToAndFromContractorsdepositsAndSavingspaymentCardProcessingother
purposesAccountOpeningOther
string  | null 
optional
Explanation, if PurposesAccountOpening includes "Other"
taxNumber
string 
required
Company Tax Number
>= 1 characters<= 50 characters
businessPartners
array[object (BusinessPartnerDto) {7}] 
required
Company business partners, or any other entities the company interacts with to make its business, at least one entity required.
>= 1 items
name
string 
required
>= 1 characters<= 100 characters
Match pattern:
^[A-Za-z0-9\-\.\(\)\,' ]+$
incorporationCountryCode
string 
required
>= 2 characters<= 2 characters
plannedTransfersQuantityMonth
integer <int32>
required
> 0
plannedTransfersEurVolumeMonth
integer <int32>
required
> 0
additionalInfo
string  | null 
optional
basisPartnership
string 
required
>= 1 characters<= 100 characters
website
string 
required
>= 1 characters
fundFlows
object (FundFlowsDto) 
required
plannedIncomingTransfersQuantity
integer <int32>
required
> -1
plannedIncomingTransfersEurVolume
integer <int32>
required
> -1
plannedOutboundTransfersQuantity
integer <int32>
required
> -1
plannedOutboundTransfersEurVolume
integer <int32>
required
> -1
complianceEvaluation
object (ComplianceEvaluationDto) 
required
reviewPeriodicity
string 
required
>= 1 characters<= 100 characters
appliedLimits
string 
required
>= 1 characters<= 100 characters
additionalInfo
string  | null 
optional
relatedIndividuals
array[object (RelatedIndividualInfoDto) {19}] 
required
Beneficiaries and other related individuals, at least one
>= 1 items
firstName
string 
required
>= 1 characters<= 255 characters
Match pattern:
^[\w \-]+$
lastName
string 
required
>= 1 characters<= 255 characters
Match pattern:
^[\w \-]+$
email
string <email>
required
>= 5 characters<= 64 characters
isUbo
boolean 
optional
isShareholder
boolean 
optional
isDirector
boolean 
optional
isRepresentative
boolean 
optional
isPep
boolean 
optional
residenceCountry
string 
required
>= 2 characters<= 2 characters
citizenshipCountry
string 
required
>= 2 characters<= 2 characters
birthDate
string <date>
required
>= 1 characters
ownership
integer <int32>
required
>= 0<= 100
document
object (IdentificationDocumentDto) 
required
beneficialOwnerPepDetails
string  | null 
optional
usaTaxResidency
boolean 
required
giinNumber
string  | null 
optional
residentialAddress
object (AddressDto) 
optional
applicantId
string <uuid> | null 
optional
percentageOwnership
number <double> | null 
optional
Example
{
    "externalId": "string",
    "riskLevel": "low",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "st"
    },
    "phoneNumber": "string",
    "email": "user@example.com",
    "legalName": "string",
    "countryOfRegistration": "st",
    "industry": "accountingOrConsultingOrLegalServices",
    "industryOther": "Holding company",
    "turnover": "bellow100KEur",
    "isRelevantActivity": true,
    "isPubliclyListed": true,
    "isEngagedGambling10K": true,
    "isFoundation": true,
    "registrationNumber": "string",
    "webSite": "string",
    "companyRegistrationDate": "2019-08-24",
    "taxResidencyCountry": "st",
    "payInsCountries": [
        "uk"
    ],
    "payOutsCountries": [
        "uk"
    ],
    "purposesAccountOpening": [
        "administrativeAndOperationalExpenses"
    ],
    "purposesAccountOpeningOther": "string",
    "taxNumber": "string",
    "businessPartners": [
        {
            "name": "string",
            "incorporationCountryCode": "st",
            "plannedTransfersQuantityMonth": 1,
            "plannedTransfersEurVolumeMonth": 1,
            "additionalInfo": "string",
            "basisPartnership": "string",
            "website": "string"
        }
    ],
    "fundFlows": {
        "plannedIncomingTransfersQuantity": 0,
        "plannedIncomingTransfersEurVolume": 0,
        "plannedOutboundTransfersQuantity": 0,
        "plannedOutboundTransfersEurVolume": 0
    },
    "complianceEvaluation": {
        "reviewPeriodicity": "string",
        "appliedLimits": "string",
        "additionalInfo": "string"
    },
    "relatedIndividuals": [
        {
            "firstName": "string",
            "lastName": "string",
            "email": "user@example.com",
            "isUbo": true,
            "isShareholder": true,
            "isDirector": true,
            "isRepresentative": true,
            "isPep": true,
            "residenceCountry": "st",
            "citizenshipCountry": "st",
            "birthDate": "2019-08-24",
            "ownership": 0,
            "document": {
                "issuedBy": "string",
                "expirationDate": "2019-08-24",
                "type": "passport",
                "number": "string",
                "issuedCountryCode": "st",
                "issuedDate": "2019-08-24"
            },
            "beneficialOwnerPepDetails": "string",
            "usaTaxResidency": true,
            "giinNumber": "string",
            "residentialAddress": {},
            "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 '/integration/clients/companies' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "string",
    "riskLevel": "low",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "st"
    },
    "phoneNumber": "string",
    "email": "user@example.com",
    "legalName": "string",
    "countryOfRegistration": "st",
    "industry": "accountingOrConsultingOrLegalServices",
    "industryOther": "Holding company",
    "turnover": "bellow100KEur",
    "isRelevantActivity": true,
    "isPubliclyListed": true,
    "isEngagedGambling10K": true,
    "isFoundation": true,
    "registrationNumber": "string",
    "webSite": "string",
    "companyRegistrationDate": "2019-08-24",
    "taxResidencyCountry": "st",
    "payInsCountries": [
        "uk"
    ],
    "payOutsCountries": [
        "uk"
    ],
    "purposesAccountOpening": [
        "administrativeAndOperationalExpenses"
    ],
    "purposesAccountOpeningOther": "string",
    "taxNumber": "string",
    "businessPartners": [
        {
            "name": "string",
            "incorporationCountryCode": "st",
            "plannedTransfersQuantityMonth": 1,
            "plannedTransfersEurVolumeMonth": 1,
            "additionalInfo": "string",
            "basisPartnership": "string",
            "website": "string"
        }
    ],
    "fundFlows": {
        "plannedIncomingTransfersQuantity": 0,
        "plannedIncomingTransfersEurVolume": 0,
        "plannedOutboundTransfersQuantity": 0,
        "plannedOutboundTransfersEurVolume": 0
    },
    "complianceEvaluation": {
        "reviewPeriodicity": "string",
        "appliedLimits": "string",
        "additionalInfo": "string"
    },
    "relatedIndividuals": [
        {
            "firstName": "string",
            "lastName": "string",
            "email": "user@example.com",
            "isUbo": true,
            "isShareholder": true,
            "isDirector": true,
            "isRepresentative": true,
            "isPep": true,
            "residenceCountry": "st",
            "citizenshipCountry": "st",
            "birthDate": "2019-08-24",
            "ownership": 0,
            "document": {
                "issuedBy": "string",
                "expirationDate": "2019-08-24",
                "type": "passport",
                "number": "string",
                "issuedCountryCode": "st",
                "issuedDate": "2019-08-24"
            },
            "beneficialOwnerPepDetails": "string",
            "usaTaxResidency": true,
            "giinNumber": "string",
            "residentialAddress": {},
            "applicantId": "fc65ce03-c5e6-455c-b628-f1607e292785",
            "percentageOwnership": 0
        }
    ]
}'

Responses

🟢200OK
application/json
Body
Successful response to a client import command
clientId
string <uuid>
required
Internal identifier in the FinLego system
externalId
string 
required
Internal identifier in the Preyus system
<= 100 characters
Example
{
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    "externalId": "string"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409Conflict
🔴500Internal Server Error
Previous
Imports a new individual client from an integrated WL customer's onboarding system
Next
/integration/sumsub-webhooks/update-state
Built with