Register Customer

POST 
/v1.1/customer/register

This is used to onboard new customers to the system. After approving the customer registration process, account details will be notified to the customer via the given email during the registration process.

Request

application/json

Body

firstName stringrequired

Possible values: <= 200 characters

lastName stringrequired

Possible values: <= 200 characters

username stringrequired

Possible values: <= 50 characters

title stringrequired

Possible values: [mr, mrs, miss, dr]

gender stringrequired

Possible values: [M, F, -1]

M (Male) | F (Female) | -1 (rather not say)

residentCountry stringrequired

Possible values: <= 5 characters

Find country codes here

zipPostalCode stringrequired

Possible values: <= 100 characters

city stringrequired

Possible values: <= 250 characters

address1 stringrequired

Possible values: <= 200 characters

address2 string

Possible values: <= 200 characters

birthDate stringrequired

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

nationality stringrequired

Possible values: <= 5 characters

Find country codes here

countryOfBirthPlace stringrequired

Possible values: <= 5 characters

Find country codes here

mobile stringrequired

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

homeTel stringrequired

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

email stringrequired

Possible values: <= 50 characters

passportNumber stringrequired

Possible values: <= 15 characters

passportIssueDate stringrequired

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

passportExpDate stringrequired

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

referenceNumber stringrequired

Possible values: <= 50 characters

citizenship string

Possible values: <= 5 characters

approximateAnnualIncome stringrequired

Possible values: [$0 - $49K, $50K -$99K, $100K - $199K, >$200K]

maritalStatus stringrequired

Possible values: [sin, mar, div, wid, sep]

sin:single , mar:married, div:divorced, wid:widowed, sep:separated

institutionCode stringrequired

Possible values: <= 50 characters

employeeStatus stringrequired

Possible values: [self, emp, ret, std, hmk]

tradingCurrency stringrequired

Possible values: >= 3 characters and <= 3 characters

nin string

Possible values: <= 15 characters

national identification number

Responses

200

OK

application/json

Schema

Schema

regReqId string

Possible values: non-empty

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode integer

Find error codes here

Example (from schema)

{
  "regReqId": "string",
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0
}

example

{
  "regReqId": "string",
  "status": "SUCCESS"
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/customer/register",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/customer/register",
  "rejectCode": "1007"
}

Loading...