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 individual client from an integrated WL customer's onboarding system

POST
/integration/clients/individuals
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
firstName
string 
required
First name
>= 1 characters<= 255 characters
Match pattern:
^[A-Za-z\-\.' ]+$
lastName
string 
required
Last name
>= 1 characters<= 255 characters
Match pattern:
^[A-Za-z\-\.' ]+$
citizenshipCountry
string 
required
Citizenship country code, according to ISO 3166-1 alpha-2
>= 2 characters<= 2 characters
identificationDocument
object (IdentificationDocumentDto) 
required
issuedBy
string 
required
>= 1 characters<= 100 characters
expirationDate
string <date>
required
type
enum<string> 
required
Allowed values:
passportdriverLicenseidCardother
number
string 
required
>= 1 characters<= 30 characters
issuedCountryCode
string 
required
>= 2 characters<= 2 characters
issuedDate
string <date>
required
residenceCountry
string 
required
Residence country code, according to ISO 3166-1 alpha-2
>= 2 characters<= 2 characters
dateOfBirth
string <date>
required
Date of birth
>= 1 characters
Example
{
    "externalId": "string",
    "riskLevel": "low",
    "address": {
        "streetLine1": "string",
        "streetLine2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "st"
    },
    "phoneNumber": "string",
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "citizenshipCountry": "st",
    "identificationDocument": {
        "issuedBy": "string",
        "expirationDate": "2019-08-24",
        "type": "passport",
        "number": "string",
        "issuedCountryCode": "st",
        "issuedDate": "2019-08-24"
    },
    "residenceCountry": "st",
    "dateOfBirth": "2019-08-24"
}

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/individuals' \
--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",
    "firstName": "string",
    "lastName": "string",
    "citizenshipCountry": "st",
    "identificationDocument": {
        "issuedBy": "string",
        "expirationDate": "2019-08-24",
        "type": "passport",
        "number": "string",
        "issuedCountryCode": "st",
        "issuedDate": "2019-08-24"
    },
    "residenceCountry": "st",
    "dateOfBirth": "2019-08-24"
}'

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
/internal/integration/Transfers/outgoing/payment-request
Next
Imports a new company client from an integrated WL customer's onboarding system
Built with