Skip to main content
Version: 1.2.0 - Production

Create Customer

POST 
/v1.2/customer/account

The request is used to create a customer and his accounts in the system. This will create customers, their login profile, cash account to manage the cash, portfolio account to manage the holdings, and all the exchange accounts customers allow to trade.

Note - Market data APIs access for new customers will take some time ~ 1-2hrs.

Customer accounts will be created according to the configured default customer profile or subscription package.

Customer profile ; is similar to a blue print of customer accounts. If this is enabled at the institution level all the customer accounts will be created according to that customer profile.

Subscription package ; enables to define the set of exchanges to which the exchange/ trading accounts should be created for a customer to trade with currencies. Exchange accounts will be created for all the exchanges defined in the subscription package, the cash accounts will be created according to the respective exchange and configured currency and security account will be created with type equity for each cash account.

Note: Please try again, If you receive error code - 1123.

Request​

Header Parameters

    Throttle-Key string

Body

    referenceNumber stringrequired

    Possible values: <= 50 characters

    Fintech's Reference Number ; this can be any value and value format can be decided by Fintech itself.

    institutionCode stringrequired

    Possible values: <= 20 characters

    firstName string

    Possible values: <= 200 characters

    lastName string

    Possible values: <= 200 characters

    passportNumber string

    Possible values: <= 15 characters

    nin string

    Possible values: <= 15 characters

    drivingLicense string

    Possible values: <= 50 characters

    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 <email>

    Possible values: <= 50 characters

    profession string

    Possible values: <= 200 characters

    address1 string

    Possible values: <= 200 characters

    address2 string

    Possible values: <= 200 characters

    city string

    Possible values: <= 250 characters

    countryCode string

    Possible values: <= 5 characters

    Find country codes here

    gender string

    Possible values: [M-Male, F-Female, -1-rather not say]

    birthDate string

    Possible values: Value must match regular expression yyyy/MM/dd

    nationality string

    Possible values: <= 5 characters

    Find country codes here

Responses​

OK

Schema
    status stringrequired

    Possible values: [SUCCESS, FAILED]

    reason string
    rejectCode integer

    Find error codes here

    customerNumber string

    GTN customer number of the Customer account which was created at GTN side.

    cashAccountNumbers string[]

    List of Cash Account Numbers of the created GTN cash accounts under created customer account.

    accountNumbers string[]

    List of Security Account Numbers of the created GTN security accounts under created customer account.

    exchangeAccountIds integer[]

    List of Exchange Account Ids of the created GTN exchange accounts under created customer account.

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