Get Customer Details

GET 
/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.

Request

Query Parameters

customerNumber stringrequired

Possible values: <= 20 characters

Default value: ASI173455897

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

Responses

200

OK

application/json

Schema

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
externalReferenceNumber string
cashAccounts object[]
Array [
cashAccountNumber string
accountType integer
Possible values: [0, 1, 2]
0 (Current) | 1 (Savings) | 2 (Investment)
currency string
balance integer
blockedAmount integer
odLimit string
margin stringnullable
createdDate stringnullable
status string
Possible values: [2, 5]
2 (APPROVED) | 5 (DELETE)
pendingSettle integer
pendingWithdraw string
pendingDeposit string
profileId stringnullable
institutionCode stringnullable
unsettledTransfers integer
pendingCharge numbernullable
manualBlock numbernullable
cashAccountId stringnullable
modifiedDate stringnullable
settlementType integer
Possible values: [0, 1, 2]
0 (DVP (default for MFS)) | 1 (Prefunded (default for DBFS)) | 2 (Non Settle)
marginDue integer
dayMarginDue integer
marginBlock integer
dayMarginBlock integer
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 integer
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 stringnullable
mrgTrdEnabled integer
Possible values: [0, 1]
0 (false) | 1 (true)
mrgDayTrdEnabled integer
Possible values: [0, 1]
0 (false) | 1 (true)
accountName string
pendingOrderValue integer
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)
status string
Possible values: [2, 5]
2 (APPROVED) | 5 (DELETE)
tradingEnabled integer
Possible values: [0, 1]
0 (false) | 1 (true)
custodian string
feedLevel integer
Possible values: [0, 1, 2]
0-> delayed, 1-> real time L1, 2 -> real time L2
]
]
]

Example (from schema)

{
  "status": "FAILED",
  "reason": "string",
  "rejectCode": 0,
  "customerNumber": "string",
  "firstName": "string",
  "lastName": "string",
  "passportNumber": "string",
  "nin": "string",
  "drivingLicense": "string",
  "homeTel": "string",
  "officeTel": "string",
  "mobile": "string",
  "email": "string",
  "profession": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "countryCode": "string",
  "gender": "string",
  "birthDate": "string",
  "nationality": "string",
  "username": "string",
  "externalReferenceNumber": "string",
  "cashAccounts": [
    {
      "cashAccountNumber": "string",
      "accountType": 0,
      "currency": "string",
      "balance": 0,
      "blockedAmount": 0,
      "odLimit": "string",
      "margin": "string",
      "createdDate": "string",
      "status": "2",
      "pendingSettle": 0,
      "pendingWithdraw": "string",
      "pendingDeposit": "string",
      "profileId": "string",
      "institutionCode": "string",
      "unsettledTransfers": 0,
      "pendingCharge": 0,
      "manualBlock": 0,
      "cashAccountId": "string",
      "modifiedDate": "string",
      "settlementType": 0,
      "marginDue": 0,
      "dayMarginDue": 0,
      "marginBlock": 0,
      "dayMarginBlock": 0,
      "mrgDayTrdEnabled": 0,
      "secondaryTradingLimit": 0,
      "dailyOdLimit": 0,
      "primaryTradingLimitExpiry": "string",
      "secondaryTradingLimitExpiry": "string",
      "dailyOdLimitEnabled": 0,
      "cashAvailableForWithdraw": 0,
      "buyingPower": 0,
      "ibanNumber": "string",
      "securityAccounts": [
        {
          "secApprovalStatus": "string",
          "accountNumber": "string",
          "createdDate": "string",
          "autoNo": "string",
          "securityAccountType": "1",
          "externalReference": "string",
          "status": "2",
          "lastUpdated": 0,
          "ip": "string",
          "mrgTrdEnabled": 0,
          "mrgDayTrdEnabled": 0,
          "accountName": "string",
          "pendingOrderValue": 0,
          "currency": "string",
          "exchangeAccounts": [
            {
              "exchange": "string",
              "exchangeAccountNumber": "string",
              "exchangeAccountId": 0,
              "exchangeInvestor": "string",
              "exchangeAccountType": "0",
              "status": "2",
              "tradingEnabled": 0,
              "custodian": "string",
              "feedLevel": 0
            }
          ]
        }
      ]
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": "get account details success",
  "rejectCode": 0,
  "customerNumber": "ASI954103746",
  "firstName": "Test",
  "lastName": "user",
  "passportNumber": "12312234",
  "nin": "23423234",
  "drivingLicense": "85748596954",
  "homeTel": "+1234567890",
  "officeTel": "+32232366666",
  "mobile": "+32232377777",
  "email": "[email protected]",
  "profession": "Mr",
  "address1": "add1",
  "address2": "add2",
  "city": "city",
  "countryCode": "US",
  "gender": "male",
  "birthDate": "2022/05/08",
  "nationality": "US",
  "username": "",
  "externalReferenceNo": "ATgye",
  "cashAccounts": [
    {
      "cashAccountNumber": "C000136826",
      "accountType": 0,
      "currency": "AED",
      "balance": 0,
      "blockedAmount": 0,
      "odLimit": "0.0",
      "margin": null,
      "createdDate": null,
      "status": "2",
      "pendingSettle": 0,
      "pendingWithdraw": "0.0",
      "pendingDeposit": "0.0",
      "profileId": null,
      "institutionCode": null,
      "unsettledTransfers": 0,
      "pendingCharge": null,
      "manualBlock": null,
      "cashAccountId": null,
      "modifiedDate": null,
      "settlementType": 0,
      "marginDue": 0,
      "dayMarginDue": 0,
      "marginBlock": 0,
      "dayMarginBlock": 0,
      "mrgDayTrdEnabled": 0,
      "secondaryTradingLimit": 0,
      "dailyOdLimit": 0,
      "primaryTradingLimitExpiry": null,
      "secondaryTradingLimitExpiry": null,
      "dailyOdLimitEnabled": 0,
      "cashAvailableForWithdraw": 0,
      "buyingPower": 0,
      "ibanNumber": null,
      "securityAccounts": [
        {
          "secApprovalStatus": "1",
          "accountNumber": "P000133564",
          "customerNumber": "ASI954103746",
          "cashAccountNumber": "C000136826",
          "institutionCode": null,
          "statusId": "2",
          "autoNo": null,
          "createdDate": null,
          "securityAccountType": "1",
          "externalReference": null,
          "lastUpdated": null,
          "ip": null,
          "mrgTrdEnabled": 0,
          "mrgDayTrdEnabled": 0,
          "accountName": "P000133564-AED",
          "pendingOrderValue": 0,
          "currency": "AED",
          "exchangeAccounts": [
            {
              "exchange": "ADSM",
              "exchangeAccountNumber": null,
              "exchangeAccountId": 383226,
              "exchangeInvestor": null,
              "exchangeAccountType": "1",
              "status": "2",
              "tradingEnabled": 1,
              "custodian": "0",
              "feedLevel": 2
            }
          ]
        }
      ]
    }
  ]
}

Loading...