Create a personal customer profile

[Available in Sandbox/Production environment] Create a personal customer profile on our platform.

post/kyc/customer_profiles

Request

Base URL
https://api-sandbox.straitsx.com/v1
URL
https://api-sandbox.straitsx.com/v1/kyc/customer_profiles
Auth
none required

Headers

X-XFERS-APP-API-KEYstring required

You can retrieve this from your Dashboard Developer Tools. Note: The X-XFERS-APP-API-KEY is a mandatory header for all authentication methods, including standard API key usage and HTTP Request Signing mode.

X-PUBLIC-KEY-IDstring

The Key ID, can be retrieved from your StraitsX Dashboard. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-TIMESTAMPstring

Current Unix epoch time in seconds. Must be within ±300 seconds of server time. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-NONCEstring

A unique UUID string per request, used for replay protection. Must not be reused within the timestamp window. Regex: /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i Note: This header attribute is required when HTTP Request Signing is enabled for your account.

X-SIGNATUREstring

Base64-encoded digital signature of the canonical request string. Note: This header attribute is required when HTTP Request Signing is enabled for your account.

Request body

customerNamestring required

Customer's full name (50 alphanumeric with spaces) Regex: /^(?=.{1,50}$)[a-zA-Z0-9 ]+$/

registrationTypestring required

Customer's registration type Please input personal only

registrationIdCountrystring required

The country that issues the ID (2 digit ISO country code) from https://www.iban.com/country-codes Regex: /^[A-Z]{2}$/

registrationIdTypestring required

Customer's registration ID type Accepts either passport or identity_card

registrationIdstring required

NRIC/Passport No. (4 to 35 alphanumeric) Regex: %r{\A[a-zA-Z0-9/\-?:().,'+ ]{4,35}\z}

dateOfBirthstring date required

Customer's date of birth (YYYY-MM-DD) Regex: /^\d{4}-\d{2}-\d{2}$/

nationalitystring required

Customer's nationality (Country Name or 2/3 digit ISO country code) from https://www.iban.com/country-codes Regex: /^\s*.{1,191}\s*$/

genderstring

Customer's gender. Must be either MALE or FEMALE.

emailstring

Customer's email address Regex: %r{^[\w!#$%&'*+/=?`{|}~^-]+(?:\.[\w!#$%&'*+/=?`{|}~^-]+)*@(?:[a-z0-9-]+\.)+[a-z]{2,24}$}i

phoneNostring

Customer's phone number Regex: /^\+?[1-9]\d{0,3}[\s\-]?$?\d{1,4}$?[\s\-]?\d{1,4}[\s\-]?\d{1,4}[\s\-]?\d{0,4}$/

customerNativeNamestring

Must be within 191 characters Regex: /^\s*.{1,191}\s*$/

merchantRefstring

Your own reference identifier for this customer profile. Must be within 191 characters. Regex: /^\s*.{1,191}\s*$/

Response

200

Example response

{
  "data": {
    "id": "customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65",
    "type": "customer_profile",
    "attributes": {
      "customerName": "John Ng",
      "registrationType": "personal",
      "registrationIdType": "identity_card",
      "registrationIdCountry": "SG",
      "registrationId": "S1234567J",
      "address": {
        "street": "10 Albert Street",
        "city": "Singapore",
        "postalCode": "000000",
        "state": "Singapore",
        "country": "SG"
      },
      "verificationStatus": "verified",
      "dateOfBirth": "1983-11-14T00:00:00.000Z",
      "gender": "MALE",
      "nationality": "SINGAPOREAN",
      "email": "test@gmail.com",
      "phoneNo": 6587654321
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.