Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountInformation AccountInformation Body Account information
    BankInformation BankInformation Body Bank information
    FinlandData FinlandData Body Client information for Finland onboarding
    GlobalFinancialInformation GlobalFinancialInformation Body Global financial information
    ItalyData ItalyData Body Client information for Italy onboarding
    OnboardingInformation OnboardingInformation Body Onboarding information
    OwnerKey ClientKey Query-String Client key of owner, under which this signup will be created. If not provided, signup will be created under the LoggedIn client
    PensionData PensionData Body Client information about pension
    PersonalInformation PersonalInformation Body Client personal information
    ProfileInformation ProfileInformation Body Client profile information
    RegulatoryInformation RegulatoryInformation Body Client regulatory information
    SingaporeData SingaporeData Body Client information for Singapore onboarding
    SwitzerlandData SwitzerlandData Body Client information for Switzerland onboarding
  • Response Parameters

    View Response Codes
    Name Type Description
    ClientId String Created clients ID
    ClientKey String Client Key
    SignUpId String Sign up ID
  • Request Example

    Request URL
    POST cm/v1/signups/?OwnerKey=d2-PzdC5wIPy1284wD-rRA==
    Request Body
    {
      "AccountInformation": {
        "AdditionalChoiceOfAccounts": [
          "5"
        ],
        "ClientCategoryId": "1",
        "CurrencyCode": "USD",
        "DefaultChoiceOfAccount": "38",
        "IntendedCommissionGroupId": "1234",
        "IntendedTemplateId": "567",
        "OtherInstructions": "Instruction1"
      },
      "BankInformation": {
        "BeneficiaryBankName": "BankName",
        "ReceivingCountryIsoCode": "DK"
      },
      "FinlandData": {
        "EuroclearJudicialForm": "21",
        "EuroclearSectorCode": "10010"
      },
      "GlobalFinancialInformation": {
        "AnnualIncomeAfterTax": {
          "Amount": 100020,
          "AmountDescription": "Exact",
          "CurrencyCode": "DKK"
        },
        "IntendToInvest": {
          "Amount": 1000000,
          "AmountDescription": "AboveThisAmount",
          "CurrencyCode": "DKK"
        },
        "InvestableAsset": {
          "Amount": 1000000,
          "AmountDescription": "Rounded",
          "CurrencyCode": "DKK"
        }
      },
      "ItalyData": {
        "EmploymentInformation": {
          "CountryConcernedCode": "IT",
          "DetailedBusinessActivity": "005",
          "EmploymentName": "Employer",
          "OtherEmployment": "Other employer description",
          "PrevalentCorporateObject": "Corporate object",
          "ProvinceConcerned": "Livorno",
          "StatusOfEmployment": "125"
        },
        "MailContactPreference": true,
        "ProfileInformation": {
          "AnnualIncomeInformation": {
            "AnnualIncomeSource": [
              "2"
            ],
            "TotalAnnualIncome": "1"
          },
          "InvestableAssets": {
            "IntendToInvest": "2",
            "NatureAndPurposeOfTheRelationship": "1",
            "SourceOfWealth": [
              "3"
            ],
            "ValueOfTotalWealth": "4"
          }
        }
      },
      "OnboardingInformation": {
        "ElectronicVerification": {
          "Done": "2018-04-05T00:00:00Z",
          "ExternalId": "ExternalId",
          "Result": "Passed",
          "Score": "50"
        }
      },
      "PensionData": {
        "AdditionalPensionData": "Additional pension data",
        "EmployerReference": "4582HGF39",
        "PensionProductTypes": [
          "EmployerPaidAlderssum"
        ]
      },
      "PersonalInformation": {
        "AdditionalTaxableCountries": [
          {
            "CountryCode": "DK",
            "TaxId": "12334567",
            "TinNotAvailable": false
          },
          {
            "CountryCode": "CN",
            "TinMissingReason": "100000001",
            "TinNotAvailable": true,
            "TinOtherMissingReason": "It is under progress"
          }
        ],
        "AdditionalTaxCountryCode": "DK",
        "CityOfBirth": "NewYork",
        "ConsentSource": 1,
        "ContactInformation": {
          "EmailAddress": "abc@test.com",
          "PrimaryPhoneNumber": {
            "CountryCode": "US",
            "Number": "1234567890"
          },
          "SecondaryPhoneNumber": {
            "CountryCode": "IN",
            "Number": "2134567890"
          }
        },
        "CorrespondenceAddress": {
          "BuildingName": "Building Penhurst Park",
          "BuildingNumber": "Build# 34",
          "City": "Buffalo",
          "CountryOfResidenceCode": "US",
          "PostalCode": "14202",
          "State": "New York",
          "StreetName": "Niagara Square"
        },
        "CountryOfBirth": "US",
        "DateOfBirth": "1980-01-01",
        "Debt": {
          "Currency": "2",
          "Value": 100000.0
        },
        "DeclaredBankrupt": false,
        "EmploymentInformation": {
          "AdditionalEmploymentRelations": {
            "CompanyNameInsider": "CompanyNameInsider",
            "CompanyNameMajorityInterest": "CompanyNameMajorityInterest",
            "ManagedOrManagingAssets": false
          },
          "EmployerName": "EmpName",
          "FinancialSectorEmployee": false,
          "NatureOfBusiness": "1",
          "OccupationTypes": [
            "1",
            "2"
          ],
          "Position": "Position"
        },
        "FirstName": "John",
        "Gender": "2",
        "LastName": "Doe",
        "LiquidNetWorth": {
          "Currency": "2",
          "Value": 100000.0
        },
        "MarketingConsent": true,
        "NationalId": "NationalId",
        "NationalityCode": "US",
        "NonDisclosureClient": false,
        "OriginalScriptFirstName": "比",
        "OriginalScriptLastName": "伊",
        "PersonalId": "986283618",
        "PersonalIdExpirationDate": "2019-04-05",
        "PersonalIdPlaceOfRelease": "Milan",
        "PersonalIdReleaseDate": "2016-12-08",
        "PersonalIdReleasedBy": "John doe",
        "PersonalIdType": "1",
        "PersonalTradingProfile": {
          "KnowledgeOfFinancialInstruments": "2",
          "ProductTradingExperience": [
            "3",
            "4",
            "5"
          ],
          "TradesPerMonth": "3"
        },
        "PoliticallyExposedPerson": false,
        "ResidentialAddress": {
          "BuildingName": "Building Penhurst Park",
          "BuildingNumber": "Build# 34",
          "City": "Buffalo",
          "CountryOfResidenceCode": "US",
          "PostalCode": "14202",
          "State": "New York",
          "StreetName": "Niagara Square"
        },
        "SalaryBeforeTax": {
          "Currency": "2",
          "Value": 100000.0
        },
        "ServiceLanguageCode": "EN",
        "TaxId": "288392738",
        "TinNotAvailable": false
      },
      "ProfileInformation": {
        "AnnualIncomeInformation": {
          "AnnualSalaryAfterTax": "1",
          "SecondaryIncomeOther": "Other sources of secondary income",
          "SecondarySourcesOfIncome": [
            "2"
          ],
          "SecondarySourcesOfIncomeTotal": "8"
        },
        "InvestableAssets": {
          "IntendToInvest": "5",
          "PrimarySourcesOfWealth": [
            "1",
            "3"
          ],
          "SourceOfWealthOther": "OtherWealthSource",
          "ValueOfCashAndSecurities": "8"
        },
        "InvestmentPurpose": {
          "PurposeAndScope": "2"
        },
        "TradingProfile": {
          "SoleBoOfAssets": true
        }
      },
      "RegulatoryInformation": {
        "FatcaDeclaration": {
          "UnitedStatesCitizen": true,
          "UnitedStatesProducts": true,
          "UnitedStatesTaxId": "23456",
          "UnitedStatesTaxLiable": true
        }
      },
      "SingaporeData": {
        "AnnualIncomeSgd": "3",
        "BrokersDeclinedBy": "BrokersName",
        "ClassificationRequired": true,
        "DiplomaOrHigherQualification": "2",
        "EducationalQualificationSatisfied": true,
        "ELearningAbsSasCfds": "3",
        "ELearningAbsSasFx": "2",
        "ELearningPassed": "4",
        "ELearningSgx": false,
        "ELearningSgxScore": "20",
        "FinanceWorkExperience": "5",
        "InvestorProfile": "2",
        "ListedSips": true,
        "NetWorthSgd": "5",
        "PermanentResident": true,
        "ProfessionalFinanceQualification": "5",
        "SgxStocks": "2",
        "UnlistedSipsCfds": false,
        "UnlistedSipsFx": false
      },
      "SwitzerlandData": {
        "AnnualIncomeChf": "4",
        "NetWorthChf": "2"
      }
    }
    
  • Response Example

    Response body
    {
      "ClientId": "2147279170",
      "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
      "SignUpId": "522ae44c-ef7e-4b7c-819f-75dc95d46563"
    }