Skip to main content
Version: 1.2.0 - Production

Get Customer Details

GET 
/v1.2/customer/account

This is used to request to get the overall details about a customer with a given customer number. This will give the customer KYC details as well as information about all the accounts under the given customer account.

Customer number or Reference number is required.

Request​

Query Parameters

    customerNumber string

    Possible values: <= 20 characters

    Default value: ASI173455897

    Customer number of the customer account which wants to get the details.

    referenceNumber string

    Possible values: <= 50 characters

    Reference number of the customer account which wants to get the details.

Header Parameters

    Throttle-Key string

Responses​

OK

Schema
    status stringrequired

    Possible values: [FAILED, SUCCESS]

    reason string
    rejectCode integer

    Find error codes here

    customerNumber string
    firstName string
    lastName string
    passportNumber string
    nin string
    drivingLicense string
    homeTel string

    Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$

    officeTel string

    Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$

    mobile string

    Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$

    email string
    profession string
    address1 string
    address2 string
    city string
    countryCode string
    gender string
    birthDate string

    Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

    nationality string
    username string
    referenceNumber string
    cashAccounts object[]
  • Array [
    • cashAccountNumber string
    accountType integer

    Possible values: [0, 1, 2]

    0 (Current) | 1 (Savings) | 2 (Investment)

    currency string
    balance integerdeprecated
    blockedAmount integerdeprecated
    odLimit string
    margin stringnullable
    createdDate stringnullable
    status string

    Possible values: [2, 5]

    2 (APPROVED) | 5 (DELETE)

    pendingSettle integerdeprecated
    pendingWithdraw stringdeprecated
    pendingDeposit stringdeprecated
    profileId stringnullabledeprecated
    institutionCode stringnullabledeprecated
    unsettledTransfers integerdeprecated
    pendingCharge numbernullabledeprecated
    manualBlock numbernullabledeprecated
    cashAccountId stringnullabledeprecated
    modifiedDate stringnullable
    settlementType integer

    Possible values: [0, 1, 2]

    0 (DVP (default for MFS)) | 1 (Prefunded (default for DBFS)) | 2 (Non Settle)

    marginDue integerdeprecated
    dayMarginDue integerdeprecated
    marginBlock integerdeprecated
    dayMarginBlock integerdeprecated
    mrgDayTrdEnabled integer

    Possible values: [0, 1]

    0 (false) | 1 (true)

    secondaryTradingLimit integer
    dailyOdLimit integer
    primaryTradingLimitExpiry stringnullable
    secondaryTradingLimitExpiry stringnullable
    dailyOdLimitEnabled integer

    Possible values: [0, 1]

    0 (false) | 1 (true)

    cashAvailableForWithdraw integer
    buyingPower integerdeprecated
    ibanNumber stringnullable
    securityAccounts object[]
  • Array [
    • type stringdeprecated

    Possible values: [1]

    equity : 1

    secApprovalStatus string
    accountNumber string

    Account number of the security / Portfolio account.

    createdDate stringnullable
    autoNo stringnullable
    securityAccountType string

    Possible values: [1]

    equity : 1

    externalReference stringnullable
    statusId stringdeprecated

    Possible values: [2, 5]

    2 (APPROVED) | 5 (DELETE)

    status string

    Possible values: [2, 5]

    2 (APPROVED) | 5 (DELETE)

    lastUpdated integernullable
    ip stringnullabledeprecated
    mrgTrdEnabled integer

    Possible values: [0, 1]

    0 (false) | 1 (true)

    mrgDayTrdEnabled integer

    Possible values: [0, 1]

    0 (false) | 1 (true)

    accountName string
    pendingOrderValue integerdeprecated
    currency string
    exchangeAccounts object[]
  • Array [
    • exchange string
    exchangeAccountNumber stringnullable
    exchangeAccountId integer
    exchangeInvestor stringnullable
    exchangeAccountType string

    Possible values: [0, 1, 2]

    0 (Fully Disclosed) | 1 (Default) | 2 (MBS FD)

    exchangeCode integernullable
    status string

    Possible values: [2, 5]

    2 (APPROVED) | 5 (DELETE)

    createdDate stringnullable
    modifiedDate stringnullable
    tradingEnabled integer

    Possible values: [0, 1]

    0 (false) | 1 (true)

    custodian string
    feedLevel integer

    Possible values: [0, 1, 2]

    0 (Delayed) | 1 (Delayed and L1) | 2 (Delayed L1 and L2)

    commissionType number

    Possible values: [1, 2]

    1 (Default) no commission group is set | 2 (Define) commission group is set

    commissionGroupId string

    Commission group Id assigned to customer (when only commission type is 2)

  • ]
  • ]
  • ]
Loading...
Is this page helpful for you?
Last updated on