Customer Reference
Register Customer
Register a new customer if the customer has not been registered yet on the platform.
Register a customer.
POST /v1/customer/register HTTP/1.1
Content-Type: application/json
Key: {API Key}
Sign: {Signature}
{
"customer": {
"legalFullName": "string",
"identityNumber": "string",
"email": "string",
"phoneNumber": "string",
"primaryLoginMethod": "string"
}
}
Request
Body
application/json
| Property | Type | Description |
|---|---|---|
customer | object | The customer's object to be registered. |
customer.legalFullName | string | The customer's legal full name. |
customer.identityNumber | string | The customer's national identity number, i.e. NRIC. |
customer.email | string | The customer's email address. This is optional if customer.phoneNumber is provided. |
customer.phoneNumber | string | The customer's phone number with full prefix, format example +60123456789. This is optional if customer.email is provided. |
customer.primaryLoginMethod | enum(string) | The customer's primary login method. Valid options are email or phoneNumber. The customer will receive a one-time verification code to the specified primary login method to complete the initial registration process. Refer to Verify Registration.Note: The allowed primary login method you can send may be limited. Please refer to your Account Manager for more information. |
Response
Upon successful response, a one-time verification code will be sent to the specified
customer.primaryLoginMethod. Refer to Verify Registration to complete the initial customer registration process.Body
application/json{
"code": 0,
"message": "string",
"data": {
"sessionId": "string",
"expiredOn": 1706600000000
}
}
| Property | Type | Description |
|---|---|---|
code | number | The response code. Refer to ENUM Definition. |
message | string | The response message. |
data | object | The response data. |
data.sessionId | string | The unique session identifier to the customer's registration. This sessionId is required for Verify Registration. |
data.expiredOn | number | The expiry date and time in unix millisecond time of the one-time verification code sent to the specified customer.primaryLoginMethod. |
Bind Customer
Before you can proceed to perform operations with a registered customer in the platform, you need to bind the customer first. This is a one-time process where you will need to provide the customer's information to obtain an unique identifier for the customer.
Verify Registration
Upon successful customer register, a one-time verification code will be sent to the customer's specified primary login method. Use this endpoint to verify the customer's registration process.